Class TestFSMRef<TActor, TState, TData>

This is a specialized form of the TestActorRef<TActor> with support for querying and setting the state of a FSM<TState, TData>.

Inheritance
object
TestActorRefBase<TActor>
TestFSMRef<TActor, TState, TData>
Implements
Inherited Members
Namespace: Akka.TestKit
Assembly: Akka.TestKit.dll
Syntax
public class TestFSMRef<TActor, TState, TData> : TestActorRefBase<TActor>, IActorRef, ICanTell, IEquatable<IActorRef>, IComparable<IActorRef>, ISurrogated, IComparable where TActor : FSM<TState, TData>
Type Parameters
Name Description
TActor

The type of the actor.
TState

The type of the state.
TData

The type of the data.

Constructors

| Edit this page View Source

TestFSMRef(ActorSystem, Props, IActorRef, string, bool)

TBD

Declaration
public TestFSMRef(ActorSystem system, Props props, IActorRef supervisor = null, string name = null, bool activateLogging = false)
Parameters
Type Name Description
ActorSystem system

TBD
Props props

TBD
IActorRef supervisor

TBD
string name

TBD
bool activateLogging

TBD

Properties

| Edit this page View Source

StateData

Get current state data of this FSM.

Declaration
public TData StateData { get; }
Property Value
Type Description
TData
| Edit this page View Source

StateName

Get current state name of this FSM.

Declaration
public TState StateName { get; }
Property Value
Type Description
TState

Methods

| Edit this page View Source

CancelTimer(string)

Proxy for CancelTimer(string)

Declaration
public void CancelTimer(string name)
Parameters
Type Name Description
string name

TBD
| Edit this page View Source

IsStateTimerActive()

Determines whether the FSM has a active state timer active.

Declaration
public bool IsStateTimerActive()
Returns
Type Description
bool

true if the FSM has a active state timer active; false otherwise
| Edit this page View Source

IsTimerActive(string)

Proxy for IsTimerActive(string)

Declaration
public bool IsTimerActive(string name)
Parameters
Type Name Description
string name

TBD
Returns
Type Description
bool

TBD
| Edit this page View Source

SetState(TState, TimeSpan?)

Change FSM state; but keeps the current state data. This method is directly equivalent to a transition initiated from within the FSM.

Declaration
public void SetState(TState stateName, TimeSpan? timeout = null)
Parameters
Type Name Description
TState stateName

TBD
TimeSpan? timeout

TBD
| Edit this page View Source

SetState(TState, TData, TimeSpan?, Reason)

Change FSM state. This method is directly equivalent to a corresponding transition initiated from within the FSM, including timeout and stop handling.

Declaration
public void SetState(TState stateName, TData stateData, TimeSpan? timeout = null, FSMBase.Reason stopReason = null)
Parameters
Type Name Description
TState stateName

TBD
TData stateData

TBD
TimeSpan? timeout

TBD
FSMBase.Reason stopReason

TBD
| Edit this page View Source

SetStateData(TData, TimeSpan?)

Change FSM state data; but do not transition to a new state name. This method is directly equivalent to a transition initiated from within the FSM.

Declaration
public void SetStateData(TData stateData, TimeSpan? timeout = null)
Parameters
Type Name Description
TData stateData

TBD
TimeSpan? timeout

TBD
| Edit this page View Source

SetStateTimeout(TimeSpan)

Change FSM state timeout. This method is directly equivalent to a transition initiated from within the FSM using the current state name and data but with the specified timeout.

Declaration
public void SetStateTimeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

TBD
| Edit this page View Source

SetTimer(string, object, TimeSpan, bool)

Proxy for SetTimer(string, object, TimeSpan, bool)

Declaration
public void SetTimer(string name, object msg, TimeSpan timeout, bool repeat = false)
Parameters
Type Name Description
string name

TBD
object msg

TBD
TimeSpan timeout

TBD
bool repeat

TBD

Implements

Extension Methods