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
- Alphabetic
- By Inheritance
- AssociationHandle
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
localAddress: Address
Address of the local endpoint.
Address of the local endpoint.
- returns
Address of the local endpoint.
-
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.
-
abstract
def
remoteAddress: Address
Address of the remote endpoint.
Address of the remote endpoint.
- returns
Address of the remote endpoint.
-
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.
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from AssociationHandle to any2stringadd[AssociationHandle] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (AssociationHandle, B)
- Implicit
- This member is added by an implicit conversion from AssociationHandle to ArrowAssoc[AssociationHandle] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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()
-
def
ensuring(cond: (AssociationHandle) ⇒ Boolean, msg: ⇒ Any): AssociationHandle
- Implicit
- This member is added by an implicit conversion from AssociationHandle to Ensuring[AssociationHandle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (AssociationHandle) ⇒ Boolean): AssociationHandle
- Implicit
- This member is added by an implicit conversion from AssociationHandle to Ensuring[AssociationHandle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): AssociationHandle
- Implicit
- This member is added by an implicit conversion from AssociationHandle to Ensuring[AssociationHandle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): AssociationHandle
- Implicit
- This member is added by an implicit conversion from AssociationHandle to Ensuring[AssociationHandle] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AssociationHandle to StringFormat[AssociationHandle] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (AssociationHandle, B)
- Implicit
- This member is added by an implicit conversion from AssociationHandle to ArrowAssoc[AssociationHandle] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc