Packages

trait Conductor extends AnyRef

The conductor is the one orchestrating the test: it governs the akka.remote.testconductor.Controller’s port to which all akka.remote.testconductor.Players connect, it issues commands to their akka.remote.testconductor.NetworkFailureInjector and provides support for barriers using the akka.remote.testconductor.BarrierCoordinator. All of this is bundled inside the akka.remote.testconductor.TestConductorExt extension.

Self Type
TestConductorExt
Source
Conductor.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Conductor
  2. AnyRef
  3. 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

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 Conductor to any2stringadd[Conductor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Conductor, B)
    Implicit
    This member is added by an implicit conversion from Conductor to ArrowAssoc[Conductor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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 failure injector and throttler transport adapters 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

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. 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

  11. def ensuring(cond: (Conductor) ⇒ Boolean, msg: ⇒ Any): Conductor
    Implicit
    This member is added by an implicit conversion from Conductor to Ensuring[Conductor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Conductor) ⇒ Boolean): Conductor
    Implicit
    This member is added by an implicit conversion from Conductor to Ensuring[Conductor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Conductor
    Implicit
    This member is added by an implicit conversion from Conductor to Ensuring[Conductor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Conductor
    Implicit
    This member is added by an implicit conversion from Conductor to Ensuring[Conductor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def exit(node: RoleName, exitValue: Int): Future[Done]

    Tell the remote node to shut itself down using System.exit with the given exitValue.

    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

  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Conductor to StringFormat[Conductor] 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 getNodes: Future[Iterable[RoleName]]

    Obtain the list of remote host names currently registered.

  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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 failure injector and throttler transport adapters 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

  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

  28. def shutdown(node: RoleName, abort: Boolean): Future[Done]

    Tell the actor system at the remote node to shut itself down without awaiting termination of remote-deployed children.

    Tell the actor system at the remote node to shut itself down without awaiting termination of remote-deployed children. 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

  29. def shutdown(node: RoleName): Future[Done]

    Tell the actor system at the remote node to shut itself down.

    Tell the actor system at the remote node to shut itself down. 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

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

  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.

  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. 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 scheduler, 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 failure injector and throttler transport adapters 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

  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. def [B](y: B): (Conductor, B)
    Implicit
    This member is added by an implicit conversion from Conductor to ArrowAssoc[Conductor] 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 AnyRef

Inherited from Any

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

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

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

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

Ungrouped