stream-chat-android-core/io.getstream.chat.android.core.internal.fsm/FiniteStateMachine

FiniteStateMachine

class FiniteStateMachine<S : Any, E : Any>(initialState: S, stateFunctions: Map<KClass<out S>, Map<KClass<out E>, StateFunction<S, E>>>, defaultEventHandler: (S, E) -> S)

This class represents a Finite State Machine. It can be only in one possible state at a time out of the set of possible states S. It can handle events from the set E.

Parameters

initialState

The initial state.

Constructors

FiniteStateMachine

constructor(initialState: S, stateFunctions: Map<KClass<out S>, Map<KClass<out E>, StateFunction<S, E>>>, defaultEventHandler: (S, E) -> S)

Types

object Companion

Properties

val state: S

The current state.

val stateFlow: StateFlow<S>

The current state as StateFlow.

Functions

suspend fun sendEvent(event: E)

Sends an event to the state machine. The entry point to change state.

fun stay(): S

Keeps the FSM in its current state. Usually used when handling events that don't need to make a transition.