Postgrex v0.12.2 Postgrex.Notifications View Source

API for notifications (pub/sub) in Postgres.

Link to this section Summary

Functions

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

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

Start the notification connection process and connect to postgres

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

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

Link to this section Functions

Link to this function listen(pid, channel, opts \\ []) View Source
listen(pid, 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!(pid, 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.

Link to this function unlisten(pid, ref, opts \\ []) View Source
unlisten(pid, 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!(pid, reference, Keyword.t) :: :ok

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