<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.time-nanosleep" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>time_nanosleep</refname>
  <refpurpose>Delay for a number of seconds and nanoseconds</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>bool</type></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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>seconds</parameter></term>
     <listitem>
      <para>
       Must be a non-negative integer.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>nanoseconds</parameter></term>
     <listitem>
      <para>
       Must be a non-negative integer less than 1 billion.
      </para>
      <note>
       <simpara>
        On Windows, the system may sleep longer that the given number of nanoseconds,
        depending on the hardware.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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 role="examples">
  &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, 500000000)) {
    echo "Slept for half a second.\n";
}

// This is better:
if (time_nanosleep(0, 500000000) === 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 microseconds.\n";
} elseif ($nano === false) {
    echo "Sleeping failed.\n";
} elseif (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>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sleep</function></member>
    <member><function>usleep</function></member>
    <member><function>time_sleep_until</function></member>
    <member><function>set_time_limit</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
-->
