Buckaroo.Socket behaviour (buckaroo v0.3.2) View Source

A simple websocket implementation.

Link to this section Summary

Types

frame()

Websocket frames.

result(state)

Websocket callback result.

Callbacks

handle(frame, state)

Incoming frames.

info(any, state)

Incoming process messages.

init(conn, state)

Initialize the websocket.

terminate(reason, req, state)

Websocket termination.

Link to this section Types

frame()

Specs

frame() :: :ping | :pong | {:text | :binary | :ping | :pong, binary()}

Websocket frames.

Note that there is no need to send pong frames back as Cowboy does it automatically for you.

result(state)

Specs

result(state) ::
  {:ok, state}
  | {:ok, state, :hibernate}
  | {:reply, frame() | [frame()], state}
  | {:reply, frame() | [frame()], state, :hibernate}
  | {:stop, state}

Websocket callback result.

Link to this section Callbacks

handle(frame, state)

Specs

handle(frame(), state) :: result(state) when state: any()

Incoming frames.

info(any, state)

Specs

info(any(), state) :: result(state) when state: any()

Incoming process messages.

init(conn, state)

Specs

init(conn :: Plug.Conn.t(), state :: state) :: result(state) when state: any()

Initialize the websocket.

Passes the connection and the given state.

terminate(reason, req, state)

Specs

terminate(reason :: any(), req :: map(), state) :: :ok when state: any()

Websocket termination.