<!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>The Stackable class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="worker.unstack.html">Worker::unstack</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stackable.chunk.html">Stackable::chunk</a></div>
<div class="up"><a href="book.pthreads.html">pthreads</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.stackable" class="reference">
<h1 class="title">The Stackable class</h1>
<div class="partintro"><p class="verinfo">(PECL pthreads >= 0.36)</p>
<div class="section" id="stackable.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Stackables are tasks that are executed by Worker threads. You can synchronize with, read, and write Stackable objects before, after and during their execution.
</p>
</div>
<div class="section" id="stackable.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Stackable</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.chunk.html" class="methodname">chunk</a></span>
( <span class="methodparam"><span class="type"><span class="type long">long</span></span> <code class="parameter">$size</code></span>
, <span class="methodparam"><span class="type">boolean</span> <code class="parameter">$preserve</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.isrunning.html" class="methodname">isRunning</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.isterminated.html" class="methodname">isTerminated</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.iswaiting.html" class="methodname">isWaiting</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.lock.html" class="methodname">lock</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.merge.html" class="methodname">merge</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$from</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$overwrite</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.notify.html" class="methodname">notify</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.pop.html" class="methodname">pop</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="stackable.run.html" class="methodname">run</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.shift.html" class="methodname">shift</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="stackable.synchronized.html" class="methodname">synchronized</a></span>
( <span class="methodparam"><span class="type"><a href="class.closure.html" class="type Closure">Closure</a></span> <code class="parameter">$block</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.unlock.html" class="methodname">unlock</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="stackable.wait.html" class="methodname">wait</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$timeout</code></span>
] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="stackable.chunk.html">Stackable::chunk</a> — Manipulation</li><li><a href="stackable.isrunning.html">Stackable::isRunning</a> — State Detection</li><li><a href="stackable.isterminated.html">Stackable::isTerminated</a> — State Detection</li><li><a href="stackable.iswaiting.html">Stackable::isWaiting</a> — State Detection</li><li><a href="stackable.lock.html">Stackable::lock</a> — Synchronization</li><li><a href="stackable.merge.html">Stackable::merge</a> — Manipulation</li><li><a href="stackable.notify.html">Stackable::notify</a> — Synchronization</li><li><a href="stackable.pop.html">Stackable::pop</a> — Manipulation</li><li><a href="stackable.run.html">Stackable::run</a> — Execution</li><li><a href="stackable.shift.html">Stackable::shift</a> — Manipulation</li><li><a href="stackable.synchronized.html">Stackable::synchronized</a> — Synchronization</li><li><a href="stackable.unlock.html">Stackable::unlock</a> — Synchronization</li><li><a href="stackable.wait.html">Stackable::wait</a> — Synchronization</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="worker.unstack.html">Worker::unstack</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stackable.chunk.html">Stackable::chunk</a></div>
<div class="up"><a href="book.pthreads.html">pthreads</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
