Class/Object

akka.testkit

TestFSMRef

Related Docs: object TestFSMRef | package testkit

Permalink

class TestFSMRef[S, D, T <: Actor] extends TestActorRef[T]

This is a specialized form of the TestActorRef with support for querying and setting the state of a FSM. Use a LoggingFSM with this class if you also need to inspect event traces.


val fsm = TestFSMRef(new Actor with LoggingFSM[Int, Null] {
    override def logDepth = 12
    startWith(1, null)
    when(1) {
      case Event("hello", _) => goto(2)
    }
    when(2) {
      case Event("world", _) => goto(1)
    }
  })
assert (fsm.stateName == 1)
fsm ! "hallo"
assert (fsm.stateName == 2)
assert (fsm.underlyingActor.getLog == IndexedSeq(FSMLogEntry(1, null, "hallo")))

Source
TestFSMRef.scala
Since

1.2

Linear Supertypes
TestActorRef[T], LocalActorRef, LocalRef, ActorRefScope, ActorRefWithCell, InternalActorRef, ScalaActorRef, ActorRef, Serializable, Serializable, Comparable[ActorRef], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestFSMRef
  2. TestActorRef
  3. LocalActorRef
  4. LocalRef
  5. ActorRefScope
  6. ActorRefWithCell
  7. InternalActorRef
  8. ScalaActorRef
  9. ActorRef
  10. Serializable
  11. Serializable
  12. Comparable
  13. AnyRef
  14. 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 TestFSMRef(system: ActorSystem, props: Props, supervisor: ActorRef, name: String)(implicit ev: <:<[T, FSM[S, D]])

    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 TestFSMRef[S, D, T] to any2stringadd[TestFSMRef[S, D, T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  5. def ->[B](y: B): (TestFSMRef[S, D, T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestFSMRef[S, D, T] to ArrowAssoc[TestFSMRef[S, D, 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 cancelTimer(name: String): Unit

    Permalink

    Proxy for akka.actor.FSM#cancelTimer.

  10. def children: Iterable[ActorRef]

    Permalink
    Definition Classes
    LocalActorRef → ActorRefWithCell

  11. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    ActorRef → Comparable

  13. val dispatcher: MessageDispatcher

    Permalink
    Definition Classes
    TestActorRef

  14. def ensuring(cond: (TestFSMRef[S, D, T]) ⇒ Boolean, msg: ⇒ Any): TestFSMRef[S, D, T]

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

  15. def ensuring(cond: (TestFSMRef[S, D, T]) ⇒ Boolean): TestFSMRef[S, D, T]

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

  16. def ensuring(cond: Boolean, msg: ⇒ Any): TestFSMRef[S, D, T]

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

  17. def ensuring(cond: Boolean): TestFSMRef[S, D, T]

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

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    ActorRef → AnyRef → Any

  20. def finalize(): Unit

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

  21. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    ActorRef

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

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

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

    Permalink
    Definition Classes
    AnyRef → Any

  25. def getParent: InternalActorRef

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  26. def getSingleChild(name: String): InternalActorRef

    Permalink
    Definition Classes
    LocalActorRef → ActorRefWithCell

  27. final def hashCode(): Int

    Permalink
    Definition Classes
    ActorRef → AnyRef → Any

  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  29. final def isLocal: Boolean

    Permalink
    Definition Classes
    LocalRef → ActorRefScope

  30. def isStateTimerActive: Boolean

    Permalink

    Proxy for akka.actor.FSM#isStateTimerActive.

  31. def isTimerActive(name: String): Boolean

    Permalink

    Proxy for akka.actor.FSM#isStateTimerActive.

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Attributes
    protected
    Definition Classes
    TestActorRef → LocalActorRef

  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  36. val path: ActorPath

    Permalink
    Definition Classes
    LocalActorRef → ActorRef

  37. val props: Props

    Permalink
    Definition Classes
    TestActorRef

  38. def provider: ActorRefProvider

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

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

    Definition Classes
    TestActorRef

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

    Definition Classes
    TestActorRef

  41. def restart(cause: Throwable): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  42. def resume(causedByFailure: Throwable): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  43. def sendSystemMessage(message: SystemMessage): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  44. def setState(stateName: S = fsm.stateName, stateData: D = fsm.stateData, timeout: FiniteDuration = null, stopReason: Option[Reason] = None): Unit

    Permalink

    Change FSM state; any value left out defaults to the current FSM state (timeout defaults to None).

    Change FSM state; any value left out defaults to the current FSM state (timeout defaults to None). This method is directly equivalent to a corresponding transition initiated from within the FSM, including timeout and stop handling.

  45. def setTimer(name: String, msg: Any, timeout: FiniteDuration, repeat: Boolean = false): Unit

    Permalink

    Proxy for akka.actor.FSM#setTimer.

  46. def start(): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  47. def stateData: D

    Permalink

    Get current state data of this FSM.

  48. def stateName: S

    Permalink

    Get current state name of this FSM.

  49. def stop(): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

  50. def suspend(): Unit

    Permalink
    Definition Classes
    LocalActorRef → InternalActorRef

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    ActorRef

  53. def toString(): String

    Permalink
    Definition Classes
    TestActorRef → ActorRef → AnyRef → Any

  54. def underlying: ActorCell

    Permalink
    Definition Classes
    LocalActorRef → ActorRefWithCell

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

    Definition Classes
    TestActorRef

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

    Definition Classes
    TestActorRef

  57. final def wait(): Unit

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

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

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

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

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

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

    Definition Classes
    TestActorRef

  61. def writeReplace(): AnyRef

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

  62. def →[B](y: B): (TestFSMRef[S, D, T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestFSMRef[S, D, T] to ArrowAssoc[TestFSMRef[S, D, 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 TestFSMRef[S, D, 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:
    (testFSMRef: 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 TestFSMRef[S, D, 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:
    (testFSMRef: 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 TestFSMRef[S, D, 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:
    (testFSMRef: 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 TestFSMRef[S, D, 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:
    (testFSMRef: ActorRef).forward(message)(context)
    Definition Classes
    ActorRef

  5. final def hashCode(): Int

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestFSMRef[S, D, 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:
    (testFSMRef: ActorRef).hashCode()
    Definition Classes
    ActorRef → AnyRef → Any

  6. def path: ActorPath

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestFSMRef[S, D, 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:
    (testFSMRef: 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 TestFSMRef[S, D, 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:
    (testFSMRef: ActorRef).tell(msg, sender)
    Definition Classes
    ActorRef

  8. def toString(): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestFSMRef[S, D, 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:
    (testFSMRef: ActorRef).toString()
    Definition Classes
    ActorRef → AnyRef → Any

Inherited from TestActorRef[T]

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 TestFSMRef[S, D, T] to ScalaActorRef

Inherited by implicit conversion scala2ActorRef from TestFSMRef[S, D, T] to ActorRef

Inherited by implicit conversion any2stringadd from TestFSMRef[S, D, T] to any2stringadd[TestFSMRef[S, D, T]]

Inherited by implicit conversion StringFormat from TestFSMRef[S, D, T] to StringFormat[TestFSMRef[S, D, T]]

Inherited by implicit conversion Ensuring from TestFSMRef[S, D, T] to Ensuring[TestFSMRef[S, D, T]]

Inherited by implicit conversion ArrowAssoc from TestFSMRef[S, D, T] to ArrowAssoc[TestFSMRef[S, D, T]]

Ungrouped