Class/Object

akka.testkit

TestActorRef

Related Docs: object TestActorRef | package testkit

Permalink

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

    Permalink

Value Members

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

    Permalink
    Definition Classes
    LocalActorRef → ScalaActorRef

  2. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

  5. def ->[B](y: B): (TestActorRef[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to ArrowAssoc[TestActorRef[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  7. def actorContext: ActorContext

    Permalink
    Attributes
    protected
    Definition Classes
    LocalActorRef

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. def children: Iterable[ActorRef]

    Permalink
    Definition Classes
    LocalActorRef → ActorRefWithCell

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def compareTo(other: ActorRef): Int

    Permalink
    Definition Classes
    ActorRef → Comparable

  12. val dispatcher: MessageDispatcher

    Permalink

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

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

  14. def ensuring(cond: (TestActorRef[T]) ⇒ Boolean): TestActorRef[T]

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

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

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

  16. def ensuring(cond: Boolean): TestActorRef[T]

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

  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. final def equals(that: Any): Boolean

    Permalink
    Definition Classes
    ActorRef → AnyRef → Any

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestActorRef[T] to StringFormat[TestActorRef[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  21. def forward(message: Any)(implicit context: ActorContext): Unit

    Permalink
    Definition Classes
    ActorRef

  22. def getChild(names: Iterator[String]): InternalActorRef

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  24. def getParent: InternalActorRef

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  25. def getSingleChild(name: String): InternalActorRef

    Permalink
    Definition Classes
    LocalActorRef → ActorRefWithCell

  26. final def hashCode(): Int

    Permalink
    Definition Classes
    ActorRef → AnyRef → Any

  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  28. final def isLocal: Boolean

    Permalink
    Definition Classes
    LocalRef → ActorRefScope

  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  30. def newActorCell(system: ActorSystemImpl, ref: InternalActorRef, props: Props, dispatcher: MessageDispatcher, supervisor: InternalActorRef): ActorCell

    Permalink
    Attributes
    protected
    Definition Classes
    TestActorRef → LocalActorRef

  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  33. val path: ActorPath

    Permalink
    Definition Classes
    LocalActorRef → ActorRef

  34. val props: Props

    Permalink

  35. def provider: ActorRefProvider

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  36. def receive(o: Any, sender: ActorRef): Unit

    Permalink

    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.

  37. def receive(o: Any): Unit

    Permalink

    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.

  38. def restart(cause: Throwable): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  39. def resume(causedByFailure: Throwable): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  40. def sendSystemMessage(message: SystemMessage): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  41. def start(): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  42. def stop(): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  43. def suspend(): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  45. final def tell(msg: Any, sender: ActorRef): Unit

    Permalink
    Definition Classes
    ActorRef

  46. def toString(): String

    Permalink
    Definition Classes
    TestActorRef → ActorRef → AnyRef → Any

  47. def underlying: ActorCell

    Permalink
    Definition Classes
    LocalActorRef → ActorRefWithCell

  48. def underlyingActor: T

    Permalink

    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.

  49. def unwatch(subject: ActorRef): ActorRef

    Permalink

    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

  50. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  51. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  52. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  53. def watch(subject: ActorRef): ActorRef

    Permalink

    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

  54. def writeReplace(): AnyRef

    Permalink
    Attributes
    protected
    Definition Classes
    LocalActorRef
    Annotations
    @throws( ... )

  55. def →[B](y: B): (TestActorRef[T], B)

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

Shadowed Implicit Value Members

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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

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

    Permalink
    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

  8. def toString(): String

    Permalink
    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

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 any2stringadd[TestActorRef[T]]

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

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

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

Ungrouped