cvs: phpdoc /en/reference/misc/functions time-sleep-until.xml

nlopess Sun May 8 06:06:51 2005 EDT Added files: /phpdoc/en/reference/misc/functions time-sleep-until.xml Log: new function http://cvs.php.net/co.php/phpdoc/en/reference/misc/functions/time-sleep-until.xml?r=1.1&p=1 Index: phpdoc/en/reference/misc/functions/time-sleep-until.xml +++ phpdoc/en/reference/misc/functions/time-sleep-until.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.time-sleep-until"> <refnamediv> <refname>time_sleep_until</refname> <refpurpose> Make the script sleep until the specified time </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>time_sleep_until</methodname> <methodparam><type>float</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> <para> This funtion will make the script sleep until the specified <parameter>timestamp</parameter>. If the specified <parameter>timestamp</parameter> is in the past, <function>time_sleep_until</function> will generate a <constant>E_WARNING</constant> and return &false;. </para> &note.no-windows; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>timestamp</parameter></term> <listitem> <para> The timestamp when the script should wake. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>time_sleep_until</function> example</title> <programlisting role="php"> <![CDATA[ <?php //returns false and generates a warning var_dump(time_sleep_until(time()-1)); // may only work on faster computers, will sleep up to 0.2 seconds var_dump(time_sleep_until(time()+0.2)); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>sleep</function></member> <member><function>usleep</function></member> <member><function>time_nanosleep</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:"../../../../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 -->