KState/ca.acendas.kstate.core/StateMachine

StateMachine

interface StateMachine<S, E : StateEvent>

Interface for a state machine that manages state transitions through events.

A state machine provides controlled state management with event-driven transitions, lifecycle management, and observer notifications. This interface is designed to be coroutine-friendly while requiring zero external dependencies.

Parameters

The type of states in the state machine

The type of events that can trigger transitions

Inheritors

StateMachine

Properties

currentState

abstract val currentState: S

The current state of the state machine.

isRunning

abstract val isRunning: Boolean

True if the state machine is currently running (started and not stopped).

isStarted

abstract val isStarted: Boolean

True if the state machine has been started at least once.

observerCount

abstract val observerCount: Int

Returns the number of registered observers.

Functions

addObserver

abstract fun addObserver(observer: StateObserver<S>): Boolean

Adds an observer to receive state change notifications.

clearObservers

abstract fun clearObservers()

Removes all observers.

removeObserver

abstract fun removeObserver(observer: StateObserver<S>): Boolean

Removes an observer from receiving state change notifications.

send

abstract fun send(event: E): Boolean

Sends an event to the state machine for processing.

start

abstract fun start()

Starts the state machine.

stop

abstract fun stop()

Stops the state machine.