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
, and passThrough
you must activate the
failure injector and throttler transport adapters by specifying throttle
testTransport(on = true)
in your MultiNodeConfig.
- Source
- Extension.scala
- Alphabetic
- By Inheritance
- TestConductorExt
- Player
- Conductor
- Extension
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TestConductorExt(system: ExtendedActorSystem)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from TestConductorExt toany2stringadd[TestConductorExt] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (TestConductorExt, B)
- Implicit
- This member is added by an implicit conversion from TestConductorExt toArrowAssoc[TestConductorExt] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- val address: Address
Transport address of this Netty-like remote transport.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
orDirection.Both
- Definition Classes
- Conductor
- Annotations
- @nowarn()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- def ensuring(cond: (TestConductorExt) => Boolean, msg: => Any): TestConductorExt
- Implicit
- This member is added by an implicit conversion from TestConductorExt toEnsuring[TestConductorExt] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (TestConductorExt) => Boolean): TestConductorExt
- Implicit
- This member is added by an implicit conversion from TestConductorExt toEnsuring[TestConductorExt] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): TestConductorExt
- Implicit
- This member is added by an implicit conversion from TestConductorExt toEnsuring[TestConductorExt] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): TestConductorExt
- Implicit
- This member is added by an implicit conversion from TestConductorExt toEnsuring[TestConductorExt] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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
- Definition Classes
- Conductor
- def getAddressFor(name: RoleName): Future[Address]
Query remote transport address of named node.
Query remote transport address of named node.
- Definition Classes
- Player
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
orDirection.Both
- Definition Classes
- Conductor
- Annotations
- @nowarn()
- 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
- 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
- Definition Classes
- Conductor
- 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
- Definition Classes
- Conductor
- 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
- 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
- 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, aFuture[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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val system: ExtendedActorSystem
- def toString(): String
- Definition Classes
- AnyRef → Any
- val transport: RemoteTransport
Remote transport used by the actor ref provider.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object Settings
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from TestConductorExt toStringFormat[TestConductorExt] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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
orDirection.Both
- rateMBit
is the maximum data rate in MBit
- Definition Classes
- Conductor
- Annotations
- @deprecated
- Deprecated
(Since version 2.8.0) Throttle is not implemented, use blackhole and passThrough.
- def →[B](y: B): (TestConductorExt, B)
- Implicit
- This member is added by an implicit conversion from TestConductorExt toArrowAssoc[TestConductorExt] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.