Class TestAssociationHandle

Inheritance
object
AssociationHandle
TestAssociationHandle
Inherited Members
Namespace: Akka.Remote.Transport
Assembly: Akka.Remote.dll
Syntax
public sealed class TestAssociationHandle : AssociationHandle

Constructors

| Edit this page View Source

TestAssociationHandle(Address, Address, TestTransport, bool)

Declaration
public TestAssociationHandle(Address localAddress, Address remoteAddress, TestTransport transport, bool inbound)
Parameters
Type Name Description
Address localAddress
Address remoteAddress
TestTransport transport
bool inbound

Fields

| Edit this page View Source

Inbound

Declaration
public readonly bool Inbound
Field Value
Type Description
bool

Properties

| Edit this page View Source

Key

Key used in AssociationRegistry to identify associations. Contains an ordered Tuple of addresses, where the first address is always the initiator of the association.

Declaration
public (Address, Address) Key { get; }
Property Value
Type Description
(Address, Address)

Methods

| Edit this page View Source

Disassociate()

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.

Declaration
public override void Disassociate()
Overrides
| Edit this page View Source

Write(ByteString)

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).

Declaration
public override bool Write(ByteString payload)
Parameters
Type Name Description
ByteString payload

The payload to be delivered to the remote endpoint.
Returns
Type Description
bool

Bool indicating the availability of the association for subsequent writes.
Overrides

Extension Methods