danbeck Fri Sep 21 17:07:38 2001 EDT
Modified files:
/phpdoc/en/functions pcntl.xml
Log:
added missing waitpid macro functions
code examples are still missing and intro text
needs more information
Index: phpdoc/en/functions/pcntl.xml
diff -u phpdoc/en/functions/pcntl.xml:1.1 phpdoc/en/functions/pcntl.xml:1.2
--- phpdoc/en/functions/pcntl.xml:1.1 Fri Sep 14 16:57:26 2001
+++ phpdoc/en/functions/pcntl.xml Fri Sep 21 17:07:38 2001
@@ -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,7 +182,41 @@
</para>
</refsect1>
</refentry>
-
+
+
+ <refentry id="function.pcntl-signal">
+ <refnamediv>
+ <refname>pcntl_signal</refname>
+ <refpurpose>Installs a signal handler</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>bool <function>pcntl_signal</function></funcdef>
+ <paramdef>int <parameter>signo</parameter></paramdef>
+ <paramdef>mixed <parameter>handle</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ The <function>pcntl_signal</function> function installs a new
+ signal handler for the signal indicated by
+ <parameter>signo</parameter>. The signal handler is set to
+ <parameter>handler</parameter> which may be the name of a user
+ created function, or either of the two global constants SIG_IGN
+ or SIG_DFL.
+ </para>
+ <para>
+ <function>pcntl_signal</function> returns &true; on success or
+ &false; on failure.
+ </para>
+ <para>
+ See also <function>pcntl_fork</function> and
+ <function>pcntl_waitpid</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pcntl-waitpid">
<refnamediv>
@@ -218,44 +252,41 @@
</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>
+ <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
@@ -271,26 +302,27 @@
<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>
+ <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>,
@@ -306,35 +338,199 @@
</refentry>
- <refentry id="function.pcntl-signal">
+ <refentry id="function.pcntl-wexitstatus">
<refnamediv>
- <refname>pcntl_signal</refname>
- <refpurpose>Installs a signal handler</refpurpose>
+ <refname>pcntl_wexitstatus</refname>
+ <refpurpose>
+ Returns the return code of a terminated child
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>bool <function>pcntl_signal</function></funcdef>
- <paramdef>int <parameter>signo</parameter></paramdef>
- <paramdef>mixed <parameter>handle</parameter></paramdef>
+ <funcdef>int <function>pcntl_wexitstatus</function></funcdef>
+ <paramdef>int <parameter>status</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- The <function>pcntl_signal</function> function installs a new
- signal handler for the signal indicated by
- <parameter>signo</parameter>. The signal handler is set to
- <parameter>handler</parameter> which may be the name of a user
- created function, or either of the two global constants SIG_IGN
- or SIG_DFL.
+ Returns the return code of a terminated child. This function is
+ only useful if <function>pcntl_wifexited</function> returned
+ &true;.
</para>
<para>
- <function>pcntl_signal</function> returns &true; on success or
- &false; on failure.
+ 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_fork</function> and
+ 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>
