exredis v0.2.5 Exredis.Sub

Subscribe functions for exredis

Summary

Functions

Subscribe to a channel or channels by pattern

Disconnect from the Redis server

Subscribe to a channel or channels

Types

behaviour :: :drop | :exit
max_queue :: :infinity | integer
reconnect :: :no_reconnect | integer
start_link :: {:ok, pid} | {:error, term}

Functions

psubscribe(client, channel, term)

Specs

psubscribe(pid, binary | [binary], term) :: any

Subscribe to a channel or channels by pattern

  • psubscribe(client, "some_channel_*", fn(msg) -> ... end)
  • psubscribe(client, ["some_channel_*", "other_channel_*"], fn(msg) -> ... end)
start_link()
start_link(host, port, password \\ "", reconnect \\ :no_reconnect, max_queue \\ :infinity, behaviour \\ :drop)

Specs

start_link(binary, integer, binary, reconnect, max_queue, behaviour) :: start_link

Connect to the Redis server for subscribe to a channel

  • start_link
  • start_link("127.0.0.1", 6379)
  • start_link("127.0.0.1", 6379, "with_password")
start_using_connection_string(connection_string \\ "redis://127.0.0.1:6379", reconnect \\ :no_reconnect, max_queue \\ :infinity, behaviour \\ :drop)

Specs

start_using_connection_string(binary, reconnect, max_queue, behaviour) :: pid

Connect to the Redis server for subscribe to a channel using a connection string:

  • start_using_connection_string("redis://user:password@127.0.0.1:6379/0")
  • start_using_connection_string("redis://127.0.0.1:6379")

The database number is ignored.

Returns the pid of the connected client.

stop(client)

Specs

stop(pid) :: :ok

Disconnect from the Redis server:

  • stop(client)

Client is a pid getting from start command

subscribe(client, channel, term)

Specs

subscribe(pid, binary | [binary], term) :: any

Subscribe to a channel or channels

  • subscribe(client, "some_channel", fn(msg) -> ... end)
  • subscribe(client, ["some_channel", "other_channel"], fn(msg) -> ... end)