Packages
phoenix
0.6.1
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/transports/websocket.ex
defmodule Phoenix.Transports.WebSocket do
use Phoenix.Controller
use Phoenix.WebSocket
@moduledoc """
Handles WebSocket clients for the Channel Transport layer
## Configuration
By default, JSON encoding is used to broker messages to and from clients,
but the serializer is configurable via the Router's transport configuration:
config :my_app, MyApp.Router, transports: [
websocket_serializer: MySerializer
]
The `websocket_serializer` module needs only to implement the `encode!/1` and
`decode!/1` functions defined by the `Phoenix.Transports.Serializer` behaviour.
"""
alias Phoenix.Channel.Transport
alias Phoenix.Socket.Message
plug :action
def upgrade_conn(conn, _) do
put_private(conn, :phoenix_upgrade, {:websocket, __MODULE__}) |> halt
end
@doc """
Handles initalization of the websocket
"""
def ws_init(conn) do
router = router_module(conn)
serializer = Dict.fetch!(router.config(:transports), :websocket_serializer)
{:ok, %{router: router, sockets: HashDict.new, serializer: serializer}}
end
@doc """
Receives JSON encoded `%Phoenix.Socket.Message{}` from client and dispatches
to Transport layer
"""
def ws_handle(text, state = %{router: router, sockets: sockets, serializer: serializer}) do
text
|> serializer.decode!
|> Transport.dispatch(sockets, self, router)
|> case do
{:ok, sockets} -> %{state | sockets: sockets}
{:error, sockets, _reason} -> %{state | sockets: sockets}
end
end
@doc """
Receives `%Phoenix.Socket.Message{}` and sends encoded message JSON to client
"""
def ws_info(message = %Message{}, state = %{serializer: serializer}) do
reply(self, serializer.encode!(message))
state
end
@doc """
Handles Elixir messages sent to the socket process
Dispatches `"info"` event back through Tranport layer to all socket's channels
"""
def ws_info(data, state = %{sockets: sockets}) do
sockets = case Transport.dispatch_info(sockets, data) do
{:ok, socks} -> socks
{:error, socks, _reason} -> socks
end
%{state | sockets: sockets}
end
@doc """
Called on WS close. Dispatches the `leave` event back through Transport layer
"""
def ws_terminate(reason, %{sockets: sockets}) do
:ok = Transport.dispatch_leave(sockets, reason)
:ok
end
end