sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

- Document time_nanosleep(), with example.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165949 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Dave Barr 2004-08-10 18:45:07 +00:00
parent 545db1e5ab
commit edd777d73c
1 changed files with 81 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
reference/misc/functions/time-nanosleep.xml
View file

@ -1,22 +1,99 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.time-nanosleep">
<refnamediv>
<refname>time_nanosleep</refname>
<refpurpose>
Delay for a number of seconds and nano seconds
Delay for a number of seconds and nanoseconds
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>time_nanosleep</methodname>
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
<methodparam><type>int</type><parameter>nanoseconds</parameter></methodparam>
</methodsynopsis>
<para>
Delays program execution for the given number of
<parameter>seconds</parameter> and <parameter>nanoseconds</parameter>.
</para>
<para>
<parameter>seconds</parameter> must be a positive integer, and
<parameter>nanoseconds</parameter> must be a positive integer less than
1 billion.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
Returns &true; on success, &false; on failure.
</para>
<para>
If the delay was interrupted by a signal, an associative array will be
returned with the components:
<itemizedlist>
<listitem>
<simpara>
<literal>seconds</literal> - number of seconds remaining in
the delay
</simpara>
</listitem>
<listitem>
<simpara>
<literal>nanoseconds</literal> - number of nanoseconds
remaining in the delay
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>sleep</function>,
<function>usleep</function>,
<function>set_time_limit</function>
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<para>
<example>
<title><function>time_nanosleep</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Careful! This won't work as expected if an array is returned */
if (time_nanosleep(0, 500000)) {
echo "Slept for half a second.\n";
}
&warn.undocumented.func;
/* This is better: */
if (time_nanosleep(0, 500000) === true) {
echo "Slept for half a second.\n";
}
/* And this is the best: */
$nano = time_nanosleep(2, 100000);
if ($nano === true) {
echo "Slept for 2 seconds, 100 milliseconds.\n";
}
else if ($nano === false) {
echo "Sleeping failed.\n";
}
else if (is_array($nano)) {
$seconds = $nano['seconds'];
$nanoseconds = $nano['nanoseconds'];
echo "Interrupted by a signal.\n";
echo "Time remaining: $seconds seconds, $nanoseconds nanoseconds.";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>