svn: /phpdoc/en/trunk/reference/pthreads/pool/ __construct.xml
| From: | Joe Watkins | Date: | Thu, 06 Mar 2014 16:34:50 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/pthreads/pool/ __construct.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-12175@lists.php.net to get a copy of this message | ||
krakjoe Thu, 06 Mar 2014 16:34:50 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=332927
Log:
documentation for constructor of pools
Changed paths:
A phpdoc/en/trunk/reference/pthreads/pool/__construct.xml
Added: phpdoc/en/trunk/reference/pthreads/pool/__construct.xml
===================================================================
--- phpdoc/en/trunk/reference/pthreads/pool/__construct.xml (rev 0)
+++ phpdoc/en/trunk/reference/pthreads/pool/__construct.xml 2014-03-06 16:34:50 UTC (rev 332927)
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 329926 $ -->
+
+<refentry xml:id="pool.__construct" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>Pool::__construct</refname>
+ <refpurpose>Creates a new Pool of Workers</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>Pool</type><methodname>Pool::__construct</methodname>
+
<methodparam><type>integer</type><parameter>size</parameter></methodparam>
+
<methodparam><type>string</type><parameter>class</parameter></methodparam>
+ <methodparam
choice="opt"><type>array</type><parameter>ctor</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Construct a new Pool of Workers
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>size</parameter></term>
+ <listitem>
+ <para>
+ The maximum number of Workers this Pool can create
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>class</parameter></term>
+ <listitem>
+ <para>
+ The class for new Workers
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ctor</parameter></term>
+ <listitem>
+ <para>
+ An array of arguments to be passed to new Workers
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ the new Pool
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <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>
+ </para>
+ </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
+-->