1
0
mirror of https://github.com/postgres/postgres.git synced 2025-06-25 01:02:05 +03:00

doc: Add missing words to bgworker docs.

Maciek Sakrejda
This commit is contained in:
Robert Haas
2013-10-04 11:13:50 -04:00
parent 0f1ef79095
commit 4655b607f3

View File

@ -31,7 +31,7 @@
<para> <para>
Background workers can be initialized at the time that Background workers can be initialized at the time that
<productname>PostgreSQL</> is started including the module name in <productname>PostgreSQL</> is started by including the module name in
<varname>shared_preload_libraries</>. A module wishing to run a background <varname>shared_preload_libraries</>. A module wishing to run a background
worker can register it by calling worker can register it by calling
<function>RegisterBackgroundWorker(<type>BackgroundWorker *worker</type>)</function> <function>RegisterBackgroundWorker(<type>BackgroundWorker *worker</type>)</function>
@ -179,10 +179,10 @@ typedef struct BackgroundWorker
When a background worker is registered using the When a background worker is registered using the
<function>RegisterDynamicBackgroundWorker</function> function, it is <function>RegisterDynamicBackgroundWorker</function> function, it is
possible for the backend performing the registration to obtain information possible for the backend performing the registration to obtain information
the status of the worker. Backends wishing to do this should pass the regarding the status of the worker. Backends wishing to do this should
address of a <type>BackgroundWorkerHandle *</type> as the second argument pass the address of a <type>BackgroundWorkerHandle *</type> as the second
to <function>RegisterDynamicBackgroundWorker</function>. If the worker argument to <function>RegisterDynamicBackgroundWorker</function>. If the
is successfully registered, this pointer will be initialized with an worker is successfully registered, this pointer will be initialized with an
opaque handle that can subsequently be passed to opaque handle that can subsequently be passed to
<function>GetBackgroundWorkerPid(<parameter>BackgroundWorkerHandle *</parameter>, <parameter>pid_t *</parameter>)</function>. <function>GetBackgroundWorkerPid(<parameter>BackgroundWorkerHandle *</parameter>, <parameter>pid_t *</parameter>)</function>.
This function can be used to poll the status of the worker: a return This function can be used to poll the status of the worker: a return