mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 07:42:10 +01:00
126 lines
2.9 KiB
XML
126 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="pool.construct">
|
|
<refnamediv>
|
|
<refname>Pool::__construct</refname>
|
|
<refpurpose>Creates a new Pool of Workers</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<constructorsynopsis>
|
|
<modifier>public</modifier> <methodname>Pool::__construct</methodname>
|
|
<methodparam><type>int</type><parameter>size</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>class</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>ctor</parameter></methodparam>
|
|
</constructorsynopsis>
|
|
<simpara>
|
|
Construct a new pool of workers. Pools lazily create their threads, which
|
|
means new threads will only be spawned when they are required to execute
|
|
tasks.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>size</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The maximum number of workers for this pool to create
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>class</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The class for new Workers. If no class is given, then it defaults to the
|
|
<classname>Worker</classname> class.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>ctor</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
An array of arguments to be passed to new workers' constructors
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Creating Pools</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class MyWorker extends Worker {
|
|
|
|
public function __construct(Something $something) {
|
|
$this->something = $something;
|
|
}
|
|
|
|
public function run() {
|
|
/** ... **/
|
|
}
|
|
}
|
|
|
|
$pool = new Pool(8, \MyWorker::class, [new Something()]);
|
|
|
|
var_dump($pool);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
object(Pool)#1 (6) {
|
|
["size":protected]=>
|
|
int(8)
|
|
["class":protected]=>
|
|
string(8) "MyWorker"
|
|
["workers":protected]=>
|
|
NULL
|
|
["work":protected]=>
|
|
NULL
|
|
["ctor":protected]=>
|
|
array(1) {
|
|
[0]=>
|
|
object(Something)#2 (0) {
|
|
}
|
|
}
|
|
["last":protected]=>
|
|
int(0)
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|