c

akka.remote.transport

TestAssociationHandle

final case class TestAssociationHandle(localAddress: Address, remoteAddress: Address, transport: TestTransport, inbound: Boolean) extends AssociationHandle with Product with Serializable

Annotations
@deprecated @nowarn()
Deprecated

(Since version 2.6.0) Classic remoting is deprecated, use Artery

Source
TestTransport.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestAssociationHandle
  2. Serializable
  3. Product
  4. Equals
  5. AssociationHandle
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TestAssociationHandle(localAddress: Address, remoteAddress: Address, transport: TestTransport, inbound: Boolean)

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 TestAssociationHandle toany2stringadd[TestAssociationHandle] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TestAssociationHandle, B)
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toArrowAssoc[TestAssociationHandle] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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
    TestAssociationHandleAssociationHandle
  9. 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
    Annotations
    @nowarn()
  10. def ensuring(cond: (TestAssociationHandle) => Boolean, msg: => Any): TestAssociationHandle
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toEnsuring[TestAssociationHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (TestAssociationHandle) => Boolean): TestAssociationHandle
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toEnsuring[TestAssociationHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): TestAssociationHandle
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toEnsuring[TestAssociationHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): TestAssociationHandle
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toEnsuring[TestAssociationHandle] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val inbound: Boolean
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val key: (Address, Address)

    Key used in akka.remote.transport.TestTransport.AssociationRegistry to identify associations.

    Key used in akka.remote.transport.TestTransport.AssociationRegistry to identify associations. Contains an ordered pair of addresses, where the first element of the pair is always the initiator of the association.

  19. val localAddress: Address

    Address of the local endpoint.

    Address of the local endpoint.

    returns

    Address of the local endpoint.

    Definition Classes
    TestAssociationHandleAssociationHandle
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val 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
    TestAssociationHandleAssociationHandle
  25. val remoteAddress: Address

    Address of the remote endpoint.

    Address of the remote endpoint.

    returns

    Address of the remote endpoint.

    Definition Classes
    TestAssociationHandleAssociationHandle
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val transport: TestTransport
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. var writable: Boolean
  32. 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
    TestAssociationHandleAssociationHandle

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toStringFormat[TestAssociationHandle] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (TestAssociationHandle, B)
    Implicit
    This member is added by an implicit conversion from TestAssociationHandle toArrowAssoc[TestAssociationHandle] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AssociationHandle

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTestAssociationHandle to any2stringadd[TestAssociationHandle]

Inherited by implicit conversion StringFormat fromTestAssociationHandle to StringFormat[TestAssociationHandle]

Inherited by implicit conversion Ensuring fromTestAssociationHandle to Ensuring[TestAssociationHandle]

Inherited by implicit conversion ArrowAssoc fromTestAssociationHandle to ArrowAssoc[TestAssociationHandle]

Ungrouped