akka.remote.transport

Transport

trait Transport extends AnyRef

An SPI layer for implementing asynchronous transport mechanisms. The Transport is responsible for initializing the underlying transmission mechanism and setting up logical links between transport entities.

Transport implementations that are loaded dynamically by the remoting must have a constructor that accepts a com.typesafe.config.Config and an akka.actor.ExtendedActorSystem as parameters.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Transport
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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

  2. abstract 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.

  3. abstract 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.

  4. abstract 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.

    returns

  5. abstract 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

  6. abstract 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

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Transport to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Transport, B)

    Implicit information
    This member is added by an implicit conversion from Transport to ArrowAssoc[Transport] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (Transport) ⇒ Boolean, msg: ⇒ Any): Transport

    Implicit information
    This member is added by an implicit conversion from Transport to Ensuring[Transport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Transport) ⇒ Boolean): Transport

    Implicit information
    This member is added by an implicit conversion from Transport to Ensuring[Transport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Transport

    Implicit information
    This member is added by an implicit conversion from Transport to Ensuring[Transport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Transport

    Implicit information
    This member is added by an implicit conversion from Transport to Ensuring[Transport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Transport to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. 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

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. def toString(): String

    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (Transport, B)

    Implicit information
    This member is added by an implicit conversion from Transport to ArrowAssoc[Transport] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Transport to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transport: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Transport to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transport: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Transport

    Implicit information
    This member is added by an implicit conversion from Transport to ArrowAssoc[Transport] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transport: ArrowAssoc[Transport]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Transport

    Implicit information
    This member is added by an implicit conversion from Transport to Ensuring[Transport] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transport: Ensuring[Transport]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Transport to StringAdd

Inherited by implicit conversion any2stringfmt from Transport to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Transport to ArrowAssoc[Transport]

Inherited by implicit conversion any2Ensuring from Transport to Ensuring[Transport]

Ungrouped