mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
107 lines
3 KiB
XML
107 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.pcntl-sigtimedwait" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>pcntl_sigtimedwait</refname>
|
|
<refpurpose>Waits for signals, with a timeout</refpurpose>
|
|
</refnamediv>
|
|
|
|
<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>
|
|
<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>
|
|
<para>
|
|
The <function>pcntl_sigtimedwait</function> function operates in exactly
|
|
the same way as <function>pcntl_sigwaitinfo</function> except that it takes
|
|
two additional parameters, <parameter>seconds</parameter> and
|
|
<parameter>nanoseconds</parameter>, which enable an upper bound to be placed
|
|
on the time for which the script is suspended.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>set</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Array of signals to wait for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>siginfo</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>siginfo</parameter> is set to an array containing
|
|
informations about the signal. See
|
|
<function>pcntl_sigwaitinfo</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>seconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Timeout in seconds.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>nanoseconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Timeout in nanoseconds.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
On success, <function>pcntl_sigtimedwait</function> returns a signal number.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>pcntl_sigprocmask</function></member>
|
|
<member><function>pcntl_sigwaitinfo</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|