Package akka.testkit

Interface TestKitBase

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void akka$testkit$TestKitBase$_setter_$testActor_$eq​(ActorRef x$1)
      ActorRef of the test actor.
      void akka$testkit$TestKitBase$_setter_$testKitSettings_$eq​(TestKitSettings x$1)  
      <A> A awaitAssert​(scala.Function0<A> a, scala.concurrent.duration.Duration max, scala.concurrent.duration.Duration interval)
      Evaluate the given assert every interval until it does not throw an exception and return the result.
      <A> scala.concurrent.duration.Duration awaitAssert$default$2()  
      <A> scala.concurrent.duration.Duration awaitAssert$default$3()  
      void awaitCond​(scala.Function0<java.lang.Object> p, scala.concurrent.duration.Duration max, scala.concurrent.duration.Duration interval, java.lang.String message)
      Await until the given condition evaluates to true or the timeout expires, whichever comes first.
      scala.concurrent.duration.Duration awaitCond$default$2()  
      scala.concurrent.duration.Duration awaitCond$default$3()  
      java.lang.String awaitCond$default$4()  
      void checkMissingAndUnexpected​(scala.collection.immutable.Seq<java.lang.Object> missing, scala.collection.immutable.Seq<java.lang.Object> unexpected, java.lang.String missingMessage, java.lang.String unexpectedMessage)  
      ActorRef childActorOf​(Props props)
      Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
      ActorRef childActorOf​(Props props, SupervisorStrategy supervisorStrategy)
      Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
      ActorRef childActorOf​(Props props, java.lang.String name)
      Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
      ActorRef childActorOf​(Props props, java.lang.String name, SupervisorStrategy supervisorStrategy)
      Spawns an actor as a child of this test actor, and returns the child's ActorRef.
      void end_$eq​(scala.concurrent.duration.Duration x$1)  
      <T> T expectMsg​(scala.concurrent.duration.FiniteDuration max, java.lang.String hint, T obj)
      Receive one message from the test actor and assert that it equals the given object.
      <T> T expectMsg​(scala.concurrent.duration.FiniteDuration max, T obj)
      Receive one message from the test actor and assert that it equals the given object.
      <T> T expectMsg​(T obj)
      Same as expectMsg(remainingOrDefault, obj), but correctly treating the timeFactor.
      <T> T expectMsg_internal​(scala.concurrent.duration.Duration max, T obj, scala.Option<java.lang.String> hint)  
      <T> scala.Option<java.lang.String> expectMsg_internal$default$3()  
      <T> scala.collection.immutable.Seq<T> expectMsgAllClassOf​(scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
      Same as expectMsgAllClassOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
      <T> scala.collection.immutable.Seq<T> expectMsgAllClassOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
      Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which is of that class (equality, not conformance).
      <T> scala.collection.immutable.Seq<T> expectMsgAllConformingOf​(scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
      Same as expectMsgAllConformingOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
      <T> scala.collection.immutable.Seq<T> expectMsgAllConformingOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
      Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which conforms to that class (and vice versa).
      <T> scala.collection.immutable.Seq<T> expectMsgAllOf​(scala.collection.immutable.Seq<T> obj)
      Same as expectMsgAllOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
      <T> scala.collection.immutable.Seq<T> expectMsgAllOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<T> obj)
      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.
      <T> scala.collection.immutable.Seq<T> expectMsgAllOf_internal​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<T> obj)  
      <C> C expectMsgAnyClassOf​(scala.collection.immutable.Seq<java.lang.Class<? extends C>> obj)
      Same as expectMsgAnyClassOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
      <C> C expectMsgAnyClassOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<java.lang.Class<? extends C>> obj)
      Receive one message from the test actor and assert that it conforms to one of the given classes.
      <C> C expectMsgAnyClassOf_internal​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<java.lang.Class<? extends C>> obj)  
      <T> T expectMsgAnyOf​(scala.collection.immutable.Seq<T> obj)
      Same as expectMsgAnyOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
      <T> T expectMsgAnyOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<T> obj)
      Receive one message from the test actor and assert that it equals one of the given objects.
      <T> T expectMsgAnyOf_internal​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<T> obj)  
      <C> C expectMsgClass​(java.lang.Class<C> c)
      Same as expectMsgClass(remainingOrDefault, c), but correctly treating the timeFactor.
      <C> C expectMsgClass​(scala.concurrent.duration.FiniteDuration max, java.lang.Class<C> c)
      Receive one message from the test actor and assert that it conforms to the given class.
      <C> C expectMsgClass_internal​(scala.concurrent.duration.FiniteDuration max, java.lang.Class<C> c)  
      <T> T expectMsgPF​(scala.concurrent.duration.Duration max, java.lang.String hint, scala.PartialFunction<java.lang.Object,​T> f)
      Receive one message from the test actor and assert that the given partial function accepts it.
      <T> scala.concurrent.duration.Duration expectMsgPF$default$1()  
      <T> java.lang.String expectMsgPF$default$2()  
      <T> T expectMsgType​(scala.concurrent.duration.FiniteDuration max, scala.reflect.ClassTag<T> t)
      Receive one message from the test actor and assert that it conforms to the given type (after erasure).
      <T> T expectMsgType​(scala.reflect.ClassTag<T> t)
      Same as expectMsgType[T](remainingOrDefault), but correctly treating the timeFactor.
      void expectNoMessage()
      Assert that no message is received.
      void expectNoMessage​(scala.concurrent.duration.FiniteDuration max)
      Assert that no message is received for the specified time.
      void expectNoMsg()
      Deprecated.
      Use expectNoMessage instead.
      void expectNoMsg​(scala.concurrent.duration.FiniteDuration max)
      Deprecated.
      Use expectNoMessage instead.
      void expectNoMsg_internal​(scala.concurrent.duration.FiniteDuration max)  
      Terminated expectTerminated​(ActorRef target, scala.concurrent.duration.Duration max)
      Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef.
      scala.concurrent.duration.Duration expectTerminated$default$2()  
      java.lang.Object fishForMessage​(scala.concurrent.duration.Duration max, java.lang.String hint, scala.PartialFunction<java.lang.Object,​java.lang.Object> f)
      Hybrid of expectMsgPF and receiveWhile: receive messages while the partial function matches and returns false.
      scala.concurrent.duration.Duration fishForMessage$default$1()  
      java.lang.String fishForMessage$default$2()  
      <T> T fishForSpecificMessage​(scala.concurrent.duration.Duration max, java.lang.String hint, scala.PartialFunction<java.lang.Object,​T> f)
      Waits for specific message that partial function matches while ignoring all other messages coming in the meantime.
      <T> scala.concurrent.duration.Duration fishForSpecificMessage$default$1()  
      <T> java.lang.String fishForSpecificMessage$default$2()  
      java.lang.String format​(java.util.concurrent.TimeUnit u, scala.concurrent.duration.Duration d)  
      void ignoreMsg​(scala.PartialFunction<java.lang.Object,​java.lang.Object> f)
      Ignore all messages in the test actor for which the given partial function returns true.
      void ignoreNoMsg()
      Stop ignoring messages in the test actor.
      <T> scala.collection.immutable.Seq<T> internalExpectMsgAllClassOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)  
      <T> scala.collection.immutable.Seq<T> internalExpectMsgAllConformingOf​(scala.concurrent.duration.FiniteDuration max, scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)  
      TestActor.Message lastMessage()  
      void lastMessage_$eq​(TestActor.Message x$1)  
      ActorRef lastSender()  
      void lastWasNoMsg_$eq​(boolean x$1)  
      boolean msgAvailable()
      Query queue status.
      scala.concurrent.duration.FiniteDuration now()
      Obtain current time (System.nanoTime) as Duration.
      scala.collection.immutable.Seq<java.lang.Object> receiveN​(int n)
      Same as receiveN(n, remaining) but correctly taking into account Duration.timeFactor.
      scala.collection.immutable.Seq<java.lang.Object> receiveN​(int n, scala.concurrent.duration.FiniteDuration max)
      Receive N messages in a row before the given deadline.
      scala.collection.immutable.Seq<java.lang.Object> receiveN_internal​(int n, scala.concurrent.duration.Duration max)  
      java.lang.Object receiveOne​(scala.concurrent.duration.Duration max)
      Receive one message from the internal queue of the TestActor.
      <T> scala.collection.immutable.Seq<T> receiveWhile​(scala.concurrent.duration.Duration max, scala.concurrent.duration.Duration idle, int messages, scala.PartialFunction<java.lang.Object,​T> f)
      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.
      <T> scala.concurrent.duration.Duration receiveWhile$default$1()  
      <T> scala.concurrent.duration.Duration receiveWhile$default$2()  
      <T> int receiveWhile$default$3()  
      scala.concurrent.duration.FiniteDuration remaining()
      Obtain time remaining for execution of the innermost enclosing within block or throw an AssertionError if no within block surrounds this call.
      scala.concurrent.duration.FiniteDuration remainingOr​(scala.concurrent.duration.FiniteDuration duration)
      Obtain time remaining for execution of the innermost enclosing within block or missing that it returns the given duration.
      scala.concurrent.duration.FiniteDuration remainingOrDefault()
      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").
      scala.concurrent.duration.FiniteDuration remainingOrDilated​(scala.concurrent.duration.Duration max)  
      void setAutoPilot​(TestActor.AutoPilot pilot)
      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.
      void shutdown​(ActorSystem actorSystem, scala.concurrent.duration.Duration duration, boolean verifySystemShutdown)
      Shut down an actor system and wait for termination.
      ActorSystem shutdown$default$1()  
      scala.concurrent.duration.Duration shutdown$default$2()  
      boolean shutdown$default$3()  
      ActorSystem system()  
      ActorRef testActor()
      ActorRef of the test actor.
      java.lang.String testActorName()
      Defines the testActor name.
      TestKitSettings testKitSettings()  
      ActorRef unwatch​(ActorRef ref)
      Have the testActor stop watching someone (i.e.
      ActorRef watch​(ActorRef ref)
      Have the testActor watch someone (i.e.
      <T> T within​(scala.concurrent.duration.FiniteDuration min, scala.concurrent.duration.FiniteDuration max, scala.Function0<T> f)
      Execute code block while bounding its execution time between min and max.
      <T> T within​(scala.concurrent.duration.FiniteDuration max, scala.Function0<T> f)
      Same as calling within(0 seconds, max)(f).
    • Method Detail

      • akka$testkit$TestKitBase$_setter_$testActor_$eq

        void akka$testkit$TestKitBase$_setter_$testActor_$eq​(ActorRef x$1)
        ActorRef of the test actor. Access is provided to enable e.g. registration as message target.
        Parameters:
        x$1 - (undocumented)
      • akka$testkit$TestKitBase$_setter_$testKitSettings_$eq

        void akka$testkit$TestKitBase$_setter_$testKitSettings_$eq​(TestKitSettings x$1)
      • awaitAssert

        <A> A awaitAssert​(scala.Function0<A> a,
                          scala.concurrent.duration.Duration max,
                          scala.concurrent.duration.Duration interval)
        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".

        Parameters:
        a - (undocumented)
        max - (undocumented)
        interval - (undocumented)
        Returns:
        (undocumented)
      • awaitAssert$default$2

        <A> scala.concurrent.duration.Duration awaitAssert$default$2()
      • awaitAssert$default$3

        <A> scala.concurrent.duration.Duration awaitAssert$default$3()
      • awaitCond

        void awaitCond​(scala.Function0<java.lang.Object> p,
                       scala.concurrent.duration.Duration max,
                       scala.concurrent.duration.Duration interval,
                       java.lang.String message)
        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".

        Parameters:
        p - (undocumented)
        max - (undocumented)
        interval - (undocumented)
        message - (undocumented)
      • awaitCond$default$2

        scala.concurrent.duration.Duration awaitCond$default$2()
      • awaitCond$default$3

        scala.concurrent.duration.Duration awaitCond$default$3()
      • awaitCond$default$4

        java.lang.String awaitCond$default$4()
      • checkMissingAndUnexpected

        void checkMissingAndUnexpected​(scala.collection.immutable.Seq<java.lang.Object> missing,
                                       scala.collection.immutable.Seq<java.lang.Object> unexpected,
                                       java.lang.String missingMessage,
                                       java.lang.String unexpectedMessage)
      • childActorOf

        ActorRef childActorOf​(Props props,
                              java.lang.String name,
                              SupervisorStrategy supervisorStrategy)
        Spawns an actor as a child of this test actor, and returns the child's ActorRef.
        Parameters:
        props - Props to create the child actor
        name - Actor name for the child actor
        supervisorStrategy - Strategy should decide what to do with failures in the actor.
        Returns:
        (undocumented)
      • childActorOf

        ActorRef childActorOf​(Props props,
                              SupervisorStrategy supervisorStrategy)
        Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.
        Parameters:
        props - Props to create the child actor
        supervisorStrategy - Strategy should decide what to do with failures in the actor.
        Returns:
        (undocumented)
      • childActorOf

        ActorRef childActorOf​(Props props,
                              java.lang.String name)
        Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.
        Parameters:
        props - Props to create the child actor
        name - Actor name for the child actor
        Returns:
        (undocumented)
      • childActorOf

        ActorRef childActorOf​(Props props)
        Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.
        Parameters:
        props - Props to create the child actor
        Returns:
        (undocumented)
      • end_$eq

        void end_$eq​(scala.concurrent.duration.Duration x$1)
      • expectMsg

        <T> T expectMsg​(T obj)
        Same as expectMsg(remainingOrDefault, obj), but correctly treating the timeFactor.
        Parameters:
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsg

        <T> T expectMsg​(scala.concurrent.duration.FiniteDuration max,
                        T obj)
        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.

        Parameters:
        max - (undocumented)
        obj - (undocumented)
        Returns:
        the received object
      • expectMsg

        <T> T expectMsg​(scala.concurrent.duration.FiniteDuration max,
                        java.lang.String hint,
                        T obj)
        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.

        Parameters:
        max - (undocumented)
        hint - (undocumented)
        obj - (undocumented)
        Returns:
        the received object
      • expectMsgAllClassOf

        <T> scala.collection.immutable.Seq<T> expectMsgAllClassOf​(scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
        Same as expectMsgAllClassOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
        Parameters:
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAllClassOf

        <T> scala.collection.immutable.Seq<T> expectMsgAllClassOf​(scala.concurrent.duration.FiniteDuration max,
                                                                  scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
        Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which is of that class (equality, not conformance). 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.
        Parameters:
        max - (undocumented)
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAllConformingOf

        <T> scala.collection.immutable.Seq<T> expectMsgAllConformingOf​(scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
        Same as expectMsgAllConformingOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
        Parameters:
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAllConformingOf

        <T> scala.collection.immutable.Seq<T> expectMsgAllConformingOf​(scala.concurrent.duration.FiniteDuration max,
                                                                       scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
        Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which conforms to that class (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.

        Beware that one object may satisfy all given class constraints, which may be counter-intuitive.

        Parameters:
        max - (undocumented)
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAllOf

        <T> scala.collection.immutable.Seq<T> expectMsgAllOf​(scala.collection.immutable.Seq<T> obj)
        Same as expectMsgAllOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
        Parameters:
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAllOf

        <T> scala.collection.immutable.Seq<T> expectMsgAllOf​(scala.concurrent.duration.FiniteDuration max,
                                                             scala.collection.immutable.Seq<T> obj)
        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.

           dispatcher ! SomeWork1()
           dispatcher ! SomeWork2()
           expectMsgAllOf(1 second, Result1(), Result2())
         
        Parameters:
        max - (undocumented)
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAllOf_internal

        <T> scala.collection.immutable.Seq<T> expectMsgAllOf_internal​(scala.concurrent.duration.FiniteDuration max,
                                                                      scala.collection.immutable.Seq<T> obj)
      • expectMsgAnyClassOf

        <C> C expectMsgAnyClassOf​(scala.collection.immutable.Seq<java.lang.Class<? extends C>> obj)
        Same as expectMsgAnyClassOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
        Parameters:
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAnyClassOf

        <C> C expectMsgAnyClassOf​(scala.concurrent.duration.FiniteDuration max,
                                  scala.collection.immutable.Seq<java.lang.Class<? extends C>> obj)
        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.

        Parameters:
        max - (undocumented)
        obj - (undocumented)
        Returns:
        the received object
      • expectMsgAnyClassOf_internal

        <C> C expectMsgAnyClassOf_internal​(scala.concurrent.duration.FiniteDuration max,
                                           scala.collection.immutable.Seq<java.lang.Class<? extends C>> obj)
      • expectMsgAnyOf

        <T> T expectMsgAnyOf​(scala.collection.immutable.Seq<T> obj)
        Same as expectMsgAnyOf(remainingOrDefault, obj...), but correctly treating the timeFactor.
        Parameters:
        obj - (undocumented)
        Returns:
        (undocumented)
      • expectMsgAnyOf

        <T> T expectMsgAnyOf​(scala.concurrent.duration.FiniteDuration max,
                             scala.collection.immutable.Seq<T> obj)
        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.

        Parameters:
        max - (undocumented)
        obj - (undocumented)
        Returns:
        the received object
      • expectMsgAnyOf_internal

        <T> T expectMsgAnyOf_internal​(scala.concurrent.duration.FiniteDuration max,
                                      scala.collection.immutable.Seq<T> obj)
      • expectMsgClass

        <C> C expectMsgClass​(java.lang.Class<C> c)
        Same as expectMsgClass(remainingOrDefault, c), but correctly treating the timeFactor.
        Parameters:
        c - (undocumented)
        Returns:
        (undocumented)
      • expectMsgClass

        <C> C expectMsgClass​(scala.concurrent.duration.FiniteDuration max,
                             java.lang.Class<C> c)
        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.

        Parameters:
        max - (undocumented)
        c - (undocumented)
        Returns:
        the received object
      • expectMsgClass_internal

        <C> C expectMsgClass_internal​(scala.concurrent.duration.FiniteDuration max,
                                      java.lang.Class<C> c)
      • expectMsgPF

        <T> T expectMsgPF​(scala.concurrent.duration.Duration max,
                          java.lang.String hint,
                          scala.PartialFunction<java.lang.Object,​T> f)
        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.

        Parameters:
        max - (undocumented)
        hint - (undocumented)
        f - (undocumented)
        Returns:
        the received object as transformed by the partial function
      • expectMsgPF$default$1

        <T> scala.concurrent.duration.Duration expectMsgPF$default$1()
      • expectMsgPF$default$2

        <T> java.lang.String expectMsgPF$default$2()
      • expectMsgType

        <T> T expectMsgType​(scala.reflect.ClassTag<T> t)
        Same as expectMsgType[T](remainingOrDefault), but correctly treating the timeFactor.
        Parameters:
        t - (undocumented)
        Returns:
        (undocumented)
      • expectMsgType

        <T> T expectMsgType​(scala.concurrent.duration.FiniteDuration max,
                            scala.reflect.ClassTag<T> t)
        Receive one message from the test actor and assert that it conforms to the given type (after erasure). Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

        Parameters:
        max - (undocumented)
        t - (undocumented)
        Returns:
        the received object
      • expectMsg_internal

        <T> T expectMsg_internal​(scala.concurrent.duration.Duration max,
                                 T obj,
                                 scala.Option<java.lang.String> hint)
      • expectMsg_internal$default$3

        <T> scala.Option<java.lang.String> expectMsg_internal$default$3()
      • expectNoMessage

        void expectNoMessage​(scala.concurrent.duration.FiniteDuration max)
        Assert that no message is received for the specified time. Supplied value is not dilated.
        Parameters:
        max - (undocumented)
      • expectNoMessage

        void expectNoMessage()
        Assert that no message is received. Waits for the default period configured as akka.test.expect-no-message-default. That timeout is scaled using the configuration entry "akka.test.timefactor".
      • expectNoMsg

        void expectNoMsg()
        Deprecated.
        Use expectNoMessage instead. Since 2.5.5.
        Assert that no message is received. Waits for the default period configured as akka.test.expect-no-message-default. That timeout is scaled using the configuration entry "akka.test.timefactor".
      • expectNoMsg

        void expectNoMsg​(scala.concurrent.duration.FiniteDuration max)
        Deprecated.
        Use expectNoMessage instead. Since 2.5.5.
        Assert that no message is received for the specified time. NOTE! Supplied value is always dilated.
        Parameters:
        max - (undocumented)
      • expectNoMsg_internal

        void expectNoMsg_internal​(scala.concurrent.duration.FiniteDuration max)
      • expectTerminated

        Terminated expectTerminated​(ActorRef target,
                                    scala.concurrent.duration.Duration max)
        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.

        Parameters:
        target - the actor ref expected to be Terminated
        max - wait no more than max time, otherwise throw AssertionFailure
        Returns:
        the received Terminated message
      • expectTerminated$default$2

        scala.concurrent.duration.Duration expectTerminated$default$2()
      • fishForMessage

        java.lang.Object fishForMessage​(scala.concurrent.duration.Duration max,
                                        java.lang.String hint,
                                        scala.PartialFunction<java.lang.Object,​java.lang.Object> f)
        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.

        Parameters:
        max - (undocumented)
        hint - (undocumented)
        f - (undocumented)
        Returns:
        the last received message, i.e. the first one for which the partial function returned true
      • fishForMessage$default$1

        scala.concurrent.duration.Duration fishForMessage$default$1()
      • fishForMessage$default$2

        java.lang.String fishForMessage$default$2()
      • fishForSpecificMessage

        <T> T fishForSpecificMessage​(scala.concurrent.duration.Duration max,
                                     java.lang.String hint,
                                     scala.PartialFunction<java.lang.Object,​T> f)
        Waits for specific message that partial function matches while ignoring all other messages coming in the meantime. Use it to ignore any number of messages while waiting for a specific one.

        Parameters:
        max - (undocumented)
        hint - (undocumented)
        f - (undocumented)
        Returns:
        result of applying partial function to the last received message, i.e. the first one for which the partial function is defined
      • fishForSpecificMessage$default$1

        <T> scala.concurrent.duration.Duration fishForSpecificMessage$default$1()
      • fishForSpecificMessage$default$2

        <T> java.lang.String fishForSpecificMessage$default$2()
      • format

        java.lang.String format​(java.util.concurrent.TimeUnit u,
                                scala.concurrent.duration.Duration d)
      • ignoreMsg

        void ignoreMsg​(scala.PartialFunction<java.lang.Object,​java.lang.Object> f)
        Ignore all messages in the test actor for which the given partial function returns true.
        Parameters:
        f - (undocumented)
      • ignoreNoMsg

        void ignoreNoMsg()
        Stop ignoring messages in the test actor.
      • internalExpectMsgAllClassOf

        <T> scala.collection.immutable.Seq<T> internalExpectMsgAllClassOf​(scala.concurrent.duration.FiniteDuration max,
                                                                          scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
      • internalExpectMsgAllConformingOf

        <T> scala.collection.immutable.Seq<T> internalExpectMsgAllConformingOf​(scala.concurrent.duration.FiniteDuration max,
                                                                               scala.collection.immutable.Seq<java.lang.Class<? extends T>> obj)
      • lastWasNoMsg_$eq

        void lastWasNoMsg_$eq​(boolean x$1)
      • msgAvailable

        boolean msgAvailable()
        Query queue status.
        Returns:
        (undocumented)
      • now

        scala.concurrent.duration.FiniteDuration now()
        Obtain current time (System.nanoTime) as Duration.
        Returns:
        (undocumented)
      • receiveN

        scala.collection.immutable.Seq<java.lang.Object> receiveN​(int n)
        Same as receiveN(n, remaining) but correctly taking into account Duration.timeFactor.
        Parameters:
        n - (undocumented)
        Returns:
        (undocumented)
      • receiveN

        scala.collection.immutable.Seq<java.lang.Object> receiveN​(int n,
                                                                  scala.concurrent.duration.FiniteDuration max)
        Receive N messages in a row before the given deadline.
        Parameters:
        n - (undocumented)
        max - (undocumented)
        Returns:
        (undocumented)
      • receiveN_internal

        scala.collection.immutable.Seq<java.lang.Object> receiveN_internal​(int n,
                                                                           scala.concurrent.duration.Duration max)
      • receiveOne

        java.lang.Object receiveOne​(scala.concurrent.duration.Duration max)
        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!

        Parameters:
        max - (undocumented)
        Returns:
        (undocumented)
      • receiveWhile

        <T> scala.collection.immutable.Seq<T> receiveWhile​(scala.concurrent.duration.Duration max,
                                                           scala.concurrent.duration.Duration idle,
                                                           int messages,
                                                           scala.PartialFunction<java.lang.Object,​T> f)
        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:

        
         test ! ScheduleTicks(100 millis)
         val series = receiveWhile(750 millis) {
             case Tick(count) => count
         }
         assert(series == (1 to 7).toList)
         
        Parameters:
        max - (undocumented)
        idle - (undocumented)
        messages - (undocumented)
        f - (undocumented)
        Returns:
        (undocumented)
      • receiveWhile$default$1

        <T> scala.concurrent.duration.Duration receiveWhile$default$1()
      • receiveWhile$default$2

        <T> scala.concurrent.duration.Duration receiveWhile$default$2()
      • receiveWhile$default$3

        <T> int receiveWhile$default$3()
      • remaining

        scala.concurrent.duration.FiniteDuration remaining()
        Obtain time remaining for execution of the innermost enclosing within block or throw an AssertionError if no within block surrounds this call.
        Returns:
        (undocumented)
      • remainingOr

        scala.concurrent.duration.FiniteDuration remainingOr​(scala.concurrent.duration.FiniteDuration duration)
        Obtain time remaining for execution of the innermost enclosing within block or missing that it returns the given duration.
        Parameters:
        duration - (undocumented)
        Returns:
        (undocumented)
      • remainingOrDefault

        scala.concurrent.duration.FiniteDuration remainingOrDefault()
        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").
        Returns:
        (undocumented)
      • remainingOrDilated

        scala.concurrent.duration.FiniteDuration remainingOrDilated​(scala.concurrent.duration.Duration max)
      • setAutoPilot

        void setAutoPilot​(TestActor.AutoPilot pilot)
        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.
        Parameters:
        pilot - (undocumented)
      • shutdown

        void shutdown​(ActorSystem actorSystem,
                      scala.concurrent.duration.Duration duration,
                      boolean verifySystemShutdown)
        Shut down an actor system and wait for termination. On failure debug output will be logged about the remaining actors in the system.

        If verifySystemShutdown is true, then an exception will be thrown on failure.

        Parameters:
        actorSystem - (undocumented)
        duration - (undocumented)
        verifySystemShutdown - (undocumented)
      • shutdown$default$2

        scala.concurrent.duration.Duration shutdown$default$2()
      • shutdown$default$3

        boolean shutdown$default$3()
      • testActor

        ActorRef testActor()
        ActorRef of the test actor. Access is provided to enable e.g. registration as message target.
        Returns:
        (undocumented)
      • testActorName

        java.lang.String testActorName()
        Defines the testActor name.
        Returns:
        (undocumented)
      • unwatch

        ActorRef unwatch​(ActorRef ref)
        Have the testActor stop watching someone (i.e. context.unwatch(...)).
        Parameters:
        ref - (undocumented)
        Returns:
        (undocumented)
      • watch

        ActorRef watch​(ActorRef ref)
        Have the testActor watch someone (i.e. context.watch(...)).
        Parameters:
        ref - (undocumented)
        Returns:
        (undocumented)
      • within

        <T> T within​(scala.concurrent.duration.FiniteDuration min,
                     scala.concurrent.duration.FiniteDuration max,
                     scala.Function0<T> f)
        Execute code block while bounding its execution time between min and max. 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 enclosing within block.

        Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "akka.test.timefactor", while the min Duration is not.

        
         val ret = within(50 millis) {
           test ! "ping"
           expectMsgClass(classOf[String])
         }
         
        Parameters:
        min - (undocumented)
        max - (undocumented)
        f - (undocumented)
        Returns:
        (undocumented)
      • within

        <T> T within​(scala.concurrent.duration.FiniteDuration max,
                     scala.Function0<T> f)
        Same as calling within(0 seconds, max)(f).
        Parameters:
        max - (undocumented)
        f - (undocumented)
        Returns:
        (undocumented)