Cizen v0.12.1 Cizen.Automaton behaviour View Source

A saga framework to create an automaton.

Link to this section Summary

state()

Performs an effect

Invoked when the automaton is spawned. Saga.Started event will be dispatched after this callback

Invoked when last spawn/2 or yield/2 callback returns a next state

finish() :: {Cizen.Automaton, :finish}

state() :: term()

handle_event(id, event, state)

init(id, saga)

perform(id, effect)

Performs an effect.

perform/2 blocks the current block until the effect is resolved, and returns the result of the effect.

Note that perform/2 does not work only on the current process.

spawn(arg0, arg1)

spawn(Cizen.SagaID.t(), Cizen.Saga.t()) :: finish() | state()

Invoked when the automaton is spawned. Saga.Started event will be dispatched after this callback.

Returned value will be used as the next state to pass yield/2 callback. Returning Automaton.finish() will cause the automaton to finish.

If not defined, default implementation is used, and it passes the given saga struct to yield/2 callback.

yield(arg0, state)

yield(Cizen.SagaID.t(), state()) :: finish() | state()

Invoked when last spawn/2 or yield/2 callback returns a next state.

Returned value will be used as the next state to pass yield/2 callback. Returning Automaton.finish() will cause the automaton to finish.

If not defined, default implementation is used, and it returns Automaton.finish().