akka.testkit

TestActorRef

class TestActorRef[T <: Actor] extends LocalActorRef

This special ActorRef is exclusively for use during unit testing in a single-threaded environment. Therefore, it overrides the dispatcher to CallingThreadDispatcher and sets the receiveTimeout to None. Otherwise, it acts just like a normal ActorRef. You may retrieve a reference to the underlying actor to test internal logic.

Source
TestActorRef.scala
Since

1.1

Linear Supertypes
LocalActorRef, LocalRef, ActorRefScope, ActorRefWithCell, InternalActorRef, ScalaActorRef, ActorRef, Serializable, Serializable, Comparable[ActorRef], AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TestActorRef
  2. LocalActorRef
  3. LocalRef
  4. ActorRefScope
  5. ActorRefWithCell
  6. InternalActorRef
  7. ScalaActorRef
  8. ActorRef
  9. Serializable
  10. Serializable
  11. Comparable
  12. AnyRef
  13. Any
Implicitly
  1. by actorRef2Scala
  2. by scala2ActorRef
  3. by any2stringadd
  4. by any2stringfmt
  5. by any2ArrowAssoc
  6. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestActorRef(_system: ActorSystem, _props: Props, _supervisor: ActorRef, name: String)

Value Members

  1. def !(message: Any)(implicit sender: ActorRef = Actor.noSender): Unit

    Sends a one-way asynchronous message.

    Sends a one-way asynchronous message. E.g. fire-and-forget semantics.

    If invoked from within an actor then the actor reference is implicitly passed on as the implicit 'sender' argument.

    This actor 'sender' reference is then available in the receiving actor in the 'sender()' member variable, if invoked from within an Actor. If not then no sender is available.

      actor ! message
    

    Definition Classes
    LocalActorRef → ScalaActorRef
  2. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  3. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  4. final def ##(): Int

    Definition Classes
    AnyRef → Any
  5. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  6. def ->[B](y: B): (TestActorRef[T], B)

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ArrowAssoc[TestActorRef[T]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  8. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  9. def actorContext: ActorContext

    Attributes
    protected
    Definition Classes
    LocalActorRef
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def children: Iterable[ActorRef]

    Definition Classes
    LocalActorRef → ActorRefWithCell
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def compareTo(other: ActorRef): Int

    Comparison takes path and the unique id of the actor cell into account.

    Comparison takes path and the unique id of the actor cell into account.

    Definition Classes
    ActorRef → Comparable
  14. val dispatcher: MessageDispatcher

  15. def ensuring(cond: (TestActorRef[T]) ⇒ Boolean, msg: ⇒ Any): TestActorRef[T]

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to Ensuring[TestActorRef[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (TestActorRef[T]) ⇒ Boolean): TestActorRef[T]

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to Ensuring[TestActorRef[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): TestActorRef[T]

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to Ensuring[TestActorRef[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): TestActorRef[T]

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to Ensuring[TestActorRef[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. final def equals(that: Any): Boolean

    Equals takes path and the unique id of the actor cell into account.

    Equals takes path and the unique id of the actor cell into account.

    Definition Classes
    ActorRef → AnyRef → Any
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. def forward(message: Any)(implicit context: ActorContext): Unit

    Forwards the message and passes the original sender actor as the sender.

    Forwards the message and passes the original sender actor as the sender.

    Works, no matter whether originally sent with tell/'!' or ask/'?'.

    Definition Classes
    ActorRef
  24. def getChild(names: Iterator[String]): InternalActorRef

    Obtain ActorRef by possibly traversing the actor tree or looking it up at some provider-specific location.

    Obtain ActorRef by possibly traversing the actor tree or looking it up at some provider-specific location. This method shall return the end result, i.e. not only the next step in the look-up; this will typically involve recursive invocation. A path element of ".." signifies the parent, a trailing "" element must be disregarded. If the requested path does not exist, return Nobody.

    Definition Classes
    LocalActorRef → InternalActorRef
  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  26. def getParent: InternalActorRef

    Obtain parent of this ref; used by getChild for ".

    Obtain parent of this ref; used by getChild for ".." paths.

    Definition Classes
    LocalActorRef → InternalActorRef
  27. def getSingleChild(name: String): InternalActorRef

    Method for looking up a single child beneath this actor.

    Method for looking up a single child beneath this actor. Override in order to inject “synthetic” actor paths like “/temp”. It is racy if called from the outside.

    Definition Classes
    LocalActorRef → ActorRefWithCell
  28. final def hashCode(): Int

    Definition Classes
    ActorRef → AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  30. final def isLocal: Boolean

    Definition Classes
    LocalRef → ActorRefScope
  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  32. def newActorCell(system: ActorSystemImpl, ref: InternalActorRef, props: Props, dispatcher: MessageDispatcher, supervisor: InternalActorRef): ActorCell

    Attributes
    protected
    Definition Classes
    TestActorRef → LocalActorRef
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. val path: ActorPath

    Returns the path for this actor (from this actor up to the root actor).

    Returns the path for this actor (from this actor up to the root actor).

    Definition Classes
    LocalActorRef → ActorRef
  36. val props: Props

  37. def provider: ActorRefProvider

    Get a reference to the actor ref provider which created this ref.

    Get a reference to the actor ref provider which created this ref.

    Definition Classes
    LocalActorRef → InternalActorRef
  38. def receive(o: Any, sender: ActorRef): Unit

    Directly inject messages into actor receive behavior.

    Directly inject messages into actor receive behavior. Any exceptions thrown will be available to you, while still being able to use become/unbecome.

  39. def receive(o: Any): Unit

    Directly inject messages into actor receive behavior.

    Directly inject messages into actor receive behavior. Any exceptions thrown will be available to you, while still being able to use become/unbecome.

  40. def restart(cause: Throwable): Unit

    Definition Classes
    LocalActorRef → InternalActorRef
  41. def resume(causedByFailure: Throwable): Unit

    Resumes a suspended actor.

    Resumes a suspended actor.

    Definition Classes
    LocalActorRef → InternalActorRef
  42. def sendSystemMessage(message: SystemMessage): Unit

    Definition Classes
    LocalActorRef → InternalActorRef
  43. def start(): Unit

    Starts the actor after initialization.

    Starts the actor after initialization.

    Definition Classes
    LocalActorRef → InternalActorRef
  44. def stop(): Unit

    Shuts down the actor and its message queue

    Shuts down the actor and its message queue

    Definition Classes
    LocalActorRef → InternalActorRef
  45. def suspend(): Unit

    Suspends the actor so that it will not process messages until resumed.

    Suspends the actor so that it will not process messages until resumed. The suspend request is processed asynchronously to the caller of this method as well as to normal message sends: the only ordering guarantee is that message sends done from the same thread after calling this method will not be processed until resumed.

    Definition Classes
    LocalActorRef → InternalActorRef
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  47. final def tell(msg: Any, sender: ActorRef): Unit

    Sends the specified message to the sender, i.

    Sends the specified message to the sender, i.e. fire-and-forget semantics, including the sender reference if possible.

    Pass akka.actor.ActorRef$.noSender or null as sender if there is nobody to reply to

    Definition Classes
    ActorRef
  48. def toString(): String

    Definition Classes
    TestActorRefActorRef → AnyRef → Any
  49. def underlying: ActorCell

    Definition Classes
    LocalActorRef → ActorRefWithCell
  50. def underlyingActor: T

    Retrieve reference to the underlying actor, where the static type matches the factory used inside the constructor.

    Retrieve reference to the underlying actor, where the static type matches the factory used inside the constructor. Beware that this reference is discarded by the ActorRef upon restarting the actor (should this reference be linked to a supervisor). The old Actor may of course still be used in post-mortem assertions.

  51. def unwatch(subject: ActorRef): ActorRef

    Deregisters this actor from being a death monitor of the provided ActorRef This means that this actor will not get a Terminated()-message when the provided actor is permanently terminated.

    Deregisters this actor from being a death monitor of the provided ActorRef This means that this actor will not get a Terminated()-message when the provided actor is permanently terminated.

    returns

    the same ActorRef that is provided to it, to allow for cleaner invocations

  52. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def watch(subject: ActorRef): ActorRef

    Registers this actor to be a death monitor of the provided ActorRef This means that this actor will get a Terminated()-message when the provided actor is permanently terminated.

    Registers this actor to be a death monitor of the provided ActorRef This means that this actor will get a Terminated()-message when the provided actor is permanently terminated.

    returns

    the same ActorRef that is provided to it, to allow for cleaner invocations

  56. def writeReplace(): AnyRef

    Attributes
    protected
    Definition Classes
    LocalActorRef
    Annotations
    @throws( ... )
  57. def [B](y: B): (TestActorRef[T], B)

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ArrowAssoc[TestActorRef[T]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def !(message: Any)(implicit sender: ActorRef = Actor.noSender): Unit

    Sends a one-way asynchronous message.

    Sends a one-way asynchronous message. E.g. fire-and-forget semantics.

    If invoked from within an actor then the actor reference is implicitly passed on as the implicit 'sender' argument.

    This actor 'sender' reference is then available in the receiving actor in the 'sender()' member variable, if invoked from within an Actor. If not then no sender is available.

      actor ! message
    

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ScalaActorRef performed by method actorRef2Scala in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ScalaActorRef).!(message)(sender)
    Definition Classes
    ScalaActorRef
  2. final def compareTo(other: ActorRef): Int

    Comparison takes path and the unique id of the actor cell into account.

    Comparison takes path and the unique id of the actor cell into account.

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).compareTo(other)
    Definition Classes
    ActorRef → Comparable
  3. final def equals(that: Any): Boolean

    Equals takes path and the unique id of the actor cell into account.

    Equals takes path and the unique id of the actor cell into account.

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).equals(that)
    Definition Classes
    ActorRef → AnyRef → Any
  4. def forward(message: Any)(implicit context: ActorContext): Unit

    Forwards the message and passes the original sender actor as the sender.

    Forwards the message and passes the original sender actor as the sender.

    Works, no matter whether originally sent with tell/'!' or ask/'?'.

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).forward(message)(context)
    Definition Classes
    ActorRef
  5. final def hashCode(): Int

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).hashCode()
    Definition Classes
    ActorRef → AnyRef → Any
  6. def path: ActorPath

    Returns the path for this actor (from this actor up to the root actor).

    Returns the path for this actor (from this actor up to the root actor).

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).path
    Definition Classes
    ActorRef
  7. val self: Any

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (testActorRef: StringAdd).self
    Definition Classes
    StringAdd
  8. val self: Any

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (testActorRef: StringFormat).self
    Definition Classes
    StringFormat
  9. final def tell(msg: Any, sender: ActorRef): Unit

    Sends the specified message to the sender, i.

    Sends the specified message to the sender, i.e. fire-and-forget semantics, including the sender reference if possible.

    Pass akka.actor.ActorRef$.noSender or null as sender if there is nobody to reply to

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).tell(msg, sender)
    Definition Classes
    ActorRef
  10. def toString(): String

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).toString()
    Definition Classes
    ActorRef → AnyRef → Any

