Redix.PubSub.punsubscribe
You're seeing just the function
punsubscribe
, go back to Redix.PubSub module for more information.
Specs
punsubscribe(connection(), String.t() | [String.t()], subscriber()) :: :ok
Unsubscribes subscriber
from the given pattern or list of patterns.
This function basically "undoes" what psubscribe/3
does: it unsubscribes
subscriber
from the given pattern or list of patterns.
Upon successful unsubscription from each of the patterns
, a message will be
sent to subscriber
with the following form:
{:redix_pubsub, pid, ^subscription_ref, :punsubscribed, %{pattern: pattern}}
See the documentation for Redix.PubSub
for more information about the format
of messages.
Examples
iex> Redix.punsubscribe(conn, "foo_*", self())
:ok
iex> flush()
{:redix_pubsub, ^conn, ^subscription_ref, :punsubscribed, %{pattern: "foo_*"}}
:ok