php-doc-en/reference/misc/functions/usleep.xml

121 lines
2.7 KiB
XML
Raw Permalink Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.usleep" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>usleep</refname>
<refpurpose>Delay execution in microseconds</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>usleep</methodname>
<methodparam><type>int</type><parameter>microseconds</parameter></methodparam>
</methodsynopsis>
<para>
Delays program execution for the given number of microseconds.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>microseconds</parameter></term>
<listitem>
<para>
Halt time in microseconds. A microsecond is one millionth of a
second.
</para>
2021-03-03 13:40:16 +00:00
<note>
<simpara>
Values larger than <literal>1000000</literal> (i.e. sleeping for more than a second)
may not be supported by the operating system. Use <function>sleep</function> instead.
</simpara>
</note>
<note>
<simpara>
On Windows, the system may sleep longer that the given number of microseconds,
depending on the hardware.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>usleep</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Current time
echo date('h:i:s') . "\n";
// wait for 2 seconds
usleep(2000000);
// back!
echo date('h:i:s') . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
11:13:28
11:13:30
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sleep</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
-->