Packages
phoenix
0.8.0
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/pubsub.ex
defmodule Phoenix.PubSub do
use GenServer
alias Phoenix.PubSub.Server
@moduledoc """
Serves as a Notification and PubSub layer for broad use-cases. Used internally
by Channels for pubsub broadcast.
## Example
iex> PubSub.subscribe(self, "user:123")
:ok
iex> Process.info(self)[:messages]
[]
iex> PubSub.subscribers("user:123")
[#PID<0.169.0>]
iex> PubSub.broadcast "user:123", {:user_update, %{id: 123, name: "Shane"}}
:ok
iex> Process.info(self)[:messages]
{:user_update, %{id: 123, name: "Shane"}}
"""
@server Phoenix.PubSub.Server
@pg_prefix :phx
@doc """
Creates a topic for pubsub broadcast to subscribers
* topic_name - The String name of the topic
## Examples
iex> PubSub.create("mytopic")
:ok
"""
def create(topic_name) do
:ok = call {:create, group(topic_name)}
end
@doc """
Checks if a given topic is registered as a process group
"""
def exists?(topic_name) do
call {:exists?, group(topic_name)}
end
@doc """
Removes topic from process group if inactive
## Examples
iex> PubSub.delete("mytopic")
:ok
iex> PubSub.delete("activetopic")
{:error, :active}
"""
def delete(topic_name) do
call {:delete, group(topic_name)}
end
@doc """
Adds subsriber pid to the given topic
* pid - The Pid of the subscriber
* topic_name - The String name of the topic
## Examples
iex> PubSub.subscribe(self, "mytopic")
"""
def subscribe(pid, topic_name) do
:ok = create(topic_name)
call {:subscribe, pid, group(topic_name)}
end
@doc """
Removes the given subscriber from the topic
* pid - The Pid of the subscriber
* topic_name - The String name of the topic
## Examples
iex> PubSub.unsubscribe(self, "mytopic")
"""
def unsubscribe(pid, topic_name) do
call {:unsubscribe, pid, group(topic_name)}
end
@doc """
Returns the List of subsriber pids for the give topic
## Examples
iex> PubSub.subscribers("mytopic")
[]
iex> PubSub.subscribe(self, "mytopic")
:ok
iex> PubSub.subscribers("mytopic")
[#PID<0.41.0>]
"""
def subscribers(topic_name) do
case :pg2.get_members(group(topic_name)) do
{:error, {:no_such_group, _}} -> []
members -> members
end
end
@doc """
Broadcasts a message to the topic's subscribers
* topic_name - The String name of the topic
* message - The term to broadcast
## Examples
iex> PubSub.broadcast("mytopic", :hello)
To exclude the broadcaster from receiving the message, use `broadcast_from/3`
"""
def broadcast(topic_name, message) do
broadcast_from(:global, topic_name, message)
end
@doc """
Broadcasts a message to the topics's subscribers, excluding
broadcaster from receiving the message it sent out
* topic_name - The String name of the topic
* message - The term to broadcast
## Examples
iex> PubSub.broadcast_from(self, "mytopic", :hello)
"""
def broadcast_from(from_pid, topic_name, message) do
topic_name
|> subscribers
|> Enum.each fn
pid when pid != from_pid -> send(pid, message)
_pid ->
end
end
@doc """
Check if PubSub is active. To be active it must be created and have subscribers
"""
def active?(topic_name) do
call {:active?, group(topic_name)}
end
@doc """
Returns a List of all Phoenix PubSubs from :pg2
"""
def list do
:pg2.which_groups |> Enum.filter(&match?({@pg_prefix, _}, &1))
end
defp call(message), do: GenServer.call(Server.leader_pid, message)
defp group(topic_name), do: {@pg_prefix, topic_name}
end