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
@nowarn()
Source
TestActorRef.scala
Linear Supertypes
LocalActorRef, LocalRef, ActorRefScope, ActorRefWithCell, InternalActorRef, ScalaActorRef, ActorRef, Serializable, Comparable[ActorRef], AnyRef, Any
Known Subclasses
TestFSMRef
Type Hierarchy
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. Comparable
  11. AnyRef
  12. Any
Implicitly
  1. by scala2ActorRef
  2. by actorRef2Scala
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Value Members

  1. def !(message: Any)(implicit sender: ActorRef): Unit
    Definition Classes
    LocalActorRef → ScalaActorRef → ActorRef
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toany2stringadd[TestActorRef[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (TestActorRef[T], B)
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toArrowAssoc[TestActorRef[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def actorContext: ActorContext
    Attributes
    protected
    Definition Classes
    LocalActorRef
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def children: Iterable[ActorRef]
    Definition Classes
    LocalActorRef → ActorRefWithCell
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. final def compareTo(other: ActorRef): Int
    Definition Classes
    ActorRef → Comparable
  12. val dispatcher: MessageDispatcher
  13. def ensuring(cond: (TestActorRef[T]) => Boolean, msg: => Any): TestActorRef[T]
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toEnsuring[TestActorRef[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (TestActorRef[T]) => Boolean): TestActorRef[T]
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toEnsuring[TestActorRef[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): TestActorRef[T]
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toEnsuring[TestActorRef[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): TestActorRef[T]
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toEnsuring[TestActorRef[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def equals(that: Any): Boolean
    Definition Classes
    ActorRef → AnyRef → Any
  19. def forward(message: Any)(implicit context: ActorContext): Unit
    Definition Classes
    ActorRef
  20. def getChild(names: Iterator[String]): InternalActorRef
    Definition Classes
    LocalActorRef → InternalActorRef
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def getParent: InternalActorRef
    Definition Classes
    LocalActorRef → InternalActorRef
  23. def getSingleChild(name: String): InternalActorRef
    Definition Classes
    LocalActorRef → ActorRefWithCell
  24. final def hashCode(): Int
    Definition Classes
    ActorRef → AnyRef → Any
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def isLocal: Boolean
    Definition Classes
    LocalRef → ActorRefScope
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def newActorCell(system: ActorSystemImpl, ref: InternalActorRef, props: Props, dispatcher: MessageDispatcher, supervisor: InternalActorRef): ActorCell
    Attributes
    protected
    Definition Classes
    TestActorRef → LocalActorRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. val path: ActorPath
    Definition Classes
    LocalActorRef → ActorRef
  32. val props: Props
  33. def provider: ActorRefProvider
    Definition Classes
    LocalActorRef → InternalActorRef
  34. 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.

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

  36. def restart(cause: Throwable): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  37. def resume(causedByFailure: Throwable): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  38. def sendSystemMessage(message: SystemMessage): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  39. def start(): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  40. def stop(): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  41. def suspend(): Unit
    Definition Classes
    LocalActorRef → InternalActorRef
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. final def tell(msg: Any, sender: ActorRef): Unit
    Definition Classes
    ActorRef
  44. def toString(): String
    Definition Classes
    TestActorRef → ActorRef → AnyRef → Any
  45. def underlying: ActorCell
    Definition Classes
    LocalActorRef → ActorRefWithCell
  46. 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.

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

  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. 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

  52. def writeReplace(): AnyRef
    Attributes
    protected
    Definition Classes
    LocalActorRef
    Annotations
    @throws(classOf[java.io.ObjectStreamException])

Shadowed Implicit Value Members

  1. def !(message: Any)(implicit sender: ActorRef): Unit
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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).!(message)(sender)
    Definition Classes
    ActorRef
  2. def !(message: Any)(implicit sender: ActorRef): Unit
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toScalaActorRef performed by method actorRef2Scala in org.apache.pekko.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
  3. final def compareTo(other: ActorRef): Int
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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
  4. final def equals(that: Any): Boolean
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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
  5. def forward(message: Any)(implicit context: ActorContext): Unit
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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
  6. final def hashCode(): Int
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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
  7. def path: ActorPath
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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
  8. final def tell(msg: Any, sender: ActorRef): Unit
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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
  9. def toString(): String
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toActorRef performed by method scala2ActorRef in org.apache.pekko.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 finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toStringFormat[TestActorRef[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (TestActorRef[T], B)
    Implicit
    This member is added by an implicit conversion from TestActorRef[T] toArrowAssoc[TestActorRef[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

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 Comparable[ActorRef]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion scala2ActorRef fromTestActorRef[T] to ActorRef

Inherited by implicit conversion actorRef2Scala fromTestActorRef[T] to ScalaActorRef

Inherited by implicit conversion any2stringadd fromTestActorRef[T] to any2stringadd[TestActorRef[T]]

Inherited by implicit conversion StringFormat fromTestActorRef[T] to StringFormat[TestActorRef[T]]

Inherited by implicit conversion Ensuring fromTestActorRef[T] to Ensuring[TestActorRef[T]]

Inherited by implicit conversion ArrowAssoc fromTestActorRef[T] to ArrowAssoc[TestActorRef[T]]

Ungrouped