Deprecated Value Members

  1. def isTerminated: Boolean

    Is the actor shut down? The contract is that if this method returns true, then it will never be false again.

    Is the actor shut down? The contract is that if this method returns true, then it will never be false again. But you cannot rely on that it is alive if it returns false, since this by nature is a racy method.

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ActorRef performed by method scala2ActorRef in akka.actor.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (testActorRef: ActorRef).isTerminated
    Definition Classes
    ActorRef
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use context.watch(actor) and receive Terminated(actor)

  2. def isTerminated: Boolean

    Is the actor terminated? If this method returns true, it will never return false again, but if it returns false, you cannot be sure if it's alive still (race condition)

    Is the actor terminated? If this method returns true, it will never return false again, but if it returns false, you cannot be sure if it's alive still (race condition)

    Definition Classes
    LocalActorRef → InternalActorRef → ActorRef
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use context.watch(actor) and receive Terminated(actor)

  3. def x: TestActorRef[T]

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ArrowAssoc[TestActorRef[T]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (testActorRef: ArrowAssoc[TestActorRef[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  4. def x: TestActorRef[T]

    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to Ensuring[TestActorRef[T]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (testActorRef: Ensuring[TestActorRef[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from LocalActorRef

Inherited from LocalRef

Inherited from ActorRefScope

Inherited from ActorRefWithCell

Inherited from InternalActorRef

Inherited from ScalaActorRef

Inherited from ActorRef

Inherited from Serializable

Inherited from Serializable

Inherited from Comparable[ActorRef]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion actorRef2Scala from TestActorRef[T] to ScalaActorRef

Inherited by implicit conversion scala2ActorRef from TestActorRef[T] to ActorRef

Inherited by implicit conversion any2stringadd from TestActorRef[T] to StringAdd

Inherited by implicit conversion any2stringfmt from TestActorRef[T] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from TestActorRef[T] to ArrowAssoc[TestActorRef[T]]

Inherited by implicit conversion any2Ensuring from TestActorRef[T] to Ensuring[TestActorRef[T]]

Ungrouped