<!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>Wait for Condition</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="cond.signal.html">Cond::signal</a></div> <div class="next" style="text-align: right; float: right;"><a href="book.sem.html">Semaphore</a></div> <div class="up"><a href="class.cond.html">Cond</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="cond.wait" class="refentry"> <div class="refnamediv"> <h1 class="refname">Cond::wait</h1> <p class="verinfo">(PECL pthreads >= 0.34)</p><p class="refpurpose"><span class="refname">Cond::wait</span> — <span class="dc-title">Wait for Condition</span></p> </div> <div class="refsect1 description" id="refsect1-cond.wait-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">boolean</span> <span class="methodname"><strong>Cond::wait</strong></span> ( <span class="methodparam"> <span class="type"><span class="type long">long</span></span> <code class="parameter">$condition</code> </span> , <span class="methodparam"> <span class="type"><span class="type long">long</span></span> <code class="parameter">$mutex</code> </span> [, <span class="methodparam"> <span class="type"><span class="type long">long</span></span> <code class="parameter">$timeout</code> </span> ] )</div> <p class="para rdfs-comment">Wait for a signal on a Condition Variable, optionally specifying a timeout to limit waiting time.</p> </div> <div class="refsect1 parameters" id="refsect1-cond.wait-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"><em><code class="parameter">condition</code></em></span> <dd> <p class="para">A handle returned by a previous call to <span class="function"><a href="cond.create.html" class="function">Cond::create()</a></span>.</p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">mutex</code></em></span> <dd> <p class="para">A handle returned by a previous call to <span class="function"><a href="mutex.create.html" class="function">Mutex::create()</a></span> and owned (locked) by the caller.</p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">timeout</code></em></span> <dd> <p class="para">An optional timeout, in microseconds ( millionths of a second ).</p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-cond.wait-returnvalues"> <h3 class="title">Return Values</h3> <p class="para">A boolean indication of success.</p> </div> <div class="refsect1 examples" id="refsect1-cond.wait-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3720"> <p><strong>Example #1 Waiting for Conditions</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">/** PLEASE NOTE THIS EXAMPLE WILL CAUSE THE PROCESS TO HANG **/<br /></span><span style="color: #0000BB">$mutex </span><span style="color: #007700">= </span><span style="color: #0000BB">Mutex</span><span style="color: #007700">::</span><span style="color: #0000BB">create</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/** You cannot use the "new" keyword, a Cond is not a PHP object **/<br /></span><span style="color: #0000BB">$cond </span><span style="color: #007700">= </span><span style="color: #0000BB">Cond</span><span style="color: #007700">::</span><span style="color: #0000BB">create</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">/** The caller must lock the associated Mutex before a call to broadcast **/<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">Cond</span><span style="color: #007700">::</span><span style="color: #0000BB">wait</span><span style="color: #007700">(</span><span style="color: #0000BB">$mutex</span><span style="color: #007700">, </span><span style="color: #0000BB">$cond</span><span style="color: #007700">));<br /></span><span style="color: #FF8000">/** Always destroy Cond you have created **/<br /></span><span style="color: #0000BB">Cond</span><span style="color: #007700">::</span><span style="color: #0000BB">destroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$cond</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">Mutex</span><span style="color: #007700">::</span><span style="color: #0000BB">unlock</span><span style="color: #007700">(</span><span style="color: #0000BB">$mutex</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">Mutex</span><span style="color: #007700">::</span><span style="color: #0000BB">destroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$mutex</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> int(49685473) </pre></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="cond.signal.html">Cond::signal</a></div> <div class="next" style="text-align: right; float: right;"><a href="book.sem.html">Semaphore</a></div> <div class="up"><a href="class.cond.html">Cond</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>