Commit a8860908 authored by Andres Freund's avatar Andres Freund

doc: Add WaitForBackgroundWorkerShutdown() to bgw docs.

Commit 924bcf4f added WaitForBackgroundWorkerShutdown, but didn't
add it to the documentation. Fix that and two small spelling errors in
the WaitForBackgroundWorkerStartup paragraph.

Author: Daniel Gustafsson
Discussion: https://postgr.es/m/C8738949-0350-4999-A1DA-26E209FF248D@yesql.se
parent 8c438fcc
...@@ -259,13 +259,24 @@ typedef struct BackgroundWorker ...@@ -259,13 +259,24 @@ typedef struct BackgroundWorker
<function>WaitForBackgroundWorkerStartup(<parameter>BackgroundWorkerHandle <function>WaitForBackgroundWorkerStartup(<parameter>BackgroundWorkerHandle
*handle</parameter>, <parameter>pid_t *</parameter>)</function> function. *handle</parameter>, <parameter>pid_t *</parameter>)</function> function.
This function will block until the postmaster has attempted to start the This function will block until the postmaster has attempted to start the
background worker, or until the postmaster dies. If the background runner background worker, or until the postmaster dies. If the background worker
is running, the return value will <literal>BGWH_STARTED</literal>, and is running, the return value will be <literal>BGWH_STARTED</literal>, and
the PID will be written to the provided address. Otherwise, the return the PID will be written to the provided address. Otherwise, the return
value will be <literal>BGWH_STOPPED</literal> or value will be <literal>BGWH_STOPPED</literal> or
<literal>BGWH_POSTMASTER_DIED</literal>. <literal>BGWH_POSTMASTER_DIED</literal>.
</para> </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 passing the
<type>BackgroundWorkerHandle *</type> obtained at registration. This
function will block until the background worker exits, or postmaster dies.
When the background worker exits, the return value is
<literal>BGWH_STOPPED</literal>, if postmaster dies it will return
<literal>BGWH_POSTMASTER_DIED</literal>.
</para>
<para> <para>
If a background worker sends asynchronous notifications with the If a background worker sends asynchronous notifications with the
<command>NOTIFY</command> command via the Server Programming Interface <command>NOTIFY</command> command via the Server Programming Interface
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment