C# Class Akka.Remote.Transport.AssociationHandle

A Service Provider Interface (SPI) layer for abstracting over logical links (associations) created by a Transport. Handles are responsible for providing an API for sending and receiving from the underlying channel. To register a listener for processing incoming payload data, the listener must be registered by completing the Task returned by AssociationHandle.ReadHandlerSource. Incoming data is not processed until this registration takes place.

Mostra file Open project: rogeralsing/akka.net Class Usage Examples

Public Methods

Method	Description
Disassociate ( ) : void	Closes the underlying transport link, if needed. Some transports might not need an explicit teardown (UDP) and some transports may not support it. Remote endpoint of the channel or connection MAY be notified, but this is not guaranteed. The transport that provides the handle MUST guarantee that Disassociate could be called arbitrarily many times.
Equals ( object obj ) : bool
GetHashCode ( ) : int
Write ( ByteString payload ) : bool	Asynchronously sends the specified payload to the remote endpoint. This method's implementation MUST be thread-safe as it might be called from different threads. This method MUST NOT block. Writes guarantee ordering of messages, but not their reception. The call to write returns with a boolean indicating if the channel was ready for writes or not. A return value of false indicates that the channel is not yet ready for deliver (e.g.: the write buffer is full)and the sender needs to wait until the channel becomes ready again. Returning false also means that the current write was dropped (this MUST be guaranteed to ensure duplication-free delivery).

Protected Methods

Method	Description
AssociationHandle ( Akka.Actor.Address localAddress, Akka.Actor.Address remoteAddress ) : System
Equals ( AssociationHandle other ) : bool

Method Details

AssociationHandle() protected method

protected AssociationHandle ( Akka.Actor.Address localAddress, Akka.Actor.Address remoteAddress ) : System
localAddress	Akka.Actor.Address
remoteAddress	Akka.Actor.Address
return	System

Disassociate() public abstract method

Closes the underlying transport link, if needed. Some transports might not need an explicit teardown (UDP) and some transports may not support it. Remote endpoint of the channel or connection MAY be notified, but this is not guaranteed. The transport that provides the handle MUST guarantee that Disassociate could be called arbitrarily many times.

public abstract Disassociate ( ) : void
return	void

Equals() protected method

protected Equals ( AssociationHandle other ) : bool
other	AssociationHandle
return	bool

Equals() public method

public Equals ( object obj ) : bool
obj	object
return	bool

GetHashCode() public method

public GetHashCode ( ) : int
return	int

Write() public abstract method

Asynchronously sends the specified payload to the remote endpoint. This method's implementation MUST be thread-safe as it might be called from different threads. This method MUST NOT block. Writes guarantee ordering of messages, but not their reception. The call to write returns with a boolean indicating if the channel was ready for writes or not. A return value of false indicates that the channel is not yet ready for deliver (e.g.: the write buffer is full)and the sender needs to wait until the channel becomes ready again. Returning false also means that the current write was dropped (this MUST be guaranteed to ensure duplication-free delivery).

public abstract Write ( ByteString payload ) : bool
payload	ByteString	The payload to be delivered to the remote endpoint.
return	bool