added info about wait3

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152364 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kenneth Schwartz 2004-02-25 17:02:53 +00:00
parent 793326c28b
commit b636aeb292

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id='function.pcntl-wait'>
<refnamediv>
<refname>pcntl_wait</refname>
@ -12,6 +12,7 @@
<methodsynopsis>
<type>int</type><methodname>pcntl_wait</methodname>
<methodparam><type>int</type><parameter>&amp;status</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
The wait function suspends execution of the current process until a
@ -23,8 +24,38 @@
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.
<function>pcntl_waitpid</function> returns the process ID of the
child which exited, -1 on error or zero if WNOHANG was provided as an
option (on wait3-available systems) and no child was available.
</para>
<para>
If wait3 is available on your system (mostly BSD-style systems), you can
provide the optional <parameter>options</parameter> parameter. If this
parameter is not provided, wait will be used for the system call. If
wait3 is not available, providing a value for <parameter>options
</parameter> will have no effect. The value of <parameter>options
</parameter> is the value of zero or more of the following two constants
<literal>OR</literal>'ed together:
<table>
<title>Possible values for <parameter>options</parameter> if wait3 is available</title>
<tgroup cols="2">
<tbody>
<row>
<entry><literal>WNOHANG</literal></entry>
<entry>
Return immediately if no child has exited.
</entry>
</row>
<row>
<entry><literal>WUNTRACED</literal></entry>
<entry>
Return for children which are stopped, and whose status has
not been reported.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<function>pcntl_wait</function> will store status information