class TestTransport extends Transport

Transport implementation to be used for testing.

The TestTransport is basically a shared memory between actor systems. The TestTransport could be programmed to emulate different failure modes of a Transport implementation. TestTransport keeps a log of the activities it was requested to do. This class is not optimized for performance and MUST not be used as an in-memory transport in production systems.

Annotations
@deprecated
Deprecated

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

Source
TestTransport.scala
Linear Supertypes
Transport, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestTransport
  2. Transport
  3. AnyRef
  4. 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 TestTransport(system: ExtendedActorSystem, conf: Config)
  2. new TestTransport(localAddress: Address, registry: TestTransport.AssociationRegistry, maximumPayloadBytes: Int = 32000, schemeIdentifier: String = "test")

Value Members

  1. 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 pekko.remote.transport.AssociationHandle. A failed future indicates that the association attempt was unsuccessful. If the exception is pekko.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 pekko.remote.transport.AssociationHandle

    Definition Classes
    TestTransport → Transport
  2. val associateBehavior: SwitchableLoggedBehavior[Address, AssociationHandle]

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the associate() method.

  3. val disassociateBehavior: SwitchableLoggedBehavior[TestAssociationHandle, Unit]

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the disassociate() method on handles.

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the disassociate() method on handles. All handle calls pass through this call.

  4. 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
    TestTransport → Transport
  5. 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 pekko.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
    TestTransport → Transport
  6. val listenBehavior: SwitchableLoggedBehavior[Unit, (Address, Promise[AssociationEventListener])]

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the listen() method.

  7. val localAddress: Address
  8. 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
  9. val 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
    TestTransport → Transport
  10. final val registry: TestTransport.AssociationRegistry
  11. val 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
    TestTransport → Transport
  12. 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
    TestTransport → Transport
  13. val shutdownBehavior: SwitchableLoggedBehavior[Unit, Boolean]

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the shutdown() method.

  14. def toString(): String
    Definition Classes
    TestTransport → AnyRef → Any
  15. val writeBehavior: SwitchableLoggedBehavior[(TestAssociationHandle, ByteString), Boolean]

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the write() method on handles.

    The pekko.remote.transport.TestTransport.SwitchableLoggedBehavior for the write() method on handles. All handle calls pass through this call. Please note, that write operations return a Boolean synchronously, so altering the behavior via pushDelayed will turn write to a blocking operation -- use of pushDelayed therefore is not recommended.