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 constructor(val eventAndArgument: EventAndArgument<*>, val processingResult: ProcessingResult)

RecordedEvents

class RecordedEvents constructor(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

StrictValidator

object StrictValidator : RestorationResultValidator

Does not allow warnings or failed processing results

WarningType

enum WarningType : Enum<WarningType>

Functions

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