Returns a specification to start this module under a supervisor.

See Supervisor.

@spec init_run_state(pid(), Runbox.StateStore.ScheduleUtils.epoch_ms(), [
  {Runbox.StateStore.Entity.id(), Runbox.StateStore.Entity.state()}
]) :: {:ok, [Runbox.StateStore.Entity.t()]}

Initializes state store for new run with specified timestamp and entity definitions.

Arguments

• state_store_pid pid of StateStore
• timestamp - run start_from, this timestamp is used to calculate savepoint timestamps
• entity_defs - state entity definitions defined as list of {entity_id, entity_state}

@spec initialized?(pid()) :: boolean()

Returns true when state store was initialized.

Arguments

• state_store_pid pid of StateStore

@spec load_run_state(pid(), (entity_defs -> entity_defs)) ::
  {:ok, Runbox.StateStore.ScheduleUtils.epoch_ms(),
   [Runbox.StateStore.Entity.t()]}
  | {:error, term()}
  | {:error, :no_savepoint}
when entity_defs: [
       {Runbox.StateStore.Entity.id(), Runbox.StateStore.Entity.state()}
     ]

Loads run state for existing run.

Run state is loaded for already initialized run which has persisted at least one savepoint.

Arguments

• state_store_pid pid of StateStore
• update_fn - function which takes a keyword list [{Entity.id(), Entity.state()}] and can return an updated keyword list. Useful to upgrade state store contents between versions.

@spec save(Runbox.StateStore.Entity.t(), Runbox.StateStore.ScheduleUtils.epoch_ms()) ::
  :ok

Saves entity state to all savepoints responsible for given timestamp.

Arguments

• entity - contains state to be saved
• timestamp - timestamp associated with entity state

@spec start_link(run_id(), Runbox.StateStore.ScheduleUtils.schedule()) ::
  GenServer.on_start()

Starts state store for run with given run_id.