Postgrex

v0.14.3

Postgrex v0.14.3 Postgrex.Notifications View Source

API for notifications (pub/sub) in Postgres.

Link to this section Summary

Types

server()

Functions

listen(pid, channel, opts \\ [])

Listens to an asynchronous notification channel using the LISTEN command. A message {:notification, connection_pid, ref, channel, payload} will be sent to the calling process when a notification is received.

listen!(pid, channel, opts \\ [])

Listens to an asynchronous notification channel channel. See listen/2.

start_link(opts)

Start the notification connection process and connect to postgres.

unlisten(pid, ref, opts \\ [])

Stops listening on the given channel by passing the reference returned from listen/2.

unlisten!(pid, ref, opts \\ [])

Stops listening on the given channel by passing the reference returned from listen/2.

Link to this section Types

Link to this type

server() View Source 
server() :: GenServer.server()

Link to this section Functions

Link to this function

listen(pid, channel, opts \\ []) View Source 
listen(server(), String.t(), Keyword.t()) :: {:ok, reference()}

Listens to an asynchronous notification channel using the LISTEN command. A message {:notification, connection_pid, ref, channel, payload} will be sent to the calling process when a notification is received.

Options

  • :timeout - Call timeout (default: 5000)
Link to this function

listen!(pid, channel, opts \\ []) View Source 
listen!(server(), String.t(), Keyword.t()) :: reference()

Listens to an asynchronous notification channel channel. See listen/2.

Link to this function

start_link(opts) View Source 
start_link(Keyword.t()) :: {:ok, pid()} | {:error, Postgrex.Error.t() | term()}

Start the notification connection process and connect to postgres.

The option that this function accepts are exactly the same accepted by Postgrex.start_link/1. Note :sync_connect defaults to true.

Link to this function

unlisten(pid, ref, opts \\ []) View Source 
unlisten(server(), reference(), Keyword.t()) :: :ok

Stops listening on the given channel by passing the reference returned from listen/2.

Options

  • :timeout - Call timeout (default: 5000)
Link to this function

unlisten!(pid, ref, opts \\ []) View Source 
unlisten!(server(), reference(), Keyword.t()) :: :ok

Stops listening on the given channel by passing the reference returned from listen/2.