Document interaction of bgworkers with LISTEN/NOTIFY.

robertmhaas · robertmhaas · commit dde5f09fad3a · 2015-11-06T00:31:46.000-05:00
Thomas Munro and Robert Haas, reviewed by Haribabu Kommi
diff --git a/doc/src/sgml/bgworker.sgml b/doc/src/sgml/bgworker.sgml
@@ -277,6 +277,18 @@ typedef struct BackgroundWorker
    <literal>BGWH_POSTMASTER_DIED</literal>.
   </para>
 
+  <para>
+   If a background worker sends asynchronous notifications with the
+   <command>NOTIFY</command> command via the Server Programming Interface
+   (<acronym>SPI</acronym>), it should call
+   <function>ProcessCompletedNotifies</function> explicitly after committing
+   the enclosing transaction so that any notifications can be delivered.  If a
+   background worker registers to receive asynchronous notifications with
+   the <command>LISTEN</command> through <acronym>SPI</acronym>, the worker
+   will log those notifications, but there is no programmatic way for the
+   worker to intercept and respond to those notifications.
+  </para>
+
   <para>
    The <filename>worker_spi</> contrib module contains a working example,
    which demonstrates some useful techniques.
