Packages
phoenix
0.2.10
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.8.0-rc.4
1.8.0-rc.3
1.8.0-rc.2
1.8.0-rc.1
1.8.0-rc.0
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.7.0-rc.3
1.7.0-rc.2
1.7.0-rc.1
1.7.0-rc.0
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.0
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.3
1.4.0-rc.2
1.4.0-rc.1
1.4.0-rc.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc.3
1.3.0-rc.2
1.3.0-rc.1
1.3.0-rc.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.1
1.2.0-rc.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.0
0.13.1
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Productive. Reliable. Fast. A productive web framework that does not compromise speed or maintainability.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/phoenix/socket/handler.ex
defmodule Phoenix.Socket.Handler do
@behaviour :cowboy_websocket_handler
alias Phoenix.Socket
alias Phoenix.Socket.Message
alias Phoenix.Channel
defmodule InvalidReturn do
defexception [:message]
def exception(msg) do
%InvalidReturn{message: "Invalid Handler return: #{inspect msg}"}
end
end
def init({:tcp, :http}, req, opts) do
{:upgrade, :protocol, :cowboy_websocket, req, opts}
end
def init({:ssl, :http}, req, opts) do
{:upgrade, :protocol, :cowboy_websocket, req, opts}
end
@doc """
Handles initalization of the websocket
Possible returns:
:ok
{:ok, req, state}
{:ok, req, state, timeout} # Timeout defines how long it waits for activity
from the client. Default: infinity.
"""
def websocket_init(_transport, req, opts) do
router = Dict.fetch! opts, :router
{:ok, req, %Socket{conn: req, pid: self, router: router}}
end
@doc """
Dispatches multiplexed socket message to Router and handles result
# Join Event
"join" events are specially treated.
When {:ok, socket} is returned from the Channel, the socket is subscribed
to the channel and authorized to pubsub on the channel/topic pair
When {:error, socket, reason} is returned, the socket is denied pubsub access
# Leave Event
"leave" events call the channels `leave/2` function only if the socket has
previously been authorized via `join/2`
# Arbitrary Events
Any other event calls the channel's `event/3` function, with the event
name as the first argument. Event handlers are only invoked if the socket
was previously authorized via `join/2`.
"""
def websocket_handle({:text, text}, _req, socket) do
msg = Message.parse!(text)
socket
|> Socket.set_current_channel(msg.channel, msg.topic)
|> dispatch(msg.event, msg.message)
end
defp dispatch(socket, "join", msg) do
socket
|> socket.router.match(:websocket, socket.channel, "join", msg)
|> handle_result("join")
end
defp dispatch(socket, event, msg) do
if Socket.authenticated?(socket, socket.channel, socket.topic) do
socket
|> socket.router.match(:websocket, socket.channel, event, msg)
|> handle_result(event)
else
handle_result({:error, socket, :unauthenticated}, event)
end
end
defp handle_result({:ok, socket}, "join") do
{:ok, socket.conn, Channel.subscribe(socket, socket.channel, socket.topic)}
end
defp handle_result(socket = %Socket{}, "leave") do
{:ok, socket.conn, Channel.unsubscribe(socket, socket.channel, socket.topic)}
end
defp handle_result(socket = %Socket{}, _event) do
{:ok, socket.conn, socket}
end
defp handle_result({:error, socket, _reason}, _event) do
{:ok, socket.conn, socket}
end
defp handle_result(bad_return, event) when event in ["join", "leave"] do
raise InvalidReturn, message: """
expected {:ok, %Socket{}} | {:error, %Socket{}, reason} got #{inspect bad_return}
"""
end
defp handle_result(bad_return, _event) do
raise InvalidReturn, message: """
expected %Socket{} got #{inspect bad_return}
"""
end
@doc """
Handles recieving messages from processes
"""
def info(_info, _req, state) do
{:ok, state}
end
def websocket_info({:reply, frame}, req, state) do
{:reply, frame, req, state}
end
def websocket_info(:shutdown, req, state) do
{:shutdown, req, state}
end
def websocket_info(:hibernate, req, state) do
{:ok, req, state, :hibernate}
end
def websocket_info(data, req, socket) do
Enum.each socket.channels, fn {channel, topic} ->
socket
|> Socket.set_current_channel(channel, topic)
|> socket.router.match(:websocket, channel, "info", data)
|> handle_result("info")
end
{:ok, req, socket}
end
@doc """
This is called right before the websocket is about to be closed.
Reason is defined as:
{:normal, :shutdown | :timeout} Called when erlang closes connection
{:remote, :closed} Called if client formally closes connection
{:remote, close_code(), binary()}
{:error, :badencoding | :badframe | :closed | atom()} Called for many reasons
tab closed, conn dropped.
"""
def websocket_terminate(reason, _req, socket) do
Enum.each socket.channels, fn {channel, topic} ->
socket
|> Socket.set_current_channel(channel, topic)
|> socket.router.match(:websocket, channel, "leave", reason: reason)
|> handle_result("leave")
end
:ok
end
@doc """
Sends a reply to the socket. Follow the cowboy websocket frame syntax
Frame is defined as
:close | :ping | :pong
{:text | :binary | :close | :ping | :pong, iodata()}
{:close, close_code(), iodata()}
Options:
:state
:hibernate # (true | false) if you want to hibernate the connection
close_code: 1000..4999
"""
def reply(socket, frame) do
send(socket.pid, {:reply, frame, socket})
end
@doc """
Terminates a connection.
"""
def terminate(socket) do
send(socket.pid, :shutdown)
end
@doc """
Hibernates the socket.
"""
def hibernate(socket) do
send(socket.pid, :hibernate)
end
end