kfsm/io.jumpco.open.kfsm.async/AsyncStateMapInstance

AsyncStateMapInstance

class AsyncStateMapInstance<S, E, C, A, R>(val context: C, val newState: S, val name: String?, val parentFsm: AsyncStateMachineInstance<S, E, C, A, R>, val definition: AsyncStateMapDefinition<S, E, C, A, R>, val coroutineScope: CoroutineScope)

Constructors

AsyncStateMapInstance

constructor(context: C, newState: S, name: String?, parentFsm: AsyncStateMachineInstance<S, E, C, A, R>, definition: AsyncStateMapDefinition<S, E, C, A, R>, coroutineScope: CoroutineScope)

Properties

val coroutineScope: CoroutineScope

var currentState: S

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

val name: String?

val newState: S

val parentFsm: AsyncStateMachineInstance<S, E, C, A, R>

val timers: MutableList<AsyncTimer<S, E, C, A, R>>

Functions

fun allowed(includeDefaults: Boolean = false): Set<E>

This function will provide the list of allowed events given the current state of the machine.

fun eventAllowed(event: E, includeDefault: Boolean): Boolean

This function will provide an indication whether the given event is allowed in the current state.

suspend fun sendEvent(event: E, arg: A? = null): R?

This function will process the on and advance the state machine according to the FSM definition.