Cizen

v0.12.5

Cizen v0.12.5 Cizen.Saga behaviour View Source

The saga behaviour

Example 

defmodule SomeSaga do
  @behaviour Cizen.Saga
  defstruct []

  @impl true
  def init(_id, %__MODULE__{}) do
    saga
  end

  @impl true
  def handle_event(_id, _event, state) do
    state
  end
end

Link to this section Summary

Types

state()
t()

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

end_saga(id)
exit(id, reason, trace)
fork(saga)

Starts a saga which finishes when the current process exits

lazy_launch()
module(saga)

Returns the module for a saga

start_link(saga)

Starts a saga linked to the current process

start_saga(id, saga, lifetime)

Callbacks

handle_event(arg0, arg1, state)

Invoked when the saga receives an event

init(arg0, arg1)

Invoked when the saga is started. Saga.Started event will be dispatched after this callback

Link to this section Types

Link to this section Functions

Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function fork(saga) View Source 
fork(t()) :: Cizen.SagaID.t()

Starts a saga which finishes when the current process exits.

Link to this function module(saga) View Source 
module(t()) :: module()

Returns the module for a saga.

Link to this function start_link(saga) View Source 
start_link(t()) :: GenServer.on_start()

Starts a saga linked to the current process

Link to this function start_saga(id, saga, lifetime) View Source

Link to this section Callbacks

Link to this callback handle_event(arg0, arg1, state) View Source 
handle_event(Cizen.SagaID.t(), Cizen.Event.t(), state()) :: state()

Invoked when the saga receives an event.

Returned value will be used as the next state to pass handle_event/3 callback.

Link to this callback init(arg0, arg1) View Source 
init(Cizen.SagaID.t(), Cizen.Saga.t()) :: state()

Invoked when the saga is started. Saga.Started event will be dispatched after this callback.

Returned value will be used as the next state to pass handle_event/3 callback.