Runbox.StateStore.Savepoint (runbox v26.0.0)

@type t() :: %Runbox.StateStore.Savepoint{
  entity_registry: %{
    required(Runbox.StateStore.Entity.id()) =>
      :not_set_yet | Runbox.StateStore.Entity.state()
  },
  stats: %{registered: integer(), saved: integer()},
  timestamp: Runbox.StateStore.ScheduleUtils.epoch_ms()
}

Functions

all_saved?(savepoint)

@spec all_saved?(t()) :: boolean()

Predicate returning true when all registered states has been saved.

entity_states(savepoint)

@spec entity_states(t()) :: [
  {Runbox.StateStore.Entity.id(), Runbox.StateStore.Entity.state()}
]

Returns entities with saved states.

new(entity_ids, timestamp)

@spec new([Runbox.StateStore.Entity.id()], Runbox.StateStore.ScheduleUtils.epoch_ms()) ::
  t()

Creates new savepoint with given timestamp and register entities.

registered_entities(savepoint)

@spec registered_entities(t()) :: [Runbox.StateStore.Entity.id()]

Returns all registered entity ids.

registered_entities_count(savepoint)

@spec registered_entities_count(t()) :: integer()

Returns registered entities count of given savepoint.

save(savepoint, entity_id, entity_state)

@spec save(t(), Runbox.StateStore.Entity.id(), Runbox.StateStore.Entity.state()) ::
  t()

Saves entity state in given savepoint.

timestamp(savepoint)

@spec timestamp(t()) :: Runbox.StateStore.ScheduleUtils.epoch_ms()

Returns savepoint timestamp.