php-doc-en/reference/pcntl/functions/pcntl-alarm.xml
Kenneth Schwartz 7119c570f4 added missing pcntl functions
documented _alarm (bug #21694), working on the rest


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152361 c90b9560-bf6c-de11-be94-00142212c4b1
2004-02-25 16:00:11 +00:00

50 lines
1.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id='function.pcntl-alarm'>
<refnamediv>
<refname>pcntl_alarm</refname>
<refpurpose>
Set an alarm clock for delivery of a signal
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pcntl_alarm</methodname>
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
</methodsynopsis>
<para>
The <function>pcntl_alarm</function> function creates a timer that will
send a <literal>SIGALARM</literal> signal to the process after
<parameter>seconds</parameter> seconds. If <parameter>seconds</parameter>
is zero, no new alarm is created. Any call to <function>pcntl_alarm</function>
will cancel any previously set alarm.
</para>
<para>
<function>pcntl_alarm</function> will return the time in seconds that any
previously scheduled alarm had remaining before it was to be delivered, or
<literal>0</literal> if there was no previously scheduled alarm.
</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
-->