Stoker behaviour (stoker v0.1.1)

Documentation for Stoker.

Summary

Functions

Hello world.

Types

Link to this type

activator_state()

@type activator_state() :: :master | :watcher | :cluster_change | :timer | :shutdown

Callbacks

Link to this callback

cluster_valid?(stoker_state)

@callback cluster_valid?(stoker_state :: term()) :: :yes | :no
Link to this callback

event(activator_state, reason, state)

@callback event(activator_state(), reason :: term(), state :: term()) ::
  {:ok, new_state :: term()} | {:error, reason :: term()}
@callback init() :: {:ok, stoker_state :: term()} | {:error, reason :: term()}
Link to this callback

next_timer_in(stoker_state)

@callback next_timer_in(stoker_state :: term()) :: integer() | :none

Functions

Hello world.

Examples

iex> Stoker.hello()
:world