mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-31 08:18:56 +00:00
72333363c2
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152394 c90b9560-bf6c-de11-be94-00142212c4b1
111 lines
4 KiB
XML
111 lines
4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<refentry id='function.pcntl-wait'>
|
|
<refnamediv>
|
|
<refname>pcntl_wait</refname>
|
|
<refpurpose>
|
|
Waits on or returns the status of a forked child
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>pcntl_wait</methodname>
|
|
<methodparam><type>int</type><parameter>&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
|
|
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, -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
|
|
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>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|