buckaroo v0.4.2

View Source Buckaroo.EventSource behaviour (buckaroo v0.4.2)

A simple SSE implementation.

Link to this section Summary

Types

event()

SSE event.

result(state)

SSE callback result.

Callbacks

info(any, state)

Incoming process messages.

init(conn, state)

Initialize the SSE.

terminate(reason, req, state)

SSE termination.

Link to this section Types

Link to this type

event()

View Source 
@type event() ::
  %{
    :data => binary(),
    optional(:id) => binary(),
    optional(:type) => binary(),
    optional(:retry) => pos_integer()
  }
  | binary()

SSE event.

Link to this type

result(state)

View Source 
@type result(state) ::
  {:ok, state}
  | {:ok, state, :hibernate}
  | {:reply, event() | [event()], state}
  | {:reply, event() | [event()], state, :hibernate}
  | {:stop, state}

SSE callback result.

Link to this section Callbacks

Link to this callback

info(any, state)

View Source 
@callback info(any(), state) :: result(state) when state: any()

Incoming process messages.

Link to this callback

init(conn, state)

View Source 
@callback init(conn :: Plug.Conn.t(), state :: state) :: result(state) when state: any()

Initialize the SSE.

Passes the connection and the given state.

Link to this callback

terminate(reason, req, state)

View Source 
@callback terminate(reason :: any(), req :: map(), state) :: :ok when state: any()

SSE termination.