<!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>Synchronization</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="stackable.unlock.html">Stackable::unlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pthreads.modifiers.html">Modifiers</a></div>
<div class="up"><a href="class.stackable.html">Stackable</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="stackable.wait" class="refentry">
<div class="refnamediv">
<h1 class="refname">Stackable::wait</h1>
<p class="verinfo">(PECL pthreads >= 0.36)</p><p class="refpurpose"><span class="refname">Stackable::wait</span> — <span class="dc-title">Synchronization</span></p>
</div>
<div class="refsect1 description" id="refsect1-stackable.wait-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><strong>Stackable::wait</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$timeout</code></span>
] )</div>
<p class="para rdfs-comment">
Waits for notification from the Stackable
</p>
</div>
<div class="refsect1 parameters" id="refsect1-stackable.wait-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">timeout</code></em></span>
<dd>
<p class="para">
An optional timeout in millionths of a second.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-stackable.wait-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A boolean indication of success
</p>
</div>
<div class="refsect1 examples" id="refsect1-stackable.wait-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3708">
<p><strong>Example #1 Notifications and Waiting</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">Work </span><span style="color: #007700">extends </span><span style="color: #0000BB">Stackable </span><span style="color: #007700">{<br /> public function </span><span style="color: #0000BB">run</span><span style="color: #007700">() {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">synchronized</span><span style="color: #007700">(function(</span><span style="color: #0000BB">$object</span><span style="color: #007700">){<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s Synchronized\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">__CLASS__</span><span style="color: #007700">); <br /> </span><span style="color: #0000BB">$object</span><span style="color: #007700">-></span><span style="color: #0000BB">notify</span><span style="color: #007700">();<br /> }, </span><span style="color: #0000BB">$this</span><span style="color: #007700">);<br /> }<br />}<br />class </span><span style="color: #0000BB">My </span><span style="color: #007700">extends </span><span style="color: #0000BB">Worker </span><span style="color: #007700">{<br /> public function </span><span style="color: #0000BB">run</span><span style="color: #007700">() {<br /> </span><span style="color: #FF8000">/** ... **/<br /> </span><span style="color: #007700">}<br />}<br /><br /></span><span style="color: #0000BB">$my </span><span style="color: #007700">= new </span><span style="color: #0000BB">My</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$my</span><span style="color: #007700">-></span><span style="color: #0000BB">start</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$work </span><span style="color: #007700">= array(new </span><span style="color: #0000BB">Work</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">$my</span><span style="color: #007700">-></span><span style="color: #0000BB">stack</span><span style="color: #007700">(</span><span style="color: #0000BB">$work</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]);<br /></span><span style="color: #FF8000">/** send notification to the waiting thread **/<br /></span><span style="color: #0000BB">$work</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]-></span><span style="color: #0000BB">synchronized</span><span style="color: #007700">(function(</span><span style="color: #0000BB">$object</span><span style="color: #007700">){<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Process Synchronized\n"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$object</span><span style="color: #007700">-></span><span style="color: #0000BB">wait</span><span style="color: #007700">();<br />}, </span><span style="color: #0000BB">$work</span><span style="color: #007700">[</span><span style="color: #0000BB">0</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>
Process Synchronized
Work Synchronized
</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="stackable.unlock.html">Stackable::unlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pthreads.modifiers.html">Modifiers</a></div>
<div class="up"><a href="class.stackable.html">Stackable</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
