Class PersistentFSM.State<TS, TD, TE>

Inheritance
Object
PersistentFSM.State<TS, TD, TE>
Inherited Members
Namespace: Akka.Persistence.Fsm
Assembly: Akka.Persistence.dll
Syntax
public class State<TS, TD, TE>
Type Parameters
Name Description
TS
TD
TE

Constructors

| Improve this Doc View Source

State(TS, TD, Nullable<TimeSpan>, FSMBase.Reason, IReadOnlyList<Object>, IReadOnlyList<TE>, Action<TD>, Boolean)

Initializes a new instance of the PersistentFSM.State<TS, TD, TE>

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

TBD
TD stateData

TBD
Nullable<TimeSpan> timeout

TBD
FSMBase.Reason stopReason

TBD
IReadOnlyList<Object> replies

TBD
IReadOnlyList<TE> domainEvents

TBD
Action<TD> afterTransitionDo
Boolean notifies

TBD

Properties

| Improve this Doc View Source

AfterTransitionDo

TBD

Declaration
public Action<TD> AfterTransitionDo { get; }
Property Value
Type Description
Action<TD>
| Improve this Doc View Source

DomainEvents

TBD

Declaration
public IReadOnlyList<TE> DomainEvents { get; }
Property Value
Type Description
IReadOnlyList<TE>
| Improve this Doc View Source

Replies

TBD

Declaration
public IReadOnlyList<object> Replies { get; protected set; }
Property Value
Type Description
IReadOnlyList<Object>
| Improve this Doc View Source

StateData

TBD

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

StateName

TBD

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

StopReason

TBD

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

Timeout

TBD

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

Methods

| Improve this Doc View Source

AndThen(Action<TD>)

Register a handler to be triggered after the state has been persisted successfully

Declaration
public PersistentFSM.State<TS, TD, TE> AndThen(Action<TD> handler)
Parameters
Type Name Description
Action<TD> handler

TBD
Returns
Type Description
PersistentFSM.State<TS, TD, TE>

TBD
| Improve this Doc View Source

Applying(TE[])

Specify domain events to be applied when transitioning to the new state.

Declaration
public PersistentFSM.State<TS, TD, TE> Applying(params TE[] events)
Parameters
Type Name Description
TE[] events

TBD
Returns
Type Description
PersistentFSM.State<TS, TD, TE>

TBD
| Improve this Doc 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 PersistentFSM.State<TS, TD, TE> ForMax(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

TBD
Returns
Type Description
PersistentFSM.State<TS, TD, TE>

TBD
| Improve this Doc View Source

Replying(Object)

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

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

TBD
Returns
Type Description
PersistentFSM.State<TS, TD, TE>

TBD
| Improve this Doc View Source

ToString()

TBD

Declaration
public override string ToString()
Returns
Type Description
String

TBD
Overrides
| Improve this Doc View Source

Using(TD)

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

Declaration
[Obsolete("Internal API easily to be confused with regular FSM's using. Use regular events (`Applying`). Internally, `copy` can be used instead.")]
public PersistentFSM.State<TS, TD, TE> Using(TD nextStateData)
Parameters
Type Name Description
TD nextStateData

TBD
Returns
Type Description
PersistentFSM.State<TS, TD, TE>

TBD

Extension Methods