public inbox for [email protected]  

help / color / mirror / Atom feed

From: Daniel Gustafsson <[email protected]>
To: pgsql-docs <[email protected]>
Subject: Document WaitForBackgroundWorkerShutdown and fix bgworker typo
Date: Fri, 9 Feb 2018 23:43:26 +0100
Message-ID: <[email protected]> (raw)

WaitForBackgroundWorkerShutdown() was added in 924bcf4f16d, but never
documented which seems like an oversight for such a useful function.  The
attached patch adds this to bgworker.sgml, and also fixes what I believe are
typos in the WaitForBackgroundWorkerStartup paragraph.

cheers ./daniel



Attachments:

  [application/octet-stream] bgworker.patch (2.2K, 2-bgworker.patch)
  download | inline diff:
From 2a67096e1f55b8f5489d6865c7ec3c86771500b4 Mon Sep 17 00:00:00 2001
From: Daniel Gustafsson <[email protected]>
Date: Fri, 9 Feb 2018 23:22:02 +0100
Subject: [PATCH] doc: Add WaitForBackgroundWorkerShutdown() to bgw docs

Commit 924bcf4f16d extended the background worker API with
WaitForBackgroundWorkerShutdown, but it was never added to the
documentation. Extend the bgworker docs, and also fix two small
spelling errors in the WaitForBackgroundWorkerStartup paragraph.
---
 doc/src/sgml/bgworker.sgml | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/bgworker.sgml b/doc/src/sgml/bgworker.sgml
index e490bb8750..099639964c 100644
--- a/doc/src/sgml/bgworker.sgml
+++ b/doc/src/sgml/bgworker.sgml
@@ -259,13 +259,24 @@ typedef struct BackgroundWorker
    <function>WaitForBackgroundWorkerStartup(<parameter>BackgroundWorkerHandle
    *handle</parameter>, <parameter>pid_t *</parameter>)</function> function.
    This function will block until the postmaster has attempted to start the
-   background worker, or until the postmaster dies.  If the background runner
-   is running, the return value will <literal>BGWH_STARTED</literal>, and
+   background worker, or until the postmaster dies.  If the background worker
+   is running, the return value will be <literal>BGWH_STARTED</literal>, and
    the PID will be written to the provided address.  Otherwise, the return
    value will be <literal>BGWH_STOPPED</literal> or
    <literal>BGWH_POSTMASTER_DIED</literal>.
   </para>
 
+  <para>
+   A process can also wait for a background worker to shut down, by using the
+   <function>WaitForBackgroundWorkerShutdown(<parameter>BackgroundWorkerHandle
+   *handle</parameter>)</function> function and pass the
+   <type>BackgroundWorkerHandle *</type> obtained at registration. This
+   function will block until the background worker exits, or the postmaster
+   dies.  When the background worker exits, the return value is
+   <literal>BGWH_STOPPED</literal>, if the postmaster dies it will return
+   <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
-- 
2.14.1.145.gb3622a4ee

view thread (3+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: Document WaitForBackgroundWorkerShutdown and fix bgworker typo
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox