mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Update ext/pcntl methodsynopses based on stubs
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de> Closes GH-600.
This commit is contained in:
Máté Kocsis
Christoph M. Becker
parent
5aff4add61
commit
b890f28c0c
15 changed files with 162 additions and 110 deletions
|
|
@ -1,6 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.pcntl-async-signals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>pcntl_async_signals</refname>
|
||||
|
|
@ -9,12 +8,12 @@
|
|||
|
||||
<refsect1 role="description"><!-- {{{ -->
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="procedural">
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>pcntl_async_signals</methodname>
|
||||
<methodparam choice="opt"><type>bool</type><parameter>on</parameter><initializer>&null;</initializer></methodparam>
|
||||
<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
If the <parameter>on</parameter> parameter is omitted,
|
||||
If the <parameter>enable</parameter> parameter is &null;,
|
||||
<function>pcntl_async_signals</function> returns whether asynchronous signal
|
||||
handling is enabled. Otherwise, asynchronous signal handling is enabled or
|
||||
disabled.
|
||||
|
|
@ -25,7 +24,7 @@
|
|||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>on</parameter></term>
|
||||
<term><parameter>enable</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Whether asynchronous signal handling should be enabled.
|
||||
|
|
@ -38,13 +37,35 @@
|
|||
<refsect1 role="returnvalues"><!-- {{{ -->
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
When used as getter (that is without the optional parameter) it returns
|
||||
whether asynchronous signal handling is enabled. When used as setter (that is
|
||||
with the optional parameter given), it returns whether asynchronous signal
|
||||
When used as getter (<parameter>enable</parameter> parameter is &null;) it returns
|
||||
whether asynchronous signal handling is enabled. When used as setter (<parameter>enable</parameter>
|
||||
parameter is not &null;), it returns whether asynchronous signal
|
||||
handling was enabled <emphasis>before</emphasis> the function call.
|
||||
</para>
|
||||
</refsect1><!-- }}} -->
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>8.0.0</entry>
|
||||
<entry>
|
||||
<parameter>enable</parameter> is nullable now.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso"><!-- {{{ -->
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
|
|
@ -53,7 +74,6 @@
|
|||
</refsect1><!-- }}} -->
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id='function.pcntl-exec' xmlns="http://docbook.org/ns/docbook">
|
||||
<refentry xml:id="function.pcntl-exec" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>pcntl_exec</refname>
|
||||
<refpurpose>Executes specified program in current process space</refpurpose>
|
||||
|
|
@ -9,10 +9,10 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>pcntl_exec</methodname>
|
||||
<type>bool</type><methodname>pcntl_exec</methodname>
|
||||
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter>envs</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter>args</parameter><initializer>[]</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter>env_vars</parameter><initializer>[]</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Executes the program with the given arguments.
|
||||
|
|
@ -44,10 +44,10 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>envs</parameter></term>
|
||||
<term><parameter>env_vars</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<parameter>envs</parameter> is an array of strings which are passed as
|
||||
<parameter>env_vars</parameter> is an array of strings which are passed as
|
||||
environment to the program. The array is in the format of name => value,
|
||||
the key being the name of the environmental variable and the value being
|
||||
the value of that variable.
|
||||
|
|
@ -61,12 +61,11 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.nullorfalse;
|
||||
Returns &false;.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id='function.pcntl-getpriority' xmlns="http://docbook.org/ns/docbook">
|
||||
<refentry xml:id="function.pcntl-getpriority" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>pcntl_getpriority</refname>
|
||||
<refpurpose>Get the priority of any process</refpurpose>
|
||||
|
|
@ -9,13 +9,13 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_getpriority</methodname>
|
||||
<methodparam choice="opt"><type>int</type><parameter>pid</parameter><initializer>getmypid()</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>process_identifier</parameter><initializer>PRIO_PROCESS</initializer></methodparam>
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>pcntl_getpriority</methodname>
|
||||
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>process_id</parameter><initializer>&null;</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PRIO_PROCESS</constant></initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>pcntl_getpriority</function> gets the priority of
|
||||
<parameter>pid</parameter>. Because priority levels can differ between
|
||||
<parameter>process_id</parameter>. Because priority levels can differ between
|
||||
system types and kernel versions, please see your system's getpriority(2)
|
||||
man page for specific details.
|
||||
</para>
|
||||
|
|
@ -26,15 +26,15 @@
|
|||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pid</parameter></term>
|
||||
<term><parameter>process_id</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If not specified, the pid of the current process is used.
|
||||
If &null;, the pid of the current process is used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>process_identifier</parameter></term>
|
||||
<term><parameter>mode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
One of <constant>PRIO_PGRP</constant>, <constant>PRIO_USER</constant>
|
||||
|
|
@ -56,6 +56,28 @@
|
|||
&return.falseproblem;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>8.0.0</entry>
|
||||
<entry>
|
||||
<parameter>process_id</parameter> is nullable now.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
|
|
@ -66,7 +88,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id='function.pcntl-setpriority' xmlns="http://docbook.org/ns/docbook">
|
||||
<refentry xml:id="function.pcntl-setpriority" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>pcntl_setpriority</refname>
|
||||
<refpurpose>Change the priority of any process</refpurpose>
|
||||
|
|
@ -11,12 +11,12 @@
|
|||
<methodsynopsis>
|
||||
<type>bool</type><methodname>pcntl_setpriority</methodname>
|
||||
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>pid</parameter><initializer>getmypid()</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>process_identifier</parameter><initializer>PRIO_PROCESS</initializer></methodparam>
|
||||
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>process_id</parameter><initializer>&null;</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PRIO_PROCESS</constant></initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>pcntl_setpriority</function> sets the priority of
|
||||
<parameter>pid</parameter>.
|
||||
<parameter>process_id</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -38,15 +38,15 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>pid</parameter></term>
|
||||
<term><parameter>process_id</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If not specified, the pid of the current process is used.
|
||||
If &null;, the pid of the current process is used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>process_identifier</parameter></term>
|
||||
<term><parameter>mode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
One of <constant>PRIO_PGRP</constant>, <constant>PRIO_USER</constant>
|
||||
|
|
@ -65,6 +65,28 @@
|
|||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>8.0.0</entry>
|
||||
<entry>
|
||||
<parameter>process_id</parameter> is nullable now.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
|
|
@ -75,7 +97,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.pcntl-signal-get-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>pcntl_signal_get_handler</refname>
|
||||
|
|
@ -10,11 +9,11 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>mixed</type><methodname>pcntl_signal_get_handler</methodname>
|
||||
<methodparam><type>int</type><parameter>signo</parameter></methodparam>
|
||||
<type class="union"><type>callable</type><type>int</type></type><methodname>pcntl_signal_get_handler</methodname>
|
||||
<methodparam><type>int</type><parameter>signal</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The <function>pcntl_signal_get_handler</function> function will get the current handler for the specified <parameter>signo</parameter>.
|
||||
The <function>pcntl_signal_get_handler</function> function will get the current handler for the specified <parameter>signal</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -22,7 +21,7 @@
|
|||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>signo</parameter></term>
|
||||
<term><parameter>signal</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The signal number.
|
||||
|
|
@ -35,7 +34,8 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
This function may return an integer value that refers to <constant>SIG_DFL</constant> or <constant>SIG_IGN</constant>. If you set a custom handler a string value containing the function name is returned.
|
||||
This function may return an integer value that refers to <constant>SIG_DFL</constant> or <constant>SIG_IGN</constant>.
|
||||
If a custom handler has been set, that <type>callable</type> is returned.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -95,7 +95,6 @@ var_dump(pcntl_signal_get_handler(SIGUSR1)); // Outputs: int(1)
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -10,13 +10,13 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>pcntl_signal</methodname>
|
||||
<methodparam><type>int</type><parameter>signo</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>signal</parameter></methodparam>
|
||||
<methodparam><type class="union"><type>callable</type><type>int</type></type><parameter>handler</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>bool</type><parameter>restart_syscalls</parameter><initializer>&true;</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The <function>pcntl_signal</function> function installs a new
|
||||
signal handler or replaces the current signal handler for the signal indicated by <parameter>signo</parameter>.
|
||||
signal handler or replaces the current signal handler for the signal indicated by <parameter>signal</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -25,7 +25,7 @@
|
|||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>signo</parameter></term>
|
||||
<term><parameter>signal</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The signal number.
|
||||
|
|
@ -54,7 +54,7 @@
|
|||
</methodsynopsis>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>signo</parameter></term>
|
||||
<term><parameter>signal</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
The signal being handled.
|
||||
|
|
@ -202,7 +202,6 @@ echo "Done\n";
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -10,13 +10,13 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>pcntl_sigprocmask</methodname>
|
||||
<methodparam><type>int</type><parameter>how</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>set</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">oldset</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>signals</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">old_signals</parameter><initializer>&null;</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The <function>pcntl_sigprocmask</function> function adds, removes or sets blocked
|
||||
signals, depending on the <parameter>how</parameter> parameter.
|
||||
signals, depending on the <parameter>mode</parameter> parameter.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -25,7 +25,7 @@
|
|||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>how</parameter></term>
|
||||
<term><parameter>mode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Sets the behavior of <function>pcntl_sigprocmask</function>. Possible
|
||||
|
|
@ -42,7 +42,7 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>set</parameter></term>
|
||||
<term><parameter>signals</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List of signals.
|
||||
|
|
@ -50,10 +50,10 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>oldset</parameter></term>
|
||||
<term><parameter>old_signals</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The <parameter>oldset</parameter> parameter is set to an array
|
||||
The <parameter>old_signals</parameter> parameter is set to an array
|
||||
containing the list of the previously blocked signals.
|
||||
</para>
|
||||
</listitem>
|
||||
|
|
@ -98,7 +98,6 @@ pcntl_sigprocmask(SIG_UNBLOCK, array(SIGHUP), $oldset);
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_sigtimedwait</methodname>
|
||||
<methodparam><type>array</type><parameter>set</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">siginfo</parameter></methodparam>
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>pcntl_sigtimedwait</methodname>
|
||||
<methodparam><type>array</type><parameter>signals</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter><initializer>[]</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>seconds</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>nanoseconds</parameter><initializer>0</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
|
|
@ -29,7 +29,7 @@
|
|||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>set</parameter></term>
|
||||
<term><parameter>signals</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Array of signals to wait for.
|
||||
|
|
@ -37,10 +37,10 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>siginfo</parameter></term>
|
||||
<term><parameter>info</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The <parameter>siginfo</parameter> is set to an array containing
|
||||
The <parameter>info</parameter> is set to an array containing
|
||||
information about the signal. See
|
||||
<function>pcntl_sigwaitinfo</function>.
|
||||
</para>
|
||||
|
|
@ -69,7 +69,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
On success, <function>pcntl_sigtimedwait</function> returns a signal number.
|
||||
<function>pcntl_sigtimedwait</function> returns a signal number on success, &return.falseforfailure;.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -84,7 +84,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -9,13 +9,13 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_sigwaitinfo</methodname>
|
||||
<methodparam><type>array</type><parameter>set</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">siginfo</parameter></methodparam>
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>pcntl_sigwaitinfo</methodname>
|
||||
<methodparam><type>array</type><parameter>signals</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter><initializer>[]</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The <function>pcntl_sigwaitinfo</function> function suspends execution of the
|
||||
calling script until one of the signals given in <parameter>set</parameter>
|
||||
calling script until one of the signals given in <parameter>signals</parameter>
|
||||
are delivered. If one of the signal is already pending (e.g. blocked by
|
||||
<function>pcntl_sigprocmask</function>),
|
||||
<function>pcntl_sigwaitinfo</function> will return immediately.
|
||||
|
|
@ -27,7 +27,7 @@
|
|||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>set</parameter></term>
|
||||
<term><parameter>signals</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Array of signals to wait for.
|
||||
|
|
@ -35,10 +35,10 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>siginfo</parameter></term>
|
||||
<term><parameter>info</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The <parameter>siginfo</parameter> parameter is set to an array containing
|
||||
The <parameter>info</parameter> parameter is set to an array containing
|
||||
information about the signal.
|
||||
</para>
|
||||
<para>
|
||||
|
|
@ -84,7 +84,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
On success, <function>pcntl_sigwaitinfo</function> returns a signal number.
|
||||
Returns a signal number on success, or &false; on error.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -123,7 +123,6 @@ pcntl_sigwaitinfo(array(SIGHUP), $info);
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.pcntl-strerror" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>pcntl_strerror</refname>
|
||||
|
|
@ -10,8 +9,8 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type class="union"><type>string</type><type>false</type></type><methodname>pcntl_strerror</methodname>
|
||||
<methodparam><type>int</type><parameter>errno</parameter></methodparam>
|
||||
<type>string</type><methodname>pcntl_strerror</methodname>
|
||||
<methodparam><type>int</type><parameter>error_code</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
|
|
@ -25,7 +24,7 @@
|
|||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>errno</parameter></term>
|
||||
<term><parameter>error_code</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
|
|
@ -38,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns error description on success&return.falseforfailure;.
|
||||
Returns error description.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -50,7 +49,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id='function.pcntl-wait' xmlns="http://docbook.org/ns/docbook">
|
||||
<refentry xml:id="function.pcntl-wait" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>pcntl_wait</refname>
|
||||
<refpurpose>Waits on or returns the status of a forked child</refpurpose>
|
||||
|
|
@ -11,8 +11,8 @@
|
|||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_wait</methodname>
|
||||
<methodparam><type>int</type><parameter role="reference">status</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">rusage</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">resource_usage</parameter><initializer>[]</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
The wait function suspends execution of the current process until a
|
||||
|
|
@ -27,7 +27,7 @@
|
|||
<para>
|
||||
This function is equivalent to calling <function>pcntl_waitpid</function>
|
||||
with a <literal>-1</literal> <parameter>pid</parameter> and no
|
||||
<parameter>options</parameter>.
|
||||
<parameter>flags</parameter>.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
|
@ -53,18 +53,18 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>options</parameter></term>
|
||||
<term><parameter>flags</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If wait3 is available on your system (mostly BSD-style systems), you can
|
||||
provide the optional <parameter>options</parameter> parameter. If this
|
||||
provide the optional <parameter>flags</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></title>
|
||||
<title>Possible values for <parameter>flags</parameter></title>
|
||||
<tgroup cols="2">
|
||||
<tbody>
|
||||
<row>
|
||||
|
|
@ -117,7 +117,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -10,19 +10,19 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_waitpid</methodname>
|
||||
<methodparam><type>int</type><parameter>pid</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>process_id</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter role="reference">status</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">rusage</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter role="reference">resource_usage</parameter><initializer>[]</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Suspends execution of the current process until a child as specified by
|
||||
the <parameter>pid</parameter> argument has exited, or until a signal is
|
||||
the <parameter>process_id</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.
|
||||
</para>
|
||||
<para>
|
||||
If a child as requested by <parameter>pid</parameter> has already exited
|
||||
If a child as requested by <parameter>process_id</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
|
||||
|
|
@ -35,19 +35,19 @@
|
|||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pid</parameter></term>
|
||||
<term><parameter>process_id</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The value of <parameter>pid</parameter> can be one of the following:
|
||||
The value of <parameter>process_id</parameter> can be one of the following:
|
||||
<table>
|
||||
<title>possible values for <parameter>pid</parameter></title>
|
||||
<title>possible values for <parameter>process_id</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>.
|
||||
the absolute value of <parameter>process_id</parameter>.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
|
|
@ -68,7 +68,7 @@
|
|||
<entry><literal>> 0</literal></entry>
|
||||
<entry>
|
||||
wait for the child whose process ID is equal to the value of
|
||||
<parameter>pid</parameter>.
|
||||
<parameter>process_id</parameter>.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
|
|
@ -77,9 +77,9 @@
|
|||
</para>
|
||||
<note>
|
||||
<para>
|
||||
Specifying <literal>-1</literal> as the <parameter>pid</parameter> is
|
||||
Specifying <literal>-1</literal> as the <parameter>process_id</parameter> is
|
||||
equivalent to the functionality <function>pcntl_wait</function> provides
|
||||
(minus <parameter>options</parameter>).
|
||||
(minus <parameter>flags</parameter>).
|
||||
</para>
|
||||
</note>
|
||||
</listitem>
|
||||
|
|
@ -101,14 +101,14 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>options</parameter></term>
|
||||
<term><parameter>flags</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The value of <parameter>options</parameter> is the value of zero
|
||||
The value of <parameter>flags</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>
|
||||
<title>possible values for <parameter>flags</parameter></title>
|
||||
<tgroup cols="2">
|
||||
<tbody>
|
||||
<row>
|
||||
|
|
@ -160,7 +160,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_wexitstatus</methodname>
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>pcntl_wexitstatus</methodname>
|
||||
<methodparam><type>int</type><parameter>status</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
|
@ -36,7 +36,8 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the return code, as an integer.
|
||||
Returns the return code.
|
||||
If the functionality is not supported by the OS, &false; is returned.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -51,7 +52,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_wstopsig</methodname>
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>pcntl_wstopsig</methodname>
|
||||
<methodparam><type>int</type><parameter>status</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
|
@ -37,6 +37,7 @@
|
|||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the signal number.
|
||||
If the functionality is not supported by the OS, &false; is returned.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -51,7 +52,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>pcntl_wtermsig</methodname>
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>pcntl_wtermsig</methodname>
|
||||
<methodparam><type>int</type><parameter>status</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
|
@ -36,7 +36,8 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the signal number, as an integer.
|
||||
Returns the signal number.
|
||||
If the functionality is not supported by the OS, &false; is returned.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -52,7 +53,6 @@
|
|||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
|
|
|||
Loading…
Reference in a new issue