<!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>Make the script sleep until the specified time</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.time-nanosleep.html">time_nanosleep</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.uniqid.html">uniqid</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-sleep-until" class="refentry">
<div class="refnamediv">
<h1 class="refname">time_sleep_until</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">time_sleep_until</span> — <span class="dc-title">
Make the script sleep until the specified time
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.time-sleep-until-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>time_sleep_until</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$timestamp</code></span>
)</div>
<p class="para rdfs-comment">
Makes the script sleep until the specified
<em><code class="parameter">timestamp</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.time-sleep-until-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">timestamp</code></em></span>
<dd>
<p class="para">
The timestamp when the script should wake.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.time-sleep-until-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>
</div>
<div class="refsect1 changelog" id="refsect1-function.time-sleep-until-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 errors" id="refsect1-function.time-sleep-until-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If the specified <em><code class="parameter">timestamp</code></em> is in the past, this
function will generate a <strong><code>E_WARNING</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.time-sleep-until-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3787">
<p><strong>Example #1 A <span class="function"><strong>time_sleep_until()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">//returns false and generates a warning<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">time_sleep_until</span><span style="color: #007700">(</span><span style="color: #0000BB">time</span><span style="color: #007700">()-</span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// may only work on faster computers, will sleep up to 0.2 seconds<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">time_sleep_until</span><span style="color: #007700">(</span><span style="color: #0000BB">microtime</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">)+</span><span style="color: #0000BB">0.2</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.time-sleep-until-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
All signals will be delivered after the script wakes up.
</span>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.time-sleep-until-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-nanosleep.html" class="function" rel="rdfs-seeAlso">time_nanosleep()</a> - Delay for a number of seconds and nanoseconds</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.time-nanosleep.html">time_nanosleep</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.uniqid.html">uniqid</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>
