c

akka.remote.transport

TestAssociationHandle

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestAssociationHandle
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AssociationHandle
  7. AnyRef
  8. 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 TestAssociationHandle(localAddress: Address, remoteAddress: Address, transport: TestTransport, inbound: Boolean)

Value Members

  1. 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
    TestAssociationHandle → AssociationHandle
  2. 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
  3. val inbound: Boolean
  4. 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.

  5. val localAddress: Address
    Definition Classes
    TestAssociationHandle → AssociationHandle
  6. val readHandlerPromise: Promise[HandleEventListener]
    Definition Classes
    TestAssociationHandle → AssociationHandle
  7. val remoteAddress: Address
    Definition Classes
    TestAssociationHandle → AssociationHandle
  8. val transport: TestTransport
  9. var writable: Boolean
  10. 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
    TestAssociationHandle → AssociationHandle