Apache Pekko
1.0.1
API
Generated with
Apache Pekko/org.apache.pekko.remote/org.apache.pekko.remote.transport/AbstractTransportAdapterHandle

AbstractTransportAdapterHandle

org.apache.pekko.remote.transport.AbstractTransportAdapterHandle
abstract class AbstractTransportAdapterHandle(val originalLocalAddress: Address, val originalRemoteAddress: Address, val wrappedHandle: AssociationHandle, val addedSchemeIdentifier: String) extends AssociationHandle, SchemeAugmenter

Attributes

Deprecated
true
Source
AbstractTransportAdapter.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Constructors

def this(wrappedHandle: AssociationHandle, addedSchemeIdentifier: String)

Attributes

Source
AbstractTransportAdapter.scala

Inherited methods

protected def augmentScheme(address: Address): Address

Attributes

Inherited from:
SchemeAugmenter
Source
AbstractTransportAdapter.scala
protected def augmentScheme(originalScheme: String): String

Attributes

Inherited from:
SchemeAugmenter
Source
AbstractTransportAdapter.scala
def disassociate(reason: String, log: LoggingAdapter): Unit

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.

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.

Attributes

Inherited from:
AssociationHandle
Source
Transport.scala
def readHandlerPromise: Promise[HandleEventListener]

The Promise returned by this call must be completed with an pekko.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.

The Promise returned by this call must be completed with an pekko.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.

Attributes

Returns

Promise that must be completed with the listener responsible for handling incoming data.

Inherited from:
AssociationHandle
Source
Transport.scala
protected def removeScheme(address: Address): Address

Attributes

Inherited from:
SchemeAugmenter
Source
AbstractTransportAdapter.scala
protected def removeScheme(scheme: String): String

Attributes

Inherited from:
SchemeAugmenter
Source
AbstractTransportAdapter.scala
def write(payload: ByteString): Boolean

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.

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).

Value parameters

payload

The payload to be delivered to the remote endpoint.

Attributes

Returns

Boolean indicating the availability of the association for subsequent writes.

Inherited from:
AssociationHandle
Source
Transport.scala

Deprecated and Inherited methods

def disassociate(): Unit

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.

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.

Attributes

Deprecated
[Since version Akka 2.5.3] Use method that states reasons to make sure disassociation reasons are logged.
Inherited from:
AssociationHandle
Source
Transport.scala

Concrete fields

override val localAddress: Address

Address of the local endpoint.

Address of the local endpoint.

Attributes

Returns

Address of the local endpoint.

Source
AbstractTransportAdapter.scala
override val remoteAddress: Address

Address of the remote endpoint.

Address of the remote endpoint.

Attributes

Returns

Address of the remote endpoint.

Source
AbstractTransportAdapter.scala
Generated with