kfsm/io.jumpco.open.kfsm.async/AsyncStateMachineDefinition

AsyncStateMachineDefinition

class AsyncStateMachineDefinition<S, E, C, A, R>(val defaultInitialState: S?, deriveInitialState: StateQuery<C, S>?, deriveInitialMap: StateMapQuery<C, S>?, val defaultStateMap: AsyncStateMapDefinition<S, E, C, A, R>, val namedStateMaps: Map<String, AsyncStateMapDefinition<S, E, C, A, R>>)

Constructors

constructor(defaultInitialState: S?, deriveInitialState: StateQuery<C, S>?, deriveInitialMap: StateMapQuery<C, S>?, defaultStateMap: AsyncStateMapDefinition<S, E, C, A, R>, namedStateMaps: Map<String, AsyncStateMapDefinition<S, E, C, A, R>>)

Properties

defaultInitialState

val defaultInitialState: S?

defaultStateMap

val defaultStateMap: AsyncStateMapDefinition<S, E, C, A, R>

The top level state map will be created when the state machine is created.

namedStateMaps

val namedStateMaps: Map<String, AsyncStateMapDefinition<S, E, C, A, R>>

The named state maps can be accessed via a push transition.

Functions

create

fun create(context: C, coroutineScope: CoroutineScope, initial: S? = null): AsyncStateMachineInstance<S, E, C, A, R>

This function will create a state machine instance and set it to the initial state.

fun create(context: C, coroutineScope: CoroutineScope, initialExternalState: ExternalState<S>): AsyncStateMachineInstance<S, E, C, A, R>

This function will create a state machine instance and set it to the state to a previously externalised state.

possibleEvents

fun possibleEvents(state: S, includeDefault: Boolean): Set<E>

This function will provide a list of possible events given a specific state. The actual events may fail because of guard conditions or named state maps and the default state map behaviour being different.