mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
added missing waitpid macro functions
code examples are still missing and intro text needs more information git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@57973 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Daniel Beckham
parent
18a026d449
commit
9765ddf862
1 changed files with 319 additions and 123 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<reference id="ref.pcntl">
|
||||
<title>Process Control Functions</title>
|
||||
<titleabbrev>PCNTL</titleabbrev>
|
||||
|
|
@ -182,128 +182,6 @@ function sig_handler($signo) {
|
|||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-waitpid">
|
||||
<refnamediv>
|
||||
<refname>pcntl_waitpid</refname>
|
||||
<refpurpose>Waits on or returns the status of a forked child</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_waitpid</function></funcdef>
|
||||
<paramdef>int <parameter>pid</parameter></paramdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
<paramdef>int <parameter>options</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
The <function>pcntl_waitpid</function> function suspends execution
|
||||
of the current process until a child as specified by the
|
||||
<parameter>pid</parameter> argument 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 as requested by
|
||||
<parameter>pid</parameter> 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 waitpid(2) man page for specific
|
||||
details as to how waitpid works on your system.
|
||||
</para>
|
||||
<para>
|
||||
<function>pcntl_waitpid</function> returns the process ID of the
|
||||
child which exited, -1 on error or zero if WNOHANG was used and no
|
||||
child was available
|
||||
</para>
|
||||
<para>
|
||||
The value of <parameter>pid</parameter> can be one of the following:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>< -1</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
wait for any child process whose process group ID is equal to
|
||||
the absolute value of <parameter>pid</parameter>.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>-1</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
wait for any child process; this is the same behaviour that
|
||||
the wait function exhibits.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>0</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
wait for any child process whose process group ID is equal to
|
||||
that of the calling process.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>> 0</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
wait for the child whose process ID is equal to the value of
|
||||
<parameter>pid</parameter>.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<para>
|
||||
<function>pcntl_waitpid</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>
|
||||
<para>
|
||||
The value of <parameter>options</parameter> is the value of zero
|
||||
or more of the following two global constants
|
||||
<literal>OR</literal>ed together:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>WNOHANG</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
return immediately if no child has exited.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>WUNTRACED</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
return for children which are stopped, and whose status has
|
||||
not been reported.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<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> and
|
||||
<function>pcntl_wstopsig</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-signal">
|
||||
|
|
@ -340,6 +218,324 @@ function sig_handler($signo) {
|
|||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-waitpid">
|
||||
<refnamediv>
|
||||
<refname>pcntl_waitpid</refname>
|
||||
<refpurpose>Waits on or returns the status of a forked child</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_waitpid</function></funcdef>
|
||||
<paramdef>int <parameter>pid</parameter></paramdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
<paramdef>int <parameter>options</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
The <function>pcntl_waitpid</function> function suspends execution
|
||||
of the current process until a child as specified by the
|
||||
<parameter>pid</parameter> argument 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 as requested by
|
||||
<parameter>pid</parameter> 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 waitpid(2) man page for specific
|
||||
details as to how waitpid works on your system.
|
||||
</para>
|
||||
<para>
|
||||
<function>pcntl_waitpid</function> returns the process ID of the
|
||||
child which exited, -1 on error or zero if WNOHANG was used and no
|
||||
child was available
|
||||
</para>
|
||||
<para>
|
||||
The value of <parameter>pid</parameter> can be one of the following:
|
||||
<table>
|
||||
<title>possible values for <parameter>pid</parameter></title>
|
||||
<tgroup cols="2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><literal>< -1</literal></entry>
|
||||
<entry>
|
||||
wait for any child process whose process group ID is equal to
|
||||
the absolute value of <parameter>pid</parameter>.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><literal>-1</literal></entry>
|
||||
<entry>
|
||||
wait for any child process; this is the same behaviour that
|
||||
the wait function exhibits.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><literal>0</literal></entry>
|
||||
<entry>
|
||||
wait for any child process whose process group ID is equal to
|
||||
that of the calling process.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><literal>> 0</literal></entry>
|
||||
<entry>
|
||||
wait for the child whose process ID is equal to the value of
|
||||
<parameter>pid</parameter>.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
<para>
|
||||
<function>pcntl_waitpid</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>
|
||||
<para>
|
||||
The value of <parameter>options</parameter> is the value of zero
|
||||
or more of the following two global constants
|
||||
<literal>OR</literal>'ed together:
|
||||
<table>
|
||||
<title>possible values for <parameter>options</parameter></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>
|
||||
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> and
|
||||
<function>pcntl_wstopsig</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-wexitstatus">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wexitstatus</refname>
|
||||
<refpurpose>
|
||||
Returns the return code of a terminated child
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_wexitstatus</function></funcdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns the return code of a terminated child. This function is
|
||||
only useful if <function>pcntl_wifexited</function> returned
|
||||
&true;.
|
||||
</para>
|
||||
<para>
|
||||
The parameter <parameter>status</parameter> is the status
|
||||
parameter supplied to a successfull call to
|
||||
<function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>pcntl_waitpid</function> and
|
||||
<function>pcntl_wifexited</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-wifexited">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wifexited</refname>
|
||||
<refpurpose>
|
||||
Returns &true; if status code represents a successful exit
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_wifexited</function></funcdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns &true; if the child status code represents a successful
|
||||
exit.
|
||||
</para>
|
||||
<para>
|
||||
The parameter <parameter>status</parameter> is the status
|
||||
parameter supplied to a successfull call to
|
||||
<function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>pcntl_waitpid</function> and
|
||||
<function>pcntl_wexitstatus</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-wifsignaled">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wifsignaled</refname>
|
||||
<refpurpose>
|
||||
Returns &true; if status code represents a termination due to a
|
||||
signal
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_wifsignaled</function></funcdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns &true; if the child process exited because of a signal
|
||||
which was not caught.
|
||||
</para>
|
||||
<para>
|
||||
The parameter <parameter>status</parameter> is the status
|
||||
parameter supplied to a successfull call to
|
||||
<function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>pcntl_waitpid</function> and
|
||||
<function>pcntl_signal</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-wifstopped">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wifstopped</refname>
|
||||
<refpurpose>
|
||||
Returns &true; if child process is currently stopped
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_wifstopped</function></funcdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns &true; if the child process which caused the return is
|
||||
currently stopped; this is only possible if the call to
|
||||
<function>pcntl_waitpid</function> was done using the option
|
||||
<literal>WUNTRACED</literal>.
|
||||
</para>
|
||||
<para>
|
||||
The parameter <parameter>status</parameter> is the status
|
||||
parameter supplied to a successfull call to
|
||||
<function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-wstopsig">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wstopsig</refname>
|
||||
<refpurpose>
|
||||
Returns the signal which caused the child to stop
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_wstopsig</function></funcdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns the number of the signal which caused the child to stop.
|
||||
This function is only useful if
|
||||
<function>pcntl_wifstopped</function> returned &true;.
|
||||
</para>
|
||||
<para>
|
||||
The parameter <parameter>status</parameter> is the status
|
||||
parameter supplied to a successfull call to
|
||||
<function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>pcntl_waitpid</function> and
|
||||
<function>pcntl_wifstopped</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.pcntl-wtermsig">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wtermsig</refname>
|
||||
<refpurpose>
|
||||
Returns the signal which caused the child to terminate
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pcntl_wtermsig</function></funcdef>
|
||||
<paramdef>int <parameter>status</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns the number of the signal that caused the child process to
|
||||
terminate. This function is only useful if
|
||||
<function>pcntl_wifsignaled</function> returned &true;.
|
||||
</para>
|
||||
<para>
|
||||
The parameter <parameter>status</parameter> is the status
|
||||
parameter supplied to a successfull call to
|
||||
<function>pcntl_waitpid</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also <function>pcntl_waitpid</function>,
|
||||
<function>pcntl_signal</function> and
|
||||
<function>pcntl_wifsignaled</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
</reference>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
Loading…
Reference in a new issue