kstatemachine/ru.nsk.kstatemachine.persistence

Package-level declarations

Types

object EmptyValidator : RestorationResultValidator

Completely skips validation

Watches all incoming events with purpose of repeating them later on clean (just constructed) StateMachine instance to reproduce exactly the same StateMachine state as before

Record

class Record(val eventAndArgument: EventAndArgument<*>, val processingResult: ProcessingResult)

RecordedEvents

class RecordedEvents(val structureHashCode: Int, val records: List<Record>)

This class is intended to be serialized by client code

RestorationResult

class RestorationResult

RestorationResultValidationException

class RestorationResultValidationException(val result: RestorationResult, message: String, cause: Throwable? = null) : RuntimeException

RestorationResultValidator

fun interface RestorationResultValidator

RestorationWarningException

class RestorationWarningException : RuntimeException

RestoredEventResult

class RestoredEventResult

SavedStateConfig

class SavedStateConfig(val structureHashCode: Int, val activeLeafStateNames: List<String>, val dataStateLastValues: Map<String, Any?>)

A constant-size snapshot of an active state configuration. Captured with captureSavedStateConfig and restored with restoreBySavedStateConfig. This type is for data serialization.

StrictValidator

object StrictValidator : RestorationResultValidator

Does not allow warnings or failed processing results

WarningType

enum WarningType : Enum<WarningType>

Functions

captureSavedStateConfig

fun StateMachine.captureSavedStateConfig(disableUndoEnabledCheck: Boolean = false): SavedStateConfig

Captures the current active state configuration of this machine as a SavedStateConfig snapshot.

restoreByRecordedEvents

suspend fun StateMachine.restoreByRecordedEvents(recordedEvents: RecordedEvents, muteListeners: Boolean = true, disableStructureHashCodeCheck: Boolean = false, validator: RestorationResultValidator = StrictValidator): RestorationResult

Processes RecordedEvents with purpose of restoring a StateMachine to a state configuration as it was before (when the record was made). Starts the StateMachine if necessary and returns RestorationResult allowing to inspect how the restoration was processed. Specified RestorationResultValidator will be called to validate the result so do not have to remember to perform validation of the RestorationResult.

restoreByRecordedEventsBlocking

fun StateMachine.restoreByRecordedEventsBlocking(recordedEvents: RecordedEvents, muteListeners: Boolean = true, disableStructureHashCodeCheck: Boolean = false)

Blocking restoreByRecordedEvents alternative

restoreBySavedStateConfig

suspend fun StateMachine.restoreBySavedStateConfig(savedStateConfig: SavedStateConfig, muteListeners: Boolean = true, disableStructureHashCodeCheck: Boolean = false)

Restores this machine to the state configuration described by savedStateConfig. Starts the machine if it is not already started.

restoreBySavedStateConfigBlocking

fun StateMachine.restoreBySavedStateConfigBlocking(savedStateConfig: SavedStateConfig, muteListeners: Boolean = true, disableStructureHashCodeCheck: Boolean = false)

Blocking analog of restoreBySavedStateConfig.