php-doc-en/reference/pthreads/pool.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.pool" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The Pool class</title>
 <titleabbrev>Pool</titleabbrev>

 <partintro>

<!-- {{{ Pool intro -->
  <section xml:id="pool.intro">
   &reftitle.intro;
   <para>
   A Pool is a container for, and controller of, an adjustable number of Workers.
   </para>
   <para>
   Pooling provides a higher level abstraction of the Worker functionality, including the management of references in the way required by pthreads.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="pool.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>Pool</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>Pool</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="pool.props.size">size</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="pool.props.class">class</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="pool.props.workers">workers</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="pool.props.ctor">ctor</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="pool.props.last">last</varname>
    </fieldsynopsis>

    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pool')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ Pool properties -->
  <section xml:id="pool.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="pool.props.size">
     <term><varname>size</varname></term>
     <listitem>
      <para>maximum number of Workers this Pool can use</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pool.props.class">
     <term><varname>class</varname></term>
     <listitem>
      <para>the class of the Worker</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pool.props.workers">
     <term><varname>workers</varname></term>
     <listitem>
      <para>references to Workers</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pool.props.ctor">
     <term><varname>ctor</varname></term>
     <listitem>
      <para>the arguments for constructor of new Workers</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="pool.props.last">
     <term><varname>last</varname></term>
     <listitem>
      <para>offset in workers of the last Worker used</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.pthreads.entities.pool;

</phpdoc:classref>

<!-- 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
-->