Click or drag to resize
Akka.NETAssociationHandle Class
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 ReadHandlerSource. Incoming data is not processed until this registration takes place.
Inheritance Hierarchy

Namespace:  Akka.Remote.Transport
Assembly:  Akka.Remote (in Akka.Remote.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public abstract class AssociationHandle

The AssociationHandle type exposes the following members.

Constructors
  NameDescription
Protected methodAssociationHandle
TBD
Top
Properties
  NameDescription
Public propertyLocalAddress
Address of the local endpoint
Public propertyReadHandlerSource
The TaskCompletionSource returned by this call must be completed with an IHandleEventListener to register a listener responsible for handling the incoming payload. Until the listener is not registered the transport SHOULD buffer incoming messages.
Public propertyRemoteAddress
Address of the remote endpoint
Top
Methods
  NameDescription
Public methodDisassociate
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 methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Protected methodEquals(AssociationHandle)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
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).
Top
Extension Methods
See Also