doma_chaperon v0.3.2

View Source Chaperon.Action.WebSocket (doma_chaperon v0.3.2)

Helper functions for creating WebSocket actions.

Link to this section Summary

Types

msg_type()

Functions

assign_for_action(session, action, ws_conn, ws_url)
close(options \\ [])

Returns a Chaperon.WebSocket.Close action with options.

connect(path, options \\ [])

Returns a Chaperon.WebSocket.Connect action for a given path.

delete_for_action(session, action)
for_action(session, action)
recv(options \\ [])

Returns a Chaperon.WebSocket.ReceiveMessage action with options.

reset_websockets(session)
send(message, options \\ [])

Returns a Chaperon.WebSocket.SendMessage action with a given message and options.

Link to this section Types

Link to this type

msg_type()

View Source 
@type msg_type() :: :text | :binary

Link to this section Functions

Link to this function

assign_for_action(session, action, ws_conn, ws_url)

View Source
Link to this function

close(options \\ [])

View Source

Returns a Chaperon.WebSocket.Close action with options.

Link to this function

connect(path, options \\ [])

View Source

Returns a Chaperon.WebSocket.Connect action for a given path.

Link to this function

delete_for_action(session, action)

View Source
Link to this function

for_action(session, action)

View Source
Link to this function

recv(options \\ [])

View Source

Returns a Chaperon.WebSocket.ReceiveMessage action with options.

options can include a result handler callback to be called once the message arrived.

Example:

Chaperon.Action.WebSocket.recv(with_result: fn (session, result) ->
  session
  |> Chaperon.Session.assign(ws_message: result)
end)
Link to this function

reset_websockets(session)

View Source
Link to this function

send(message, options \\ [])

View Source 
@spec send(any(), Keword.t()) :: Chaperon.Action.WebSocket.SendMessage.t()

Returns a Chaperon.WebSocket.SendMessage action with a given message and options.