API Reference Cizen v0.17.0

Modules

A saga framework to create an automaton.

An event to perform an effect.

An event fired when an automaton yields new state.

The registry to store all sagas in Cizen.

A logger to log Saga.Crashed events.

The dispatcher.

The round-robin scheduler module that push an event to senders.

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.

An effect to state an saga.

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 resume a saga.

An effect to start a saga.

An effect to subscribe messages.

An event to end a saga.

Helpers to handle events

Each event has a unique saga-id.

Creates a filter.

An event to start monitering a saga.

An event to tell the saga is down.

An event to request.

An event to respond to a request.

An event to notify timeout.

The request-response mediator saga.

An event to resume a saga.

The saga behaviour

A event fired on crash

A event fired on end

A event fired to finish

A event fired on finish

A event fired on resume

A event fired on start

End a saga.

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.

Resume a saga.

Start a saga.

An event to send message.

An event to start a saga.

Conveniences for testing Cizen.