File: time-nanosleep.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (118 lines) | stat: -rw-r--r-- 2,978 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.time-nanosleep">
 <refnamediv>
  <refname>time_nanosleep</refname>
  <refpurpose>
   Delay for a number of seconds and nanoseconds
  </refpurpose>
 </refnamediv>
 <refsect1>
  &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>
   &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>
  &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, 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 milliseconds.\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>
  &note.no-windows;
 </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
-->