Class FSMBase.State<TS, TD>

This captures all of the managed state of the FSM<TState, TData>: the state name, the state data, possibly custom timeout, stop reason, and replies accumulated while processing the last message.

Inheritance
object
FSMBase.State<TS, TD>
Implements
Inherited Members
Namespace: Akka.Actor
Assembly: Akka.dll
Syntax
public sealed class FSMBase.State<TS, TD> : IEquatable<FSMBase.State<TS, TD>>
Type Parameters
Name Description
TS

The name of the state
TD

The data of the state

Constructors

| Edit this page View Source

State(TS, TD, TimeSpan?, Reason, IReadOnlyList<object>, bool)

Initializes a new instance of the State

Declaration
public State(TS stateName, TD stateData, TimeSpan? timeout = null, FSMBase.Reason stopReason = null, IReadOnlyList<object> replies = null, bool notifies = true)
Parameters
Type Name Description
TS stateName

TBD
TD stateData

TBD
TimeSpan? timeout

TBD
FSMBase.Reason stopReason

TBD
IReadOnlyList<object> replies

TBD
bool notifies

TBD

Properties

| Edit this page View Source

Replies

Optional - the set of replies to send to subscribers.

Declaration
public IReadOnlyList<object> Replies { get; }
Property Value
Type Description
IReadOnlyList<object>
| Edit this page View Source

StateData

The data belonging to this sate

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

StateName

The name of this state

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

StopReason

Optional - the reason why we're stopping.

Declaration
public FSMBase.Reason StopReason { get; }
Property Value
Type Description
FSMBase.Reason
| Edit this page View Source

Timeout

Optional. The state timeout.

Declaration
public TimeSpan? Timeout { get; }
Property Value
Type Description
TimeSpan?

Methods

| Edit this page View Source

Equals(State<TS, TD>)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(FSMBase.State<TS, TD> other)
Parameters
Type Name Description
FSMBase.State<TS, TD> other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
| Edit this page View Source

ForMax(TimeSpan)

Modify the state transition descriptor to include a state timeout for the next state. This timeout overrides any default timeout set for the next state. Use MaxValue to cancel a timeout.

Declaration
public FSMBase.State<TS, TD> ForMax(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

TBD
Returns
Type Description
FSMBase.State<TS, TD>

TBD
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
| Edit this page View Source

Replying(object)

Send reply to sender of the current message, if available.

Declaration
public FSMBase.State<TS, TD> Replying(object replyValue)
Parameters
Type Name Description
object replyValue

TBD
Returns
Type Description
FSMBase.State<TS, TD>

TBD
| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides
| Edit this page View Source

Using(TD)

Modify state transition descriptor with new state data. The data will be set when transitioning to the new state.

Declaration
public FSMBase.State<TS, TD> Using(TD nextStateData)
Parameters
Type Name Description
TD nextStateData

TBD
Returns
Type Description
FSMBase.State<TS, TD>

TBD

Implements

Extension Methods