Cizen v0.7.1 API Reference

Modules

A saga framework to create an automaton

An event to perform an effect

A channel interferes messaging

An event to emit an event from a channel

An event to feed an event to a channel

The registry to store all sagas in Cizen

A logger to log Saga.Crashed events

The dispatcher

The effect behaviour

Handles effects

Creates a block which can perform effects

A convenience module to use effects

An effect to perform multiple effects

An effect to chain multiple effects

An effect to dispatch an event

An effect to end a saga

Hybrid module of Elixir.Map and Cizen.Effects.Map

An effect to transform the result of effect

An effect to monitor a saga

An effect to run a race for the given effects

An effect to receive an event which the saga is received

An effect to request

An effect to state an saga

An effect to subscribe messages

An event to end a saga

Helpers to handle events

A behaviour module to define an event filter

Create a new set of event body filters

Filter events

A dispatcher based on subscription with filter set

Push event to subscribers

An event to push an event from EventFilterDispatcher

An event to subscribe events

An event which is fired after subscription is created

A struct to represent event subscription

Each event has a unique saga-id

Send messages

Transmitter for messaging

An event to start monitering a saga

An event to tell the saga is down

An event body filter to filter MonitorSaga.Down by target_saga_id

An event to register a channel

An event to notify that RegisterChannel event is successfully handled

An event body filter to filter RegisterChannel.Registered by event_id

An event to request

An event to respond to a request

An event body filter to filter Response by the request event id

The request-response mediator saga

The worker of request-response mediator saga

The saga behaviour

A event fired on crash

A event fired to finish

A event fired on finish

A event fired on launch

An event body filter to filter Saga.Launced by saga id

A event fired on unlaunch

End a saga

A behaviour module to define an event filter

Create a new set of event body filters

Each saga has a unique saga-id

The core module to launch automata

The event to launch an saga

The event to unlaunch an saga

Monitors a saga and finishes when the saga finishes, crashes, or doesn’t exists

A key-value saga storage

Start a saga

An event to send message

An event to start a saga

An event body filter to filter StartSaga by saga struct

An event body filter to filter StartSaga by the module

An event to subscribe message

An event to notify that SubscribeMessage event is successfully handled

An event body filter to filter SubscribeMessage.Subscribed by event_id