<!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 Worker class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="thread.start.html">Thread::start</a></div>
<div class="next" style="text-align: right; float: right;"><a href="worker.collect.html">Worker::collect</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.worker" class="reference">
<h1 class="title">The Worker class</h1>
<div class="partintro"><p class="verinfo">(PECL pthreads >= 2.0.0)</p>
<div class="section" id="worker.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Worker Threads have a persistent context, as such should be used over Threads in most cases.
</p>
<p class="para">
When a Worker is started, the run method will be executed, but the Thread will not leave until one of the following conditions are met:
</p>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">the Worker goes out of scope (no more references remain)</p>
</li>
<li class="listitem">
<p class="para">the programmer calls shutdown</p>
</li>
<li class="listitem">
<p class="para">the script dies</p>
</li>
</ul>
<p class="para">
This means the programmer can reuse the context throughout execution; placing objects on the stack of the Worker will cause the Worker to
execute the stacked objects run method.
</p>
</div>
<div class="section" id="worker.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Worker</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.thread.html" class="classname">Thread</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.traversable.html" class="interfacename">Traversable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.countable.html" class="interfacename">Countable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="worker.collect.html" class="methodname">collect</a></span>
([ <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type Callable">Callable</a></span> <code class="parameter">$collector</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="worker.getstacked.html" class="methodname">getStacked</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="worker.isshutdown.html" class="methodname">isShutdown</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="worker.isworking.html" class="methodname">isWorking</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="worker.shutdown.html" class="methodname">shutdown</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="worker.stack.html" class="methodname">stack</a></span>
( <span class="methodparam"><span class="type"><a href="class.threaded.html" class="type Threaded">Threaded</a></span> <code class="parameter reference">&$work</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="worker.unstack.html" class="methodname">unstack</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="thread.detach.html" class="methodname">Thread::detach</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="thread.getcreatorid.html" class="methodname">Thread::getCreatorId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">Thread</span> <span class="methodname"><a href="thread.getcurrentthread.html" class="methodname">Thread::getCurrentThread</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">int</span> <span class="methodname"><a href="thread.getcurrentthreadid.html" class="methodname">Thread::getCurrentThreadId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="thread.getthreadid.html" class="methodname">Thread::getThreadId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">mixed</span> <span class="methodname"><a href="thread.globally.html" class="methodname">Thread::globally</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.isjoined.html" class="methodname">Thread::isJoined</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.isstarted.html" class="methodname">Thread::isStarted</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.join.html" class="methodname">Thread::join</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="thread.kill.html" class="methodname">Thread::kill</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.start.html" class="methodname">Thread::start</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="worker.collect.html">Worker::collect</a> — Collect references to completed tasks</li><li><a href="worker.getstacked.html">Worker::getStacked</a> — Gets the remaining stack size</li><li><a href="worker.isshutdown.html">Worker::isShutdown</a> — State Detection</li><li><a href="worker.isworking.html">Worker::isWorking</a> — State Detection</li><li><a href="worker.shutdown.html">Worker::shutdown</a> — Shutdown the worker</li><li><a href="worker.stack.html">Worker::stack</a> — Stacking work</li><li><a href="worker.unstack.html">Worker::unstack</a> — Unstacking work</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="thread.start.html">Thread::start</a></div>
<div class="next" style="text-align: right; float: right;"><a href="worker.collect.html">Worker::collect</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>
