sleep.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sleep" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sleep</refname>
  <refpurpose>Delay execution</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>sleep</methodname>
   <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Delays the program execution for the given number of
   <parameter>seconds</parameter>.
  </simpara>
  <note>
   <para>
    In order to delay program execution for a fraction of a second, use <function>usleep</function>
    as the <function>sleep</function> function expects an &integer;. For example, <code>sleep(0.25)</code> will
    pause program execution for <literal>0</literal> seconds.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>seconds</parameter></term>
     <listitem>
      <para>
       Halt time in seconds (must be greater than or equal to <literal>0</literal>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns zero on success.
  </para>
  <para>
   If the call was interrupted by a signal, <function>sleep</function> returns
   a non-zero value. On Windows, this value will always be
   <literal>192</literal> (the value of the
   <constant>WAIT_IO_COMPLETION</constant> constant within the Windows API).
   On other platforms, the return value will be the number of seconds left to
   sleep.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If the specified number of <parameter>seconds</parameter> is negative,
   this function will throw a <classname>ValueError</classname>.
  </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>
       The function throws a <classname>ValueError</classname> on negative <parameter>seconds</parameter>;
       previously, an <constant>E_WARNING</constant> was raised instead, and the function returned &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>sleep</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

// current time
echo date('h:i:s') . "\n";

// sleep for 10 seconds
sleep(10);

// wake up !
echo date('h:i:s') . "\n";

?>
]]>
    </programlisting>
    <para>
     This example will output (after 10 seconds)
    </para>
    <screen>
<![CDATA[
05:31:23
05:31:33
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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