documented pcntl_wait

added note in _waitpid


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152363 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kenneth Schwartz 2004-02-25 16:42:00 +00:00
parent 7119c570f4
commit 793326c28b
2 changed files with 49 additions and 3 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id='function.pcntl-wait'>
<refnamediv>
<refname>pcntl_wait</refname>
@ -14,7 +14,46 @@
<methodparam><type>int</type><parameter>&amp;status</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
The wait function suspends execution of the current process until a
child has exited, or until a signal is delivered whose action is to
terminate the current process or to call a signal handling function. If a
child has already exited by the time of the call (a so-called "zombie"
process), the function returns immediately. Any system resources used by
the child are freed. Please see your system's wait(2) man page for
specific details as to how wait works on your system.
</para>
<para>
<function>pcntl_wait</function> returns the process ID of the child which
exited.
</para>
<para>
<function>pcntl_wait</function> will store status information
in the <parameter>status</parameter> parameter which can be
evaluated using the following functions:
<function>pcntl_wifexited</function>,
<function>pcntl_wifstopped</function>,
<function>pcntl_wifsignaled</function>,
<function>pcntl_wexitstatus</function>,
<function>pcntl_wtermsig</function> and
<function>pcntl_wstopsig</function>.
</para>
<note>
<para>
This function is equivalent to calling <function>pcntl_waitpid</function>
with a <literal>-1</literal> <parameter>pid</parameter> and no
<parameter>options</parameter>.
</para>
</note>
<para>
See also <function>pcntl_fork</function>,
<function>pcntl_signal</function>,
<function>pcntl_wifexited</function>,
<function>pcntl_wifstopped</function>,
<function>pcntl_wifsignaled</function>,
<function>pcntl_wexitstatus</function>,
<function>pcntl_wtermsig</function>,
<function>pcntl_wstopsig</function> and
<function>pcntl_waitpid</function>.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pcntl.xml, last change in rev 1.1 -->
<refentry id="function.pcntl-waitpid">
<refnamediv>
@ -69,6 +69,13 @@
</tgroup>
</table>
</para>
<note>
<para>
Specifying <literal>-1</literal> as the <parameter>pid</parameter> is
equivalent to the functionality <function>pcntl_wait</function> provides
(minus <parameter>options</parameter>).
</para>
</note>
<para>
<function>pcntl_waitpid</function> will store status information
in the <parameter>status</parameter> parameter which can be