trait AssociationHandle extends AnyRef

An SPI layer for abstracting over logical links (associations) created by a akka.remote.transport.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 Promise returned by akka.remote.transport.AssociationHandle#readHandlerPromise. Incoming data is not processed until this registration takes place.

Source
Transport.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractTransportAdapterHandle, TestAssociationHandle
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AssociationHandle
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def localAddress: Address

    Address of the local endpoint.

    Address of the local endpoint.

    returns

    Address of the local endpoint.

  2. abstract def readHandlerPromise: Promise[HandleEventListener]

    The Promise returned by this call must be completed with an akka.remote.transport.AssociationHandle.HandleEventListener to register a listener responsible for handling incoming payload.

    The Promise returned by this call must be completed with an akka.remote.transport.AssociationHandle.HandleEventListener to register a listener responsible for handling incoming payload. Until the listener is not registered the transport SHOULD buffer incoming messages.

    returns

    Promise that must be completed with the listener responsible for handling incoming data.

  3. abstract def remoteAddress: Address

    Address of the remote endpoint.

    Address of the remote endpoint.

    returns

    Address of the remote endpoint.

  4. abstract def write(payload: ByteString): Boolean

    Asynchronously sends the specified payload to the remote endpoint.

    Asynchronously sends the specified payload to the remote endpoint. This method 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 delivery (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).

    payload

    The payload to be delivered to the remote endpoint.

    returns

    Boolean indicating the availability of the association for subsequent writes.

  5. abstract def disassociate(): Unit

    Closes the underlying transport link, if needed.

    Closes the underlying transport link, if needed. Some transports might not need an explicit teardown (UDP) and some transports may not support it (hardware connections). 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.3) Use method that states reasons to make sure disassociation reasons are logged.

Concrete Value Members

  1. def disassociate(reason: String, log: LoggingAdapter): Unit

    Closes the underlying transport link, if needed.

    Closes the underlying transport link, if needed. Some transports might not need an explicit teardown (UDP) and some transports may not support it (hardware connections). 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.

    Annotations
    @silent()