-
Notifications
You must be signed in to change notification settings - Fork 860
Expand file tree
/
Copy pathpool.xml
More file actions
134 lines (120 loc) · 3.91 KB
/
pool.xml
File metadata and controls
134 lines (120 loc) · 3.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.pool" role="class">
<title>The Pool class</title>
<titleabbrev>Pool</titleabbrev>
<partintro>
<!-- {{{ Pool intro -->
<section xml:id="pool.intro">
&reftitle.intro;
<simpara>
A Pool is a container for, and controller of, an adjustable number of Workers.
</simpara>
<simpara>
Pooling provides a higher level abstraction of the Worker functionality, including the management of references in the way required by pthreads.
</simpara>
</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:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<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')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ Pool properties -->
<section xml:id="pool.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="pool.props.size">
<term><varname>size</varname></term>
<listitem>
<simpara>maximum number of Workers this Pool can use</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="pool.props.class">
<term><varname>class</varname></term>
<listitem>
<simpara>the class of the Worker</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="pool.props.workers">
<term><varname>workers</varname></term>
<listitem>
<simpara>references to Workers</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="pool.props.ctor">
<term><varname>ctor</varname></term>
<listitem>
<simpara>the arguments for constructor of new Workers</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="pool.props.last">
<term><varname>last</varname></term>
<listitem>
<simpara>offset in workers of the last Worker used</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.pthreads.entities.pool;
</reference>
<!-- 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
-->