Package org.apache.pekko.actor.testkit.typed.scaladsl

Interface TestInbox<T>

public interface TestInbox<T>
Utility for use as an ActorRef when *synchronously* testing pekko.actor.typed.Behavior with pekko.actor.testkit.typed.javadsl.BehaviorTestKit.

If you plan to use a real pekko.actor.typed.ActorSystem then use pekko.actor.testkit.typed.javadsl.TestProbe for asynchronous testing.

Use factory apply in companion to create instances

Not for user extension

  • Method Summary

    Modifier and Type
    Method
    Description
    TestInbox<T>
    expectMessage(T expectedMessage)
    Assert and remove the the oldest message.
    boolean
    hasMessages()
     
    scala.collection.immutable.Seq<T>
    internalReceiveAll()
     
    scala.collection.immutable.Seq<T>
    receiveAll()
    Collect all messages in the inbox and clear it out
    T
    receiveMessage()
    Get and remove the oldest message
    ActorRef<T>
    ref()
    The actor ref of the inbox

  • Method Details

    • ref

      ActorRef<T> ref()
      The actor ref of the inbox

    • receiveMessage

      T receiveMessage()
      Get and remove the oldest message

    • expectMessage

      TestInbox<T> expectMessage(T expectedMessage)
      Assert and remove the the oldest message.

    • receiveAll

      scala.collection.immutable.Seq<T> receiveAll()
      Collect all messages in the inbox and clear it out

    • internalReceiveAll

      scala.collection.immutable.Seq<T> internalReceiveAll()

    • hasMessages

      boolean hasMessages()