<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Delay for a number of seconds and nanoseconds</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sys-getloadavg.html">sys_getloadavg</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.time-sleep-until.html">time_sleep_until</a></div>
<div class="up"><a href="ref.misc.html">Misc. Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.time-nanosleep" class="refentry">
<div class="refnamediv">
<h1 class="refname">time_nanosleep</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">time_nanosleep</span> — <span class="dc-title">Delay for a number of seconds and nanoseconds</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.time-nanosleep-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>time_nanosleep</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$seconds</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$nanoseconds</code></span>
)</div>
<p class="para rdfs-comment">
Delays program execution for the given number of
<em><code class="parameter">seconds</code></em> and <em><code class="parameter">nanoseconds</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.time-nanosleep-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">seconds</code></em></span>
<dd>
<p class="para">
Must be a non-negative integer.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">nanoseconds</code></em></span>
<dd>
<p class="para">
Must be a non-negative integer less than 1 billion.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.time-nanosleep-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
<p class="para">
If the delay was interrupted by a signal, an associative array will be
returned with the components:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em>seconds</em> - number of seconds remaining in
the delay
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>nanoseconds</em> - number of nanoseconds
remaining in the delay
</span>
</li>
</ul>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.time-nanosleep-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.3.0</td>
<td>
This function is now available on Windows platforms.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.time-nanosleep-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3786">
<p><strong>Example #1 <span class="function"><strong>time_nanosleep()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Careful! This won't work as expected if an array is returned<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">time_nanosleep</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">500000000</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Slept for half a second.\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// This is better:<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">time_nanosleep</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">500000000</span><span style="color: #007700">) === </span><span style="color: #0000BB">true</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Slept for half a second.\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// And this is the best:<br /></span><span style="color: #0000BB">$nano </span><span style="color: #007700">= </span><span style="color: #0000BB">time_nanosleep</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">100000</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$nano </span><span style="color: #007700">=== </span><span style="color: #0000BB">true</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Slept for 2 seconds, 100 microseconds.\n"</span><span style="color: #007700">;<br />} elseif (</span><span style="color: #0000BB">$nano </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Sleeping failed.\n"</span><span style="color: #007700">;<br />} elseif (</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$nano</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$seconds </span><span style="color: #007700">= </span><span style="color: #0000BB">$nano</span><span style="color: #007700">[</span><span style="color: #DD0000">'seconds'</span><span style="color: #007700">];<br /> </span><span style="color: #0000BB">$nanoseconds </span><span style="color: #007700">= </span><span style="color: #0000BB">$nano</span><span style="color: #007700">[</span><span style="color: #DD0000">'nanoseconds'</span><span style="color: #007700">];<br /> echo </span><span style="color: #DD0000">"Interrupted by a signal.\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Time remaining: </span><span style="color: #0000BB">$seconds</span><span style="color: #DD0000"> seconds, </span><span style="color: #0000BB">$nanoseconds</span><span style="color: #DD0000"> nanoseconds."</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.time-nanosleep-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.sleep.html" class="function" rel="rdfs-seeAlso">sleep()</a> - Delay execution</span></li>
<li class="member"> <span class="function"><a href="function.usleep.html" class="function" rel="rdfs-seeAlso">usleep()</a> - Delay execution in microseconds</span></li>
<li class="member"> <span class="function"><a href="function.time-sleep-until.html" class="function" rel="rdfs-seeAlso">time_sleep_until()</a> - Make the script sleep until the specified time</span></li>
<li class="member"> <span class="function"><a href="function.set-time-limit.html" class="function" rel="rdfs-seeAlso">set_time_limit()</a> - Limits the maximum execution time</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sys-getloadavg.html">sys_getloadavg</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.time-sleep-until.html">time_sleep_until</a></div>
<div class="up"><a href="ref.misc.html">Misc. Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
