libucommon-doc 3.2.0-0ubuntu1 / usr / share / doc / libucommon-dev / a00110.html

This file is indexed.

/usr/share/doc/libucommon-dev/a00110.html is in libucommon-doc 3.2.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::queueof&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00110.html">queueof</a>
  </div>
</div>
<div class="contents">
<h1>ucc::queueof&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="ucc::queueof" --><!-- doxytag: inherits="ucc::queue" -->
<p>A templated typed class for thread-safe queue of object pointers.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00208_source.html">thread.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::queueof&lt; T &gt;:</div>
<div class="dynsection">
<div class="center"><img src="a00485.png" border="0" usemap="#ucc_1_1queueof_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1queueof_3_01_t_01_4_inherit__map" id="ucc_1_1queueof_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00109.html" title="Manage a thread&#45;safe queue of objects through reference pointers." alt="" coords="107,83,197,112"/><area shape="rect" id="node4" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="5,5,144,35"/><area shape="rect" id="node6" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="168,5,291,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::queueof&lt; T &gt;:</div>
<div class="dynsection">
<div class="center"><img src="a00486.png" border="0" usemap="#ucc_1_1queueof_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1queueof_3_01_t_01_4_coll__map" id="ucc_1_1queueof_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00109.html" title="Manage a thread&#45;safe queue of objects through reference pointers." alt="" coords="207,395,297,424"/><area shape="rect" id="node4" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="76,299,215,328"/><area shape="rect" id="node6" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="75,187,219,216"/><area shape="rect" id="node8" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="5,96,139,125"/><area shape="rect" id="node10" href="a00093.html" title="A common base class for all managed objects." alt="" coords="25,5,119,35"/><area shape="rect" id="node13" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="239,299,361,328"/><area shape="rect" id="node15" href="a00081.html" title="A managed private heap for small allocations." alt="" coords="385,299,508,328"/><area shape="rect" id="node17" href="a00080.html" title="An alternate memory pager private heap manager." alt="" coords="389,187,504,216"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a239c9b507998743083d3e021c87f7b71">fifo</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get and remove first typed object posted to the queue.  <a href="#a239c9b507998743083d3e021c87f7b71"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#ae5b5d50569b9c7ee35d212761a497035">lifo</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get and remove last typed object posted to the queue.  <a href="#ae5b5d50569b9c7ee35d212761a497035"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#aacfcdd365ecd62ff650357ddd34a5d59">post</a> (T *object, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Post a typed object into the queue by it's pointer.  <a href="#aacfcdd365ecd62ff650357ddd34a5d59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#af4a6b41716e91ff976de2e191f495ec0">queueof</a> (<a class="el" href="a00081.html">mempager</a> *memory, size_t size=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create templated queue of typed objects.  <a href="#af4a6b41716e91ff976de2e191f495ec0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a2c9dd405669ccc7aced1567caa3e3934">remove</a> (T *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a specific typed object pointer for the queue.  <a href="#a2c9dd405669ccc7aced1567caa3e3934"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br/>
 class ucc::queueof&lt; T &gt;</h3>

<p>A templated typed class for thread-safe queue of object pointers. </p>
<p>This allows one to use the queue class in a typesafe manner for a specific object type derived from <a class="el" href="a00093.html" title="A common base class for all managed objects.">Object</a> rather than generically for any derived object class. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l02130">2130</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af4a6b41716e91ff976de2e191f495ec0"></a><!-- doxytag: member="ucc::queueof::queueof" ref="af4a6b41716e91ff976de2e191f495ec0" args="(mempager *memory, size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00110.html">ucc::queueof</a>&lt; T &gt;::<a class="el" href="a00110.html">queueof</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00081.html">mempager</a> *&nbsp;</td>
          <td class="paramname"> <em>memory</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create templated queue of typed objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>memory</em>&nbsp;</td><td>pool for internal use by queue. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of queue to construct. Uses 0 if no size limit. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00208_source.html#l02138">2138</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a239c9b507998743083d3e021c87f7b71"></a><!-- doxytag: member="ucc::queueof::fifo" ref="a239c9b507998743083d3e021c87f7b71" args="(timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="a00110.html">ucc::queueof</a>&lt; T &gt;::fifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get and remove first typed object posted to the queue. </p>
<p>This can wait for a specified timeut of the queue is empty. The object is still retained and must be released or deleted by the receiving function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>to wait if empty in milliseconds. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object from queue or NULL if empty and timed out. </dd></dl>

<p>Reimplemented from <a class="el" href="a00109.html#a584797f8acf9c21392107a14a2e9309e">ucc::queue</a>.</p>

<p>Definition at line <a class="el" href="a00208_source.html#l02168">2168</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae5b5d50569b9c7ee35d212761a497035"></a><!-- doxytag: member="ucc::queueof::lifo" ref="ae5b5d50569b9c7ee35d212761a497035" args="(timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="a00110.html">ucc::queueof</a>&lt; T &gt;::lifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get and remove last typed object posted to the queue. </p>
<p>This can wait for a specified timeout of the queue is empty. The object is still retained and must be released or deleted by the receiving function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>to wait if empty in milliseconds. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object from queue or NULL if empty and timed out. </dd></dl>

<p>Reimplemented from <a class="el" href="a00109.html#a249082dff3b76ce7371456b36cc9d06f">ucc::queue</a>.</p>

<p>Definition at line <a class="el" href="a00208_source.html#l02178">2178</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

</div>
</div>
<a class="anchor" id="aacfcdd365ecd62ff650357ddd34a5d59"></a><!-- doxytag: member="ucc::queueof::post" ref="aacfcdd365ecd62ff650357ddd34a5d59" args="(T *object, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00110.html">ucc::queueof</a>&lt; T &gt;::post </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Post a typed object into the queue by it's pointer. </p>
<p>This can wait for a specified timeout if the queue is full, for example, for another thread to remove an object pointer. This retains the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>to post. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>to wait if queue is full in milliseconds. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if object posted, false if queue full and timeout expired. </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l02158">2158</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2c9dd405669ccc7aced1567caa3e3934"></a><!-- doxytag: member="ucc::queueof::remove" ref="a2c9dd405669ccc7aced1567caa3e3934" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00110.html">ucc::queueof</a>&lt; T &gt;::remove </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Remove a specific typed object pointer for the queue. </p>
<p>This can remove a member from any location in the queue, whether beginning, end, or somewhere in the middle. This releases the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>to remove. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if object was removed, false if not found. </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l02147">2147</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00110_a2c9dd405669ccc7aced1567caa3e3934_cgraph.png" border="0" usemap="#a00110_a2c9dd405669ccc7aced1567caa3e3934_cgraph_map" alt=""></div>
<map name="a00110_a2c9dd405669ccc7aced1567caa3e3934_cgraph_map" id="a00110_a2c9dd405669ccc7aced1567caa3e3934_cgraph">
<area shape="rect" id="node3" href="a00214.html#a284595fb28be69136211845567e6eeec" title="Convenience function to remove an object from a stack." alt="" coords="216,5,317,35"/></map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00208_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:40 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.