Packages
phoenix
0.2.8
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/channel/channel.ex
defmodule Phoenix.Channel do
use Jazz
alias Phoenix.Topic
alias Phoenix.Socket
alias Phoenix.Socket.Handler
defmacro __using__(_options) do
quote do
import unquote(__MODULE__)
def leave(socket, message), do: socket
defoverridable leave: 2
@before_compile unquote(__MODULE__)
end
end
defmacro __before_compile__(_env) do
quote do
def event(socket, _event, _message), do: socket
end
end
@doc """
Subscribes socket to given channel topic
Returns %Socket{}
"""
def subscribe(socket, channel, topic) do
if !Socket.authenticated?(socket, channel, topic) do
Topic.subscribe(socket.pid, namespaced(channel, topic))
Socket.add_channel(socket, channel, topic)
else
socket
end
end
@doc """
Unsubscribes socket to given channel topic
Returns %Socket{}
"""
def unsubscribe(socket, channel, topic) do
Topic.unsubscribe(socket.pid, namespaced(channel, topic))
Socket.delete_channel(socket, channel, topic)
end
@doc """
Broadcast event, serializable as JSON to topic namedspaced by channel
Examples
iex> Channel.broadcast "rooms", "global", "new:message", id: 1, content: "hello"
:ok
iex> Channel.broadcast socket, "new:message", id: 1, content: "hello"
:ok
"""
def broadcast(channel, topic, event, message) when is_binary(channel) do
broadcast_from :global, channel, topic, event, message
end
def broadcast(socket, event, message) do
broadcast_from :global, socket.channel, socket.topic, event, message
end
def broadcast_from(socket = %Socket{}, event, message) do
broadcast_from(socket.pid, socket.channel, socket.topic, event, message)
end
def broadcast_from(from, channel, topic, event, message) do
Topic.create(namespaced(channel, topic))
Topic.broadcast_from(from, namespaced(channel, topic), reply_json_frame(
channel: channel,
topic: topic,
event: event,
message: Enum.into(message, %{})
))
end
@doc """
Sends Dict, JSON serializable message to socket
"""
def reply(socket, event, message) do
send socket.pid, reply_json_frame(
channel: socket.channel,
topic: socket.topic,
event: event,
message: Enum.into(message, %{})
)
socket
end
@doc """
Terminates socket connection, including all multiplexed channels
"""
def terminate(socket), do: Handler.terminate(socket)
@doc """
Hibernates socket connection
"""
def hibernate(socket), do: Handler.hibernate(socket)
@doc """
Converts Dict message into JSON text reply frame for Websocket Handler
"""
def reply_json_frame(message) do
{:reply, {:text, JSON.encode!(Enum.into(message, %{}))}}
end
defp namespaced(channel, topic), do: "#{channel}:#{topic}"
end