c

akka.remote.transport

AbstractTransportAdapter

abstract class AbstractTransportAdapter extends Transport with SchemeAugmenter

An adapter that wraps a transport and provides interception

Annotations
@deprecated
Deprecated

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

Source
AbstractTransportAdapter.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractTransportAdapter
  2. SchemeAugmenter
  3. Transport
  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 AbstractTransportAdapter(wrappedTransport: Transport)(implicit ec: ExecutionContext)

Abstract Value Members

  1. abstract def addedSchemeIdentifier: String
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  2. abstract def interceptAssociate(remoteAddress: Address, statusPromise: Promise[AssociationHandle]): Unit
    Attributes
    protected
  3. abstract def interceptListen(listenAddress: Address, listenerFuture: Future[AssociationEventListener]): Future[AssociationEventListener]
    Attributes
    protected
  4. abstract def maximumOverhead: Int
    Attributes
    protected

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 AbstractTransportAdapter to any2stringadd[AbstractTransportAdapter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractTransportAdapter, B)
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapter to ArrowAssoc[AbstractTransportAdapter] 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 associate(remoteAddress: Address): Future[AssociationHandle]

    Asynchronously opens a logical duplex link between two Transport Entities over a network.

    Asynchronously opens a logical duplex link between two Transport Entities over a network. It could be backed by a real transport-layer connection (TCP), more lightweight connections provided over datagram protocols (UDP with additional services), substreams of multiplexed connections (SCTP) or physical links (serial port).

    This call returns a future of an akka.remote.transport.AssociationHandle. A failed future indicates that the association attempt was unsuccessful. If the exception is akka.remote.transport.Transport.InvalidAssociationException then the association request was invalid, and it is impossible to recover.

    remoteAddress

    The address of the remote transport entity.

    returns

    A status instance representing failure or a success containing an akka.remote.transport.AssociationHandle

    Definition Classes
    AbstractTransportAdapterTransport
  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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. implicit val ec: ExecutionContext
  12. def ensuring(cond: (AbstractTransportAdapter) ⇒ Boolean, msg: ⇒ Any): AbstractTransportAdapter
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapter to Ensuring[AbstractTransportAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (AbstractTransportAdapter) ⇒ Boolean): AbstractTransportAdapter
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapter to Ensuring[AbstractTransportAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractTransportAdapter
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapter to Ensuring[AbstractTransportAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): AbstractTransportAdapter
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapter to Ensuring[AbstractTransportAdapter] 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 AbstractTransportAdapter to StringFormat[AbstractTransportAdapter] 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. def isResponsibleFor(address: Address): Boolean

    A function that decides whether the specific transport instance is responsible for delivering to a given address.

    A function that decides whether the specific transport instance is responsible for delivering to a given address. The function must be thread-safe and non-blocking.

    The purpose of this function is to resolve cases when the scheme part of an URL is not enough to resolve the correct transport i.e. multiple instances of the same transport implementation are loaded. These cases arise when

    • the same transport, but with different configurations is used for different remote systems
    • a transport is able to serve one address only (hardware protocols, e.g. Serial port) and multiple instances are needed to be loaded for different endpoints.
    returns

    whether the transport instance is responsible to serve communications to the given address.

    Definition Classes
    AbstractTransportAdapterTransport
  23. def listen: Future[(Address, Promise[AssociationEventListener])]

    Asynchronously attempts to setup the transport layer to listen and accept incoming associations.

    Asynchronously attempts to setup the transport layer to listen and accept incoming associations. The result of the attempt is wrapped by a Future returned by this method. The pair contained in the future contains a Promise for an ActorRef. By completing this Promise with an akka.remote.transport.Transport.AssociationEventListener, that listener becomes responsible for handling incoming associations. Until the Promise is not completed, no associations are processed.

    returns

    A Future containing a pair of the bound local address and a Promise of an AssociationListener that must be completed by the consumer of the future.

    Definition Classes
    AbstractTransportAdapterTransport
  24. def managementCommand(cmd: Any): Future[Boolean]

    This method allows upper layers to send management commands to the transport.

    This method allows upper layers to send management commands to the transport. It is the responsibility of the sender to send appropriate commands to different transport implementations. Unknown commands will be ignored.

    cmd

    Command message to the transport

    returns

    Future that succeeds when the command was handled or dropped

    Definition Classes
    Transport
  25. def maximumPayloadBytes: Int

    Defines the maximum size of payload this transport is able to deliver.

    Defines the maximum size of payload this transport is able to deliver. All transports MUST support at least 32kBytes (32000 octets) of payload, but some MAY support larger sizes.

    Definition Classes
    AbstractTransportAdapterTransport
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def removeScheme(address: Address): Address
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  30. def removeScheme(scheme: String): String
    Attributes
    protected
    Definition Classes
    SchemeAugmenter
  31. def schemeIdentifier: String

    Returns a string that will be used as the scheme part of the URLs corresponding to this transport

    Returns a string that will be used as the scheme part of the URLs corresponding to this transport

    returns

    the scheme string

    Definition Classes
    AbstractTransportAdapterTransport
  32. def shutdown(): Future[Boolean]

    Shuts down the transport layer and releases all the corresponding resources.

    Shuts down the transport layer and releases all the corresponding resources. Shutdown is asynchronous signalling the end of the shutdown by completing the returned future.

    The transport SHOULD try flushing pending writes before becoming completely closed.

    returns

    Future signalling the completion of shutdown

    Definition Classes
    AbstractTransportAdapterTransport
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. val wrappedTransport: Transport
    Attributes
    protected
  39. def [B](y: B): (AbstractTransportAdapter, B)
    Implicit
    This member is added by an implicit conversion from AbstractTransportAdapter to ArrowAssoc[AbstractTransportAdapter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from SchemeAugmenter

Inherited from Transport

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped