akka.remote.testconductor

TestConductorExt

class TestConductorExt extends Extension with Conductor with Player

This binds together the akka.remote.testconductor.Conductor and akka.remote.testconductor.Player roles inside an Akka akka.actor.Extension. Please follow the aforementioned links for more information.

Note

This extension requires the akka.actor.provider to be a akka.remote.RemoteActorRefProvider.

To use blackhole, passThrough, and throttle you must activate the TestConductorTranport by specifying testTransport(on = true) in your MultiNodeConfig.

Linear Supertypes
Player, Conductor, Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TestConductorExt
  2. Player
  3. Conductor
  4. Extension
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestConductorExt(system: ExtendedActorSystem)

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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. object Settings

  7. def abort(node: RoleName, target: RoleName): Future[Done]

    Tell the remote support to TCP_RESET the connection to the given remote peer.

    Tell the remote support to TCP_RESET the connection to the given remote peer. It works regardless of whether the recipient was initiator or responder.

    node

    is the symbolic name of the node which is to be affected

    target

    is the symbolic name of the other node to which connectivity shall be impeded

    Definition Classes
    Conductor
  8. val address: Address

    Transport address of this Netty-like remote transport.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def blackhole(node: RoleName, target: RoleName, direction: Direction): Future[Done]

    Switch the Netty pipeline of the remote support into blackhole mode for sending and/or receiving: it will just drop all messages right before submitting them to the Socket or right after receiving them from the Socket.

    Switch the Netty pipeline of the remote support into blackhole mode for sending and/or receiving: it will just drop all messages right before submitting them to the Socket or right after receiving them from the Socket.

    Note

    To use this feature you must activate the TestConductorTranport by specifying testTransport(on = true) in your MultiNodeConfig.

    node

    is the symbolic name of the node which is to be affected

    target

    is the symbolic name of the other node to which connectivity shall be impeded

    direction

    can be either Direction.Send, Direction.Receive or Direction.Both

    Definition Classes
    Conductor
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def disconnect(node: RoleName, target: RoleName): Future[Done]

    Tell the remote support to shutdown the connection to the given remote peer.

    Tell the remote support to shutdown the connection to the given remote peer. It works regardless of whether the recipient was initiator or responder.

    node

    is the symbolic name of the node which is to be affected

    target

    is the symbolic name of the other node to which connectivity shall be impeded

    Definition Classes
    Conductor
  13. def enter(timeout: Timeout, name: Seq[String]): Unit

    Enter the named barriers, one after the other, in the order given.

    Enter the named barriers, one after the other, in the order given. Will throw an exception in case of timeouts or other errors.

    Definition Classes
    Player
  14. def enter(name: String*): Unit

    Enter the named barriers, one after the other, in the order given.

    Enter the named barriers, one after the other, in the order given. Will throw an exception in case of timeouts or other errors.

    Definition Classes
    Player
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def getAddressFor(name: RoleName): Future[Address]

    Query remote transport address of named node.

    Query remote transport address of named node.

    Definition Classes
    Player
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def getNodes: Future[Iterable[RoleName]]

    Obtain the list of remote host names currently registered.

    Obtain the list of remote host names currently registered.

    Definition Classes
    Conductor
  21. def hashCode(): Int

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

    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  26. def passThrough(node: RoleName, target: RoleName, direction: Direction): Future[Done]

    Switch the Netty pipeline of the remote support into pass through mode for sending and/or receiving.

    Switch the Netty pipeline of the remote support into pass through mode for sending and/or receiving.

    Note

    To use this feature you must activate the TestConductorTranport by specifying testTransport(on = true) in your MultiNodeConfig.

    node

    is the symbolic name of the node which is to be affected

    target

    is the symbolic name of the other node to which connectivity shall be impeded

    direction

    can be either Direction.Send, Direction.Receive or Direction.Both

    Definition Classes
    Conductor
  27. def removeNode(node: RoleName): Future[Done]

    Remove a remote host from the list, so that the remaining nodes may still pass subsequent barriers.

    Remove a remote host from the list, so that the remaining nodes may still pass subsequent barriers. This must be done before the client connection breaks down in order to affect an “orderly” removal (i.e. without failing present and future barriers).

    node

    is the symbolic name of the node which is to be removed

    Definition Classes
    Conductor
  28. def shutdown(node: RoleName, exitValue: Int): Future[Done]

    Tell the remote node to shut itself down using System.

    Tell the remote node to shut itself down using System.exit with the given exitValue. The node will also be removed, so that the remaining nodes may still pass subsequent barriers.

    node

    is the symbolic name of the node which is to be affected

    exitValue

    is the return code which shall be given to System.exit

    Definition Classes
    Conductor
  29. def sockAddr: Future[InetSocketAddress]

    Obtain the port to which the controller’s socket is actually bound.

    Obtain the port to which the controller’s socket is actually bound. This will deviate from the configuration in akka.testconductor.port in case that was given as zero.

    Definition Classes
    Conductor
  30. def startClient(name: RoleName, controllerAddr: InetSocketAddress): Future[Done]

    Connect to the conductor on the given port (the host is taken from setting akka.testconductor.host).

    Connect to the conductor on the given port (the host is taken from setting akka.testconductor.host). The connection is made asynchronously, but you should await completion of the returned Future because that implies that all expected participants of this test have successfully connected (i.e. this is a first barrier in itself). The number of expected participants is set in akka.remote.testconductor.Conductor.startController().

    Definition Classes
    Player
  31. def startController(participants: Int, name: RoleName, controllerPort: InetSocketAddress): Future[InetSocketAddress]

    Start the akka.remote.testconductor.Controller, which in turn will bind to a TCP port as specified in the akka.testconductor.port config property, where 0 denotes automatic allocation.

    Start the akka.remote.testconductor.Controller, which in turn will bind to a TCP port as specified in the akka.testconductor.port config property, where 0 denotes automatic allocation. Since the latter is actually preferred, a Future[Int] is returned which will be completed with the port number actually chosen, so that this can then be communicated to the players for their proper start-up.

    This method also invokes akka.remote.testconductor.Player.startClient, since it is expected that the conductor participates in barriers for overall coordination. The returned Future will only be completed once the client’s start-up finishes, which in fact waits for all other players to connect.

    participants

    gives the number of participants which shall connect before any of their startClient() operations complete.

    Definition Classes
    Conductor
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  33. val system: ExtendedActorSystem

  34. def throttle(node: RoleName, target: RoleName, direction: Direction, rateMBit: Double): Future[Done]

    Make the remoting pipeline on the node throttle data sent to or received from the given remote peer.

    Make the remoting pipeline on the node throttle data sent to or received from the given remote peer. Throttling works by delaying packet submission within the netty pipeline until the packet would have been completely sent according to the given rate, the previous packet completion and the current packet length. In case of large packets they are split up if the calculated send pause would exceed akka.testconductor.packet-split-threshold (roughly). All of this uses the system’s HashedWheelTimer, which is not terribly precise and will execute tasks later than they are schedule (even on average), but that is countered by using the actual execution time for determining how much to send, leading to the correct output rate, but with increased latency.

    Note

    To use this feature you must activate the TestConductorTranport by specifying testTransport(on = true) in your MultiNodeConfig.

    node

    is the symbolic name of the node which is to be affected

    target

    is the symbolic name of the other node to which connectivity shall be throttled

    direction

    can be either Direction.Send, Direction.Receive or Direction.Both

    rateMBit

    is the maximum data rate in MBit

    Definition Classes
    Conductor
  35. def toString(): String

    Definition Classes
    AnyRef → Any
  36. val transport: RemoteTransport

    Remote transport used by the actor ref provider.

  37. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Player

Inherited from Conductor

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped