c

akka.remote.transport

AbstractTransportAdapterHandle

abstract class AbstractTransportAdapterHandle extends AssociationHandle with SchemeAugmenter

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractTransportAdapterHandle
  2. SchemeAugmenter
  3. AssociationHandle
  4. AnyRef
  5. 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

Instance Constructors

  1. new AbstractTransportAdapterHandle(wrappedHandle: AssociationHandle, addedSchemeIdentifier: String)
  2. new AbstractTransportAdapterHandle(originalLocalAddress: Address, originalRemoteAddress: Address, wrappedHandle: AssociationHandle, addedSchemeIdentifier: String)

Abstract Value Members

  1. 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
  2. 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
  3. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to any2stringadd[AbstractTransportAdapterHandle] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractTransportAdapterHandle, B)
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to ArrowAssoc[AbstractTransportAdapterHandle] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val addedSchemeIdentifier: String
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def augmentScheme(address: Address): Address
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  9. def augmentScheme(originalScheme: String): String
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  11. 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
  12. def ensuring(cond: (AbstractTransportAdapterHandle) ⇒ Boolean, msg: ⇒ Any): AbstractTransportAdapterHandle
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to Ensuring[AbstractTransportAdapterHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (AbstractTransportAdapterHandle) ⇒ Boolean): AbstractTransportAdapterHandle
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to Ensuring[AbstractTransportAdapterHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractTransportAdapterHandle
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to Ensuring[AbstractTransportAdapterHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): AbstractTransportAdapterHandle
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to Ensuring[AbstractTransportAdapterHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to StringFormat[AbstractTransportAdapterHandle] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val localAddress: Address

    Address of the local endpoint.

    Address of the local endpoint.

    returns

    Address of the local endpoint.

    Definition Classes
    AbstractTransportAdapterHandleAssociationHandle
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. val originalLocalAddress: Address
  27. val originalRemoteAddress: Address
  28. val remoteAddress: Address

    Address of the remote endpoint.

    Address of the remote endpoint.

    returns

    Address of the remote endpoint.

    Definition Classes
    AbstractTransportAdapterHandleAssociationHandle
  29. def removeScheme(address: Address): Address
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  30. def removeScheme(scheme: String): String
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. val wrappedHandle: AssociationHandle
  37. def [B](y: B): (AbstractTransportAdapterHandle, B)
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapterHandle to ArrowAssoc[AbstractTransportAdapterHandle] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from SchemeAugmenter

Inherited from AssociationHandle

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AbstractTransportAdapterHandle to any2stringadd[AbstractTransportAdapterHandle]

Inherited by implicit conversion StringFormat from AbstractTransportAdapterHandle to StringFormat[AbstractTransportAdapterHandle]

Inherited by implicit conversion Ensuring from AbstractTransportAdapterHandle to Ensuring[AbstractTransportAdapterHandle]

Inherited by implicit conversion ArrowAssoc from AbstractTransportAdapterHandle to ArrowAssoc[AbstractTransportAdapterHandle]

Ungrouped