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.

Annotations
@silent()
Source
TestActorRef.scala
Since

1.1

Linear Supertypes
LocalActorRef, LocalRef, ActorRefScope, ActorRefWithCell, InternalActorRef, ScalaActorRef, ActorRef, Serializable, Serializable, Comparable[ActorRef], AnyRef, Any
Known Subclasses
TestFSMRef
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 StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
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. def children: Iterable[ActorRef]
    Definition Classes
    LocalActorRef → ActorRefWithCell
  3. 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
  4. val dispatcher: MessageDispatcher
  5. 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
  6. 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
  7. 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
  8. def getParent: InternalActorRef

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

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

    Definition Classes
    LocalActorRef → InternalActorRef
  9. 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
  10. final def hashCode(): Int
    Definition Classes
    ActorRef → AnyRef → Any
  11. final def isLocal: Boolean
    Definition Classes
    LocalRef → ActorRefScope
  12. 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
  13. val props: Props
  14. 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
  15. 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.

  16. 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.

  17. def restart(cause: Throwable): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  18. def resume(causedByFailure: Throwable): Unit

    Resumes a suspended actor.

    Resumes a suspended actor.

    Definition Classes
    LocalActorRef → InternalActorRef
  19. def sendSystemMessage(message: SystemMessage): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  20. def start(): Unit

    Starts the actor after initialization.

    Starts the actor after initialization.

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

    Shuts down the actor and its message queue

    Shuts down the actor and its message queue

    Definition Classes
    LocalActorRef → InternalActorRef
  22. 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
  23. final def tell(msg: Any, sender: ActorRef): Unit

    Sends the specified message to this ActorRef, i.e.

    Sends the specified message to this ActorRef, 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
  24. def toString(): String
    Definition Classes
    TestActorRef → ActorRef → AnyRef → Any
  25. def underlying: ActorCell
    Definition Classes
    LocalActorRef → ActorRefWithCell
  26. 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.

  27. def unwatch(subject: ActorRef): ActorRef

    Unregisters 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.

    Unregisters 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

  28. 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

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
    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
    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
    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
    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
    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
    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. final def tell(msg: Any, sender: ActorRef): Unit

    Sends the specified message to this ActorRef, i.e.

    Sends the specified message to this ActorRef, 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
    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
  8. def toString(): String
    Implicit
    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