Phoenix.Socket

Holds state for every channel pointing to its transport.

Socket Fields

Source

Summary

assign(socket, key, value)

Adds key/value pair to socket assigns

put_topic(socket, topic)

Sets topic of socket

Types

t :: %Phoenix.Socket{assigns: %{}, channel: atom, endpoint: atom, joined: boolean, pubsub_server: atom, ref: String.t, topic: String.t, transport: atom, transport_pid: pid}

Functions

assign(socket, key, value)

Adds key/value pair to socket assigns.

Examples

iex> socket.assigns[:token]
nil
iex> socket = assign(socket, :token, "bar")
iex> socket.assigns[:token]
"bar"
Source
put_topic(socket, topic)

Sets topic of socket.

Source