riverside v2.2.1

Riverside.Connection (riverside v2.2.1)

Link to this section Summary

Types

shutdown_reason()
t()

Functions

init(req, opts)

Callback implementation for :cowboy_websocket.init/2.

new(handler, user_id, session_id, peer, handler_state)
terminate(reason, req, state)

Callback implementation for :cowboy_websocket.terminate/3.

websocket_handle(event, state)

Callback implementation for :cowboy_websocket.websocket_handle/2.

websocket_info(event, state)

Callback implementation for :cowboy_websocket.websocket_info/2.

websocket_init(state)

Callback implementation for :cowboy_websocket.websocket_init/1.

Link to this section Types

Link to this type

shutdown_reason()

Specs

shutdown_reason() :: :too_many_messages
Link to this type

t()

Specs

t() :: %Riverside.Connection{
  handler: module(),
  handler_state: any(),
  session: Riverside.Session.t(),
  shutdown_reason: shutdown_reason() | nil
}

Link to this section Functions

Link to this function

init(req, opts)

Callback implementation for :cowboy_websocket.init/2.

Link to this function

new(handler, user_id, session_id, peer, handler_state)

Specs

new(
  handler :: module(),
  user_id :: Riverside.Session.user_id(),
  session_id :: Riverside.Session.session_id(),
  peer :: Riverside.PeerAddress.t(),
  handler_state :: any()
) :: t()
Link to this function

terminate(reason, req, state)

Callback implementation for :cowboy_websocket.terminate/3.

Link to this function

websocket_handle(event, state)

Callback implementation for :cowboy_websocket.websocket_handle/2.

Link to this function

websocket_info(event, state)

Callback implementation for :cowboy_websocket.websocket_info/2.

Link to this function

websocket_init(state)

Callback implementation for :cowboy_websocket.websocket_init/1.