abstract class AbstractTransportAdapterHandle extends AssociationHandle with SchemeAugmenter
- Alphabetic
- By Inheritance
- AbstractTransportAdapterHandle
- SchemeAugmenter
- AssociationHandle
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new AbstractTransportAdapterHandle(wrappedHandle: AssociationHandle, addedSchemeIdentifier: String)
- new AbstractTransportAdapterHandle(originalLocalAddress: Address, originalRemoteAddress: Address, wrappedHandle: AssociationHandle, addedSchemeIdentifier: String)
Abstract Value Members
-
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.
- Definition Classes
- AssociationHandle
-
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.
- Definition Classes
- AssociationHandle
-
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.
- Definition Classes
- AssociationHandle
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.3) Use method that states reasons to make sure disassociation reasons are logged.
Concrete Value Members
-
val
addedSchemeIdentifier: String
- Definition Classes
- AbstractTransportAdapterHandle → SchemeAugmenter
-
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.
- Definition Classes
- AssociationHandle
-
val
localAddress: Address
Address of the local endpoint.
Address of the local endpoint.
- returns
Address of the local endpoint.
- Definition Classes
- AbstractTransportAdapterHandle → AssociationHandle
- val originalLocalAddress: Address
- val originalRemoteAddress: Address
-
val
remoteAddress: Address
Address of the remote endpoint.
Address of the remote endpoint.
- returns
Address of the remote endpoint.
- Definition Classes
- AbstractTransportAdapterHandle → AssociationHandle
- val wrappedHandle: AssociationHandle