class TestKit extends AnyRef
Java API: Test kit for testing actors. Inheriting from this class enables
reception of replies from actors, which are queued by an internal actor and
can be examined using the expectMsg...
methods. Assertions and
bounds concerning timing are available in the form of Within
blocks.
Beware of two points:
- the ActorSystem passed into the constructor needs to be shutdown,
otherwise thread pools and memory will be leaked - this trait is not
thread-safe (only one actor with one queue, one stack of
Within
blocks); take care not to run tests within a single test class instance in parallel. - It should be noted that for CI servers and the like all maximum Durations
are scaled using the
dilated
method, which uses the TestKitExtension.Settings.TestTimeFactor settable via akka.conf entry "akka.test.timefactor".
- Source
- TestKit.scala
- Alphabetic
- By Inheritance
- TestKit
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new TestKit(system: ActorSystem)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (TestKit, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
awaitAssert[A](max: Duration, interval: Duration, a: Supplier[A]): A
Evaluate the given assert every
interval
until it does not throw an exception.Evaluate the given assert every
interval
until it does not throw an exception. If themax
timeout expires the last exception is thrown.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
- returns
an arbitrary value that would be returned from awaitAssert if successful, if not interested in such value you can return null.
-
def
awaitAssert[A](max: Duration, a: Supplier[A]): A
Evaluate the given assert every
interval
until it does not throw an exception and return the result.Evaluate the given assert every
interval
until it does not throw an exception and return the result.If the
max
timeout expires the last exception is thrown.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
-
def
awaitAssert[A](a: Supplier[A]): A
Evaluate the given assert every
interval
until it does not throw an exception and return the result.Evaluate the given assert every
interval
until it does not throw an exception and return the result.If the
max
timeout expires the last exception is thrown.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
-
def
awaitCond(max: Duration, interval: Duration, message: String, p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
-
def
awaitCond(max: Duration, interval: Duration, p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
-
def
awaitCond(max: Duration, p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
-
def
awaitCond(p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
-
def
childActorOf(props: Props): ActorRef
Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
-
def
childActorOf(props: Props, name: String): ActorRef
Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
-
def
childActorOf(props: Props, supervisorStrategy: SupervisorStrategy): ActorRef
Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
-
def
childActorOf(props: Props, name: String, supervisorStrategy: SupervisorStrategy): ActorRef
Spawns an actor as a child of this test actor, and returns the child's ActorRef.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
dilated(duration: Duration): Duration
Java timeouts (durations) during tests with the configured
- def duration(s: String): FiniteDuration
- def ensuring(cond: (TestKit) ⇒ Boolean, msg: ⇒ Any): TestKit
- def ensuring(cond: (TestKit) ⇒ Boolean): TestKit
- def ensuring(cond: Boolean, msg: ⇒ Any): TestKit
- def ensuring(cond: Boolean): TestKit
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
expectMsg[T](max: Duration, obj: T, hint: String): T
Receive one message from the test actor and assert that it equals the given object.
Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
-
def
expectMsg[T](max: Duration, obj: T): T
Receive one message from the test actor and assert that it equals the given object.
Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
-
def
expectMsg[T](obj: T): T
Same as
expectMsg(remainingOrDefault, obj)
, but correctly treating the timeFactor. -
def
expectMsgAllOf[T](max: Duration, objs: T*): List[T]
Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa.
Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa. This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
-
def
expectMsgAllOf[T](objs: T*): List[T]
Same as
expectMsgAllOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor.Same as
expectMsgAllOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor.- Annotations
- @varargs()
-
def
expectMsgAnyClassOf[T](max: Duration, objs: Class[_]*): T
Receive one message from the test actor and assert that it conforms to one of the given classes.
Receive one message from the test actor and assert that it conforms to one of the given classes. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @varargs()
-
def
expectMsgAnyClassOf[T](objs: Class[_]*): T
Same as
expectMsgAnyClassOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor.Same as
expectMsgAnyClassOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor.- Annotations
- @varargs()
-
def
expectMsgAnyOf[T](max: Duration, objs: T*): T
Receive one message from the test actor and assert that it equals one of the given objects.
Receive one message from the test actor and assert that it equals one of the given objects. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
-
def
expectMsgAnyOf[T](objs: T*): T
Same as
expectMsgAnyOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor.Same as
expectMsgAnyOf(remainingOrDefault, obj...)
, but correctly treating the timeFactor.- Annotations
- @varargs()
-
def
expectMsgClass[T](max: Duration, c: Class[T]): T
Receive one message from the test actor and assert that it conforms to the given class.
Receive one message from the test actor and assert that it conforms to the given class. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
-
def
expectMsgClass[T](c: Class[T]): T
Same as
expectMsgClass(remainingOrDefault, c)
, but correctly treating the timeFactor. -
def
expectMsgEquals[T](max: Duration, obj: T): T
Receive one message from the test actor and assert that it equals the given object.
Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- returns
the received object
-
def
expectMsgEquals[T](obj: T): T
Same as
expectMsg(remainingOrDefault, obj)
, but correctly treating the timeFactor. -
def
expectMsgPF[T](max: Duration, hint: String, f: Function[Any, T]): T
Receive one message from the test actor and assert that the given partial function accepts it.
Receive one message from the test actor and assert that the given partial function accepts it. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
Use this variant to implement more complicated or conditional processing.
-
def
expectMsgPF[T](max: Duration, hint: String, f: Function[Any, T]): T
Receive one message from the test actor and assert that the given partial function accepts it.
Receive one message from the test actor and assert that the given partial function accepts it. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
Use this variant to implement more complicated or conditional processing.
-
def
expectMsgPF[T](hint: String, f: Function[Any, T]): T
Receive one message from the test actor and assert that the given partial function accepts it.
Receive one message from the test actor and assert that the given partial function accepts it. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
Use this variant to implement more complicated or conditional processing.
-
def
expectNoMessage(max: Duration): Unit
Assert that no message is received for the specified time.
Assert that no message is received for the specified time. Supplied value is not dilated.
-
def
expectNoMessage(): Unit
Same as
expectNoMessage(remainingOrDefault)
, but correctly treating the timeFactor. -
def
expectTerminated(target: ActorRef): Terminated
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef.
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef. Before calling this method, you have to
watch
the target actor ref. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.- target
the actor ref expected to be Terminated
- returns
the received Terminated message
-
def
expectTerminated(max: Duration, target: ActorRef): Terminated
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef.
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef. Before calling this method, you have to
watch
the target actor ref. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.- max
wait no more than max time, otherwise throw AssertionFailure
- target
the actor ref expected to be Terminated
- returns
the received Terminated message
-
def
expectTerminated(max: Duration, target: ActorRef): Terminated
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef.
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef. Before calling this method, you have to
watch
the target actor ref. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.- max
wait no more than max time, otherwise throw AssertionFailure
- target
the actor ref expected to be Terminated
- returns
the received Terminated message
-
def
fishForMessage(max: Duration, hint: String, f: Function[Any, Boolean]): Any
Hybrid of expectMsgPF and receiveWhile: receive messages while the partial function matches and returns false.
Hybrid of expectMsgPF and receiveWhile: receive messages while the partial function matches and returns false. Use it to ignore certain messages while waiting for a specific message.
- returns
the last received message, i.e. the first one for which the partial function returned true
-
def
fishForSpecificMessage[T](max: Duration, hint: String, f: Function[Any, T]): T
Same as
fishForMessage
, but gets a different partial function and returns properly typed message. - def formatted(fmtstr: String): String
-
def
forward(actor: ActorRef): Unit
Forward this message as if in the TestActor's receive method with self.forward.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getLastSender: ActorRef
Get the last sender of the TestProbe
-
def
getRef: ActorRef
Shorthand to get the testActor.
-
def
getRemaining: Duration
Obtain time remaining for execution of the innermost enclosing
within
block or throw an AssertionError if nowithin
block surrounds this call. -
def
getRemainingOr(duration: Duration): Duration
Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the given duration. -
def
getRemainingOrDefault: Duration
Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the properly dilated default for this case from settings (key "akka.test.single-expect-default"). - def getSystem: ActorSystem
-
def
getTestActor: ActorRef
ActorRef of the test actor.
ActorRef of the test actor. Access is provided to enable e.g. registration as message target.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
ignoreMsg(pf: Function[Any, Boolean]): Unit
Ignore all messages in the test actor for which the given partial function returns true.
-
def
ignoreNoMsg(): Unit
Stop ignoring messages in the test actor.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
msgAvailable: Boolean
Query queue status.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
receiveN(n: Int, max: Duration): List[AnyRef]
Receive N messages in a row before the given deadline.
-
def
receiveN(n: Int): List[AnyRef]
Same as
receiveN(n, remaining)
but correctly taking into account Duration.timeFactor. -
def
receiveOne(max: Duration): AnyRef
Receive one message from the internal queue of the TestActor.
Receive one message from the internal queue of the TestActor. If the given duration is zero, the queue is polled (non-blocking).
This method does NOT automatically scale its Duration parameter!
- def receiveWhile[T](max: Duration, f: Function[AnyRef, T]): List[T]
-
def
receiveWhile[T](max: Duration, idle: Duration, messages: Int, f: Function[AnyRef, T]): List[T]
Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached.
Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached. Returns the sequence of messages.
Note that it is not an error to hit the
max
duration in this case.One possible use of this method is for testing whether messages of certain characteristics are generated at a certain rate:
-
def
reply(msg: AnyRef): Unit
Send message to the sender of the last dequeued message.
-
def
send(actor: ActorRef, msg: AnyRef): Unit
Send message to an actor while using the probe's TestActor as the sender.
Send message to an actor while using the probe's TestActor as the sender. Replies will be available for inspection with all of TestKit's assertion methods.
-
def
setAutoPilot(pilot: AutoPilot): Unit
Install an AutoPilot to drive the testActor: the AutoPilot will be run for each received message and can be used to send or forward messages, etc.
Install an AutoPilot to drive the testActor: the AutoPilot will be run for each received message and can be used to send or forward messages, etc. Each invocation must return the AutoPilot for the next round.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unwatch(ref: ActorRef): ActorRef
Have the testActor stop watching someone (i.e.
Have the testActor stop watching someone (i.e.
context.unwatch(...)
). -
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
watch(ref: ActorRef): ActorRef
Have the testActor watch someone (i.e.
Have the testActor watch someone (i.e.
context.watch(...)
). -
def
within[T](max: Duration, f: Supplier[T]): T
Execute code block while bounding its execution time between
min
andmax
.Execute code block while bounding its execution time between
min
andmax
.within
blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosingwithin
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor", while the min Duration is not.
within(java.time.Duration.ofMillis(50), () -> { test.tell("ping"); return expectMsgClass(String.class); });
-
def
within[T](min: Duration, max: Duration, f: Supplier[T]): T
Execute code block while bounding its execution time between
min
andmax
.Execute code block while bounding its execution time between
min
andmax
.within
blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosingwithin
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor", while the min Duration is not.
within(java.time.Duration.ofMillis(50), () -> { test.tell("ping"); return expectMsgClass(String.class); });
- def →[B](y: B): (TestKit, B)
Deprecated Value Members
-
def
awaitAssert[A](max: Duration, interval: Duration, a: Supplier[A]): A
Evaluate the given assert every
interval
until it does not throw an exception.Evaluate the given assert every
interval
until it does not throw an exception. If themax
timeout expires the last exception is thrown.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
- returns
an arbitrary value that would be returned from awaitAssert if successful, if not interested in such value you can return null.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.13) Use the overloaded one which accepts java.time.Duration instead.
-
def
awaitAssert[A](max: Duration, a: Supplier[A]): A
Evaluate the given assert every
interval
until it does not throw an exception and return the result.Evaluate the given assert every
interval
until it does not throw an exception and return the result.If the
max
timeout expires the last exception is thrown.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.13) Use the overloaded one which accepts java.time.Duration instead.
-
def
awaitCond(max: Duration, interval: Duration, message: String, p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
awaitCond(max: Duration, interval: Duration, p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
awaitCond(max: Duration, p: Supplier[Boolean]): Unit
Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.Await until the given condition evaluates to
true
or the timeout expires, whichever comes first.If no timeout is given, take it from the innermost enclosing
within
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor".
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
dilated(d: FiniteDuration): FiniteDuration
Scale timeouts (durations) during tests with the configured
Scale timeouts (durations) during tests with the configured
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsg[T](max: FiniteDuration, obj: T, hint: String): T
Receive one message from the test actor and assert that it equals the given object.
Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsg[T](max: FiniteDuration, obj: T): T
Receive one message from the test actor and assert that it equals the given object.
Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsgAllOf[T](max: FiniteDuration, objs: T*): List[T]
Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa.
Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa. This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @varargs() @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsgAnyClassOf[T](max: FiniteDuration, objs: Class[_]*): T
Receive one message from the test actor and assert that it conforms to one of the given classes.
Receive one message from the test actor and assert that it conforms to one of the given classes. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @varargs() @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsgAnyOf[T](max: FiniteDuration, objs: T*): T
Receive one message from the test actor and assert that it equals one of the given objects.
Receive one message from the test actor and assert that it equals one of the given objects. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @varargs() @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsgClass[T](max: FiniteDuration, c: Class[T]): T
Receive one message from the test actor and assert that it conforms to the given class.
Receive one message from the test actor and assert that it conforms to the given class. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectMsgEquals[T](max: FiniteDuration, obj: T): T
Receive one message from the test actor and assert that it equals the given object.
Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.
- returns
the received object
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectNoMessage(max: FiniteDuration): Unit
Assert that no message is received for the specified time.
Assert that no message is received for the specified time. Supplied value is not dilated.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
expectNoMsg(max: FiniteDuration): Unit
Assert that no message is received for the specified time.
Assert that no message is received for the specified time.
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.10) Use expectNoMessage instead
-
def
expectNoMsg(): Unit
Same as
expectNoMsg(remainingOrDefault)
, but correctly treating the timeFactor.Same as
expectNoMsg(remainingOrDefault)
, but correctly treating the timeFactor.- Annotations
- @deprecated
- Deprecated
(Since version 2.5.10) Use expectNoMessage instead
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
- Deprecated
(Since version ) see corresponding Javadoc for more information.
-
def
receiveN(n: Int, max: FiniteDuration): List[AnyRef]
Receive N messages in a row before the given deadline.
Receive N messages in a row before the given deadline.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
receiveOne(max: Duration): AnyRef
Receive one message from the internal queue of the TestActor.
Receive one message from the internal queue of the TestActor. If the given duration is zero, the queue is polled (non-blocking).
This method does NOT automatically scale its Duration parameter!
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.13) Use the overloaded one which accepts java.time.Duration instead.
-
def
receiveWhile[T](max: Duration, f: Function[AnyRef, T]): List[T]
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.13) Use the overloaded one which accepts java.time.Duration instead.
-
def
receiveWhile[T](max: Duration, idle: Duration, messages: Int, f: Function[AnyRef, T]): List[T]
Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached.
Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached. Returns the sequence of messages.
Note that it is not an error to hit the
max
duration in this case.One possible use of this method is for testing whether messages of certain characteristics are generated at a certain rate:
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.13) Use the overloaded one which accepts java.time.Duration instead.
-
def
remaining: FiniteDuration
Obtain time remaining for execution of the innermost enclosing
within
block or throw an AssertionError if nowithin
block surrounds this call.Obtain time remaining for execution of the innermost enclosing
within
block or throw an AssertionError if nowithin
block surrounds this call.- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use getRemaining which returns java.time.Duration instead.
-
def
remainingOr(fd: FiniteDuration): FiniteDuration
Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the given duration.Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the given duration.- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use getRemainingOr which returns java.time.Duration instead.
-
def
remainingOrDefault: FiniteDuration
Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the properly dilated default for this case from settings (key "akka.test.single-expect-default").Obtain time remaining for execution of the innermost enclosing
within
block or missing that it returns the properly dilated default for this case from settings (key "akka.test.single-expect-default").- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use getRemainingOrDefault which returns java.time.Duration instead.
-
def
within[T](max: FiniteDuration, f: Supplier[T]): T
Execute code block while bounding its execution time between
min
andmax
.Execute code block while bounding its execution time between
min
andmax
.within
blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosingwithin
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor", while the min Duration is not.
within(duration("50 millis"), () -> { test.tell("ping"); return expectMsgClass(String.class); });
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.
-
def
within[T](min: FiniteDuration, max: FiniteDuration, f: Supplier[T]): T
Execute code block while bounding its execution time between
min
andmax
.Execute code block while bounding its execution time between
min
andmax
.within
blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosingwithin
block.Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor", while the min Duration is not.
within(duration("50 millis"), () -> { test.tell("ping"); return expectMsgClass(String.class); });
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.