<!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 Pool class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pthreads.modifiers.html">Modifiers</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pool.collect.html">Pool::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.pool" class="reference">
<h1 class="title">The Pool class</h1>
<div class="partintro"><p class="verinfo">(PECL pthreads >= 2.0.0)</p>
<div class="section" id="pool.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A Pool is a container for, and controller of, an adjustable number of Workers.
</p>
<p class="para">
Pooling provides a higher level abstraction of the Worker functionality, including the management of references in the way required by pthreads.
</p>
</div>
<div class="section" id="pool.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Pool</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.pool.html#pool.props.size">$<var class="varname">size</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.pool.html#pool.props.class">$<var class="varname">class</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.pool.html#pool.props.workers">$<var class="varname">workers</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.pool.html#pool.props.ctor">$<var class="varname">ctor</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.pool.html#pool.props.last">$<var class="varname">last</var></a></var>
;</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="pool.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">Pool</span> <span class="methodname"><a href="pool.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$class</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$ctor</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="pool.resize.html" class="methodname">resize</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="pool.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="pool.submit.html" class="methodname">submit</a></span>
( <span class="methodparam"><span class="type"><a href="class.threaded.html" class="type Threaded">Threaded</a></span> <code class="parameter">$task</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="pool.submitTo.html" class="methodname">submitTo</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$worker</code></span>
, <span class="methodparam"><span class="type"><a href="class.threaded.html" class="type Threaded">Threaded</a></span> <code class="parameter">$task</code></span>
)</div>
}</div>
</div>
<div class="section" id="pool.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="pool.props.size"><var class="varname"><var class="varname">size</var></var></dt>
<dd>
<p class="para">maximum number of Workers this Pool can use</p>
</dd>
<dt id="pool.props.class"><var class="varname"><var class="varname">class</var></var></dt>
<dd>
<p class="para">the class of the Worker</p>
</dd>
<dt id="pool.props.workers"><var class="varname"><var class="varname">workers</var></var></dt>
<dd>
<p class="para">references to Workers</p>
</dd>
<dt id="pool.props.ctor"><var class="varname"><var class="varname">ctor</var></var></dt>
<dd>
<p class="para">the arguments for constructor of new Workers</p>
</dd>
<dt id="pool.props.last"><var class="varname"><var class="varname">last</var></var></dt>
<dd>
<p class="para">offset in workers of the last Worker used</p>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="pool.collect.html">Pool::collect</a> — Collect references to completed tasks</li><li><a href="pool.construct.html">Pool::__construct</a> — Creates a new Pool of Workers</li><li><a href="pool.resize.html">Pool::resize</a> — Resize the Pool</li><li><a href="pool.shutdown.html">Pool::shutdown</a> — Shutdown all workers</li><li><a href="pool.submit.html">Pool::submit</a> — Submits an object for execution</li><li><a href="pool.submitTo.html">Pool::submitTo</a> — Submits a task to a specific worker for execution</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pthreads.modifiers.html">Modifiers</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pool.collect.html">Pool::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>
