<!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>Unstacking work</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="worker.stack.html">Worker::stack</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.collectable.html">Collectable</a></div>
<div class="up"><a href="class.worker.html">Worker</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="worker.unstack" class="refentry">
<div class="refnamediv">
<h1 class="refname">Worker::unstack</h1>
<p class="verinfo">(PECL pthreads >= 2.0.0)</p><p class="refpurpose"><span class="refname">Worker::unstack</span> — <span class="dc-title">Unstacking work</span></p>
</div>
<div class="refsect1 description" id="refsect1-worker.unstack-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>Worker::unstack</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Removes the first task (the oldest one) in the stack.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-worker.unstack-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-worker.unstack-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The new size of the stack.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-worker.unstack-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>v3</td>
<td>
The parameter to specify the task to unstack has been removed. Now, only the
first task in the stack is removed.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-worker.unstack-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4526">
<p><strong>Example #1 Removing objects from the stack of Workers</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$my </span><span style="color: #007700">= new </span><span style="color: #0000BB">Worker</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$work </span><span style="color: #007700">= new class extends </span><span style="color: #0000BB">Threaded </span><span style="color: #007700">{};<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</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">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$my</span><span style="color: #007700">-></span><span style="color: #0000BB">unstack</span><span style="color: #007700">());</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(1)
int(0)
</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="worker.stack.html">Worker::stack</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.collectable.html">Collectable</a></div>
<div class="up"><a href="class.worker.html">Worker</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
