Module eredis_sub
Data Types
<a name="type-channel">channel()</a>
<code>channel() = binary()</code>
<a name="type-option">option()</a>
<code>option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer() | string()} | {password, string()} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]}</code>
<a name="type-options">options()</a>
<code>options() = [<a href="#type-option">option()</a>]</code>
<a name="type-reconnect_sleep">reconnect_sleep()</a>
<code>reconnect_sleep() = no_reconnect | integer()</code>
Function Index
Function Details
ack_message/1
<code>ack_message(Client::pid()) -> ok</code>
acknowledge the receipt of a pubsub message. each pubsub message must be acknowledged before the next one is received
channels/1
channels(Client) -> any()
Returns the channels the given client is currently subscribing to. Note: this list is based on the channels at startup and any channel added during runtime. It might not immediately reflect the channels Redis thinks the client is subscribed to.
controlling_process/1
<code>controlling_process(Client::pid()) -> ok</code>
Make the calling process the controlling process. The controlling process received pubsub-related messages, of which there are three kinds. In each message, the pid refers to the eredis client process.
{message, Channel::binary(), Message::binary(), pid()} This is sent for each pubsub message received by the client.
{pmessage, Pattern::binary(), Channel::binary(), Message::binary(), pid()} This is sent for each pattern pubsub message received by the client.
{dropped, NumMessages::integer(), pid()} If the queue reaches the max size as specified in start_link and the behaviour is to drop messages, this message is sent when the queue is flushed.
{subscribed, Channel::binary(), pid()} When using eredis_sub:subscribe(pid()), this message will be sent for each channel Redis aknowledges the subscription. The opposite, 'unsubscribed' is sent when Redis aknowledges removal of a subscription.
{eredis_disconnected, pid()} This is sent when the eredis client is disconnected from redis.
{eredis_connected, pid()} This is sent when the eredis client reconnects to redis after an existing connection was disconnected.
Any message of the form {message, , , _} must be acknowledged before any subsequent message of the same form is sent. This prevents the controlling process from being overrun with redis pubsub messages. See ack_message/1.
controlling_process/2
<code>controlling_process(Client::pid(), Pid::pid()) -> ok</code>
Make the given process (pid) the controlling process.
controlling_process/3
controlling_process(Client, Pid, Timeout) -> any()
Make the given process (pid) the controlling process subscriber with the given Timeout.
psubscribe/2
<code>psubscribe(Client::pid(), Channels::[<a href="#type-channel">channel()</a>]) -> ok</code>
Pattern subscribe to the given channels. Returns immediately. The result will be delivered to the controlling process as any other message. Delivers {subscribed, Channel::binary(), pid()}
punsubscribe/2
<code>punsubscribe(Client::pid(), Channels::[<a href="#type-channel">channel()</a>]) -> ok</code>
start_link/0
start_link() -> any()
start_link/1
<code>start_link(Args::<a href="#type-options">options()</a>) -> {ok, Pid::pid()} | {error, Reason::term()}</code>
Callback for starting from poolboy
start_link/3
start_link(Host, Port, Password) -> any()
start_link/6
start_link(Host, Port, Password, ReconnectSleep, MaxQueueSize, QueueBehaviour) -> any()
stop/1
stop(Pid) -> any()
subscribe/2
<code>subscribe(Client::pid(), Channels::[<a href="#type-channel">channel()</a>]) -> ok</code>
Subscribe to the given channels. Returns immediately. The result will be delivered to the controlling process as any other message. Delivers {subscribed, Channel::binary(), pid()}
unsubscribe/2
<code>unsubscribe(Client::pid(), Channels::[<a href="#type-channel">channel()</a>]) -> ok</code>