Phoenix v0.13.0 → Overview → Phoenix → Socket

Phoenix.Socket

Summary
Types
Functions

Holds state for every channel pointing to its transport.

Socket Fields

assigns - The map of socket assigns, default: %{}
channel - The channel module where this socket originated
endpoint - The endpoint module where this socket originated
joined - If the socket has effectively joined the channel
pubsub_server - The registered name of the socket’s PubSub server
ref - The latest ref sent by the client
topic - The string topic, ie "rooms:123"
transport - The socket’s transport, ie: Phoenix.Transports.WebSocket
transport_pid - The pid of the socket’s transport process

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)

(function) # ↑

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)

(function) # ↑

Sets topic of socket.

Source