Cizen

Cizen.SagaRegistry (Cizen v0.18.1) View Source

A key-value saga storage.

It works like Registry.

Link to this section Summary

Types

dispatcher()
entry()
guards()
key()
registry()
value()

Functions

child_spec(options)

See Registry.child_spec/1.

count(registry)

See Registry.count/1.

dispatch(registry, key, mfa_or_fun, opts \\ [])
keys(registry, saga_id)
lookup(registry, key)
meta(registry, key)

See Registry.meta/2.

put_meta(registry, key, value)

See Registry.put_meta/3.

register(registry, saga_id, key, value)
start_link(options)

See Registry.start_link/1.

unregister(registry, saga_id, key)
update_value(registry, saga_id, key, callback)

Link to this section Types

Link to this type

dispatcher()

View Source

Specs

dispatcher() :: ([entry()] -> term()) | {module(), atom(), [any()]}
Link to this type

entry()

View Source

Specs

entry() :: {Cizen.SagaID.t(), value()}
Link to this type

guards()

View Source

Specs

guards() :: Registry.guards()
Link to this type

key()

View Source

Specs

key() :: Registry.key()
Link to this type

registry()

View Source

Specs

registry() :: Registry.registry()
Link to this type

value()

View Source

Specs

value() :: Registry.value()

Link to this section Functions

Link to this function

child_spec(options)

View Source

See Registry.child_spec/1.

Link to this function

count(registry)

View Source

See Registry.count/1.

Link to this function

dispatch(registry, key, mfa_or_fun, opts \\ [])

View Source

Specs

dispatch(registry(), key(), dispatcher(), keyword()) :: :ok
Link to this function

keys(registry, saga_id)

View Source

Specs

keys(registry(), Cizen.SagaID.t()) :: [value()]
Link to this function

lookup(registry, key)

View Source

Specs

lookup(registry(), key()) :: [entry()]
Link to this function

meta(registry, key)

View Source

See Registry.meta/2.

Link to this function

put_meta(registry, key, value)

View Source

See Registry.put_meta/3.

Link to this function

register(registry, saga_id, key, value)

View Source

Specs

register(registry(), Cizen.SagaID.t(), key(), value()) ::
  {:ok, pid()}
  | {:error, {:already_registered, Cizen.SagaID.t()}}
  | {:error, :no_saga}
Link to this function

start_link(options)

View Source

See Registry.start_link/1.

Link to this function

unregister(registry, saga_id, key)

View Source

Specs

unregister(registry(), Cizen.SagaID.t(), key()) :: :ok | {:error, :no_saga}
Link to this function

update_value(registry, saga_id, key, callback)

View Source

Specs

update_value(registry(), Cizen.SagaID.t(), key(), (value() -> value())) ::
  {new_value :: term(), old_value :: term()} | {:error, :no_saga}