mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
add new docs for pool
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332926 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Joe Watkins
parent
5df3bd8c4a
commit
83d7c16fea
1 changed files with 144 additions and 0 deletions
144
reference/pthreads/pool.xml
Normal file
144
reference/pthreads/pool.xml
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<phpdoc:classref xml:id="class.classname"
|
||||
xmlns:phpdoc="http://php.net/ns/phpdoc"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<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, a number of Worker threads, the number of threads can be adjusted during execution, additionally the Pool provides an easy mechanism to maintain and collect references in the proper way.
|
||||
</para>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
<section xml:id="pool.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
||||
<!-- {{{ Synopsis -->
|
||||
<classsynopsis>
|
||||
<ooclass><classname>Pool</classname></ooclass>
|
||||
|
||||
<!-- {{{ Pool synopsis -->
|
||||
<classsynopsisinfo>
|
||||
<ooclass>
|
||||
<classname>Pool</classname>
|
||||
</ooclass>
|
||||
</classsynopsisinfo>
|
||||
<!-- }}} -->
|
||||
|
||||
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="pool.props.size">size</varname>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>array</type>
|
||||
<varname linkend="pool.props.workers">workers</varname>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>array</type>
|
||||
<varname linkend="pool.props.work">work</varname>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>integer</type>
|
||||
<varname linkend="pool.props.last">last</varname>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>string</type>
|
||||
<varname linkend="pool.props.class">class</varname>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>array</type>
|
||||
<varname linkend="pool.props.size">ctor</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[1])" />
|
||||
</classsynopsis>
|
||||
</section>
|
||||
|
||||
<section xml:id="pool.props">
|
||||
&reftitle.properties;
|
||||
<variablelist>
|
||||
<varlistentry xml:id="pool.props.size">
|
||||
<term><varname>size</varname></term>
|
||||
<listitem>
|
||||
<para>The maximum number of Worker threads allowed in this Pool</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="pool.props.workers">
|
||||
<term><varname>workers</varname></term>
|
||||
<listitem>
|
||||
<para>The array of Worker threads for this Pool</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="pool.props.work">
|
||||
<term><varname>work</varname></term>
|
||||
<listitem>
|
||||
<para>The array of Stackables submitted to this Pool for execution</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="pool.props.last">
|
||||
<term><varname>last</varname></term>
|
||||
<listitem>
|
||||
<para>The numeric identifier for the last Worker used by this Pool</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="pool.props.class">
|
||||
<term><varname>workers</varname></term>
|
||||
<listitem>
|
||||
<para>The name of the Worker class for this Pool</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="pool.props.ctor">
|
||||
<term><varname>workers</varname></term>
|
||||
<listitem>
|
||||
<para>The constructor arguments to be passed by this Pool to new Workers upon construction</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
|
||||
-->
|
||||
|
||||
Loading…
Reference in a new issue