Wobserver v0.1.8 Wobserver.Web.ClientSocket behaviour View Source

Low level WebSocket handler

Connects to the Javascript websocket and parses all requests.

Example:

  defmodule Wobserver.Web.Client do
    use Wobserver.Web.ClientSocket

    alias Wobserver.System

    def client_init do
      {:ok, %{}}
    end

    def client_handle(:hello, state) do
      {:reply, :ehlo, state}
    end

    def client_info(:update, state) do
      {:noreply, state}
    end
  end

Link to this section Summary

Types

response()

Response to browser

Functions

parse_command(payload)

Parses the JSON payload to an atom command and map data

send_response(message, socket_state, req)

Send a JSON encoded to the websocket client

setup_proxy(proxy, state, req)

Sets up a websocket proxy to a given proxy

Callbacks

client_handle(arg0, any)

Handles messages coming from the WS client

client_info(any, any)

Handles messages coming from other processes

client_init()

Initalizes the WebSocket

Link to this section Types

response()

response ::
  {:reply, atom | [atom], any, any} |
  {:reply, atom | [atom], any} |
  {:noreply, any}

Response to browser.

Link to this section Functions

parse_command(payload)

parse_command(payload :: String.t) :: atom | {atom, any}

Parses the JSON payload to an atom command and map data.

send_response(message, socket_state, req)

send_response(message :: {:noreply, any} | {:reply, atom | [atom], any} | {:reply, atom | [atom], map | list | String.t | nil, any}, socket_state :: map, req :: :cowboy_req.req) ::
  {:reply, {:text, String.t}, :cowboy_req.req, map} |
  {:ok, :cowboy_req.req, map}

Send a JSON encoded to the websocket client.

The given message is JSON encoded (exception: :noreply). The socket_state is used updated to reflect changes made by the client. The cowboy req is returned untouched.

setup_proxy(proxy, state, req)

setup_proxy(proxy :: String.t, state :: map, req :: :cowboy_req.req) ::
  {:reply, {:text, String.t}, :cowboy_req.req, map} |
  {:ok, :cowboy_req.req, map}

Sets up a websocket proxy to a given proxy.

The state is modified to add in the new proxy, while req is returned untouched.

Link to this section Callbacks

client_handle(arg0, any)

client_handle(atom | {atom, any}, any) :: Wobserver.Web.ClientSocket.response

Handles messages coming from the WS client.

Return browser response.

client_info(any, any)

client_info(any, any) :: Wobserver.Web.ClientSocket.response

Handles messages coming from other processes.

Return browser response.

client_init()

client_init() :: {:ok, any} | {:ok, any, non_neg_integer}

Initalizes the WebSocket.

Return {:ok, initial state} or {:ok, initial state, socket timeout}.