ASM.Extensions.PubSub.Adapter behaviour (ASM v0.9.2)

Copy Markdown View Source

Behaviour for PubSub adapter implementations.

Adapters encapsulate subscription and broadcast mechanics for a concrete backend (for example local Registry or Phoenix PubSub).

Summary

Types

state()

Callbacks

broadcast(state, t, term)
init(keyword)
subscribe(state, t)

Types

state()

@type state() :: term()

Callbacks

broadcast(state, t, term)

@callback broadcast(state(), String.t(), term()) :: :ok | {:error, ASM.Error.t() | term()}

init(keyword)

@callback init(keyword()) :: {:ok, state()} | {:error, ASM.Error.t() | term()}

subscribe(state, t)

@callback subscribe(state(), String.t()) :: :ok | {:error, ASM.Error.t() | term()}