/usr/share/doc/libucommon-dev/a00109.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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | <!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::queue Class 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 Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00109.html">queue</a>
</div>
</div>
<div class="contents">
<h1>ucc::queue Class Reference</h1><!-- doxytag: class="ucc::queue" --><!-- doxytag: inherits="ucc::OrderedIndex,ucc::Conditional" -->
<p>Manage a thread-safe queue of objects through reference pointers.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00208_source.html">thread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::queue:</div>
<div class="dynsection">
<div class="center"><img src="a00483.png" border="0" usemap="#ucc_1_1queue_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1queue_inherit__map" id="ucc_1_1queue_inherit__map">
<area shape="rect" id="node7" href="a00110.html" title="A templated typed class for thread-safe queue of object pointers." alt="" coords="81,160,223,189"/><area shape="rect" id="node2" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="5,5,144,35"/><area shape="rect" id="node4" 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::queue:</div>
<div class="dynsection">
<div class="center"><img src="a00484.png" border="0" usemap="#ucc_1_1queue_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1queue_coll__map" id="ucc_1_1queue_coll__map">
<area shape="rect" id="node2" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="76,299,215,328"/><area shape="rect" id="node4" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="75,187,219,216"/><area shape="rect" id="node6" 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="node8" href="a00093.html" title="A common base class for all managed objects." alt="" coords="25,5,119,35"/><area shape="rect" id="node11" 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="node13" href="a00081.html" title="A managed private heap for small allocations." alt="" coords="385,299,508,328"/><area shape="rect" id="node15" 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"><a class="el" href="a00093.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a584797f8acf9c21392107a14a2e9309e">fifo</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get and remove last object posted to the queue. <a href="#a584797f8acf9c21392107a14a2e9309e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a7527e496c3f3ea82b110f302420be120">getCount</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of object points currently in the queue. <a href="#a7527e496c3f3ea82b110f302420be120"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00093.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a249082dff3b76ce7371456b36cc9d06f">lifo</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get and remove first object posted to the queue. <a href="#a249082dff3b76ce7371456b36cc9d06f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a8ccb5325fa240abc5a60a95c443059ed">post</a> (<a class="el" href="a00093.html">Object</a> *object, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Post an object into the queue by it's pointer. <a href="#a8ccb5325fa240abc5a60a95c443059ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#ad99ad40409e7ba7a8fdef165542ee268">queue</a> (<a class="el" href="a00081.html">mempager</a> *<a class="el" href="a00102.html">pager</a>=NULL, size_t number=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a queue that uses a memory pager for internally managed member objects for a specified maximum number of object pointers. <a href="#ad99ad40409e7ba7a8fdef165542ee268"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a121f9e0cab42141879e1e979852a4275">remove</a> (<a class="el" href="a00093.html">Object</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a specific object pointer for the queue. <a href="#a121f9e0cab42141879e1e979852a4275"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#af72f49545e0871dfdafaf1fc39c8643b">~queue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy queue. <a href="#af72f49545e0871dfdafaf1fc39c8643b"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#ae7f69b3d59c9b2b15cd2fd74059862c0">count</a> (<a class="el" href="a00109.html">queue</a> &<a class="el" href="a00109.html">queue</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to get count of objects in the queue. <a href="#ae7f69b3d59c9b2b15cd2fd74059862c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00093.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#ac4830f2fb2b8000a8d06556ebf0334c9">fifo</a> (<a class="el" href="a00109.html">queue</a> &<a class="el" href="a00109.html">queue</a>, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function get first object from the queue. <a href="#ac4830f2fb2b8000a8d06556ebf0334c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00093.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a64eea8a95dff583324a0f45a586e199d">lifo</a> (<a class="el" href="a00109.html">queue</a> &<a class="el" href="a00109.html">queue</a>, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function get last object from the queue. <a href="#a64eea8a95dff583324a0f45a586e199d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#aca3840dcdcda6a0d05e8edef00e405e1">post</a> (<a class="el" href="a00109.html">queue</a> &<a class="el" href="a00109.html">queue</a>, <a class="el" href="a00093.html">Object</a> *object, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to post object into the queue. <a href="#aca3840dcdcda6a0d05e8edef00e405e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00109.html#a56b85299d970421de9535b5ebdcac5f6">remove</a> (<a class="el" href="a00109.html">queue</a> &<a class="el" href="a00109.html">queue</a>, <a class="el" href="a00093.html">Object</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to remove an object from the queue. <a href="#a56b85299d970421de9535b5ebdcac5f6"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ecfe49c2b6d0c4c22a68f0d5f82761e"></a><!-- doxytag: member="ucc::queue::limit" ref="a9ecfe49c2b6d0c4c22a68f0d5f82761e" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>limit</b></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0352b76113cdfb8a6e0a3be7165742b8"></a><!-- doxytag: member="ucc::queue::member" ref="a0352b76113cdfb8a6e0a3be7165742b8" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>member</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Manage a thread-safe queue of objects through reference pointers. </p>
<p>This can be particularly interesting when used to enqueue/dequeue reference counted managed objects. Thread-safe access is managed through a conditional. Both lifo and fifo forms of queue access may be used. A pool of self-managed member objects are used to operate the queue. This queue is optimized for fifo access; while lifo is supported, it will be slow. If you need primarily lifo, you should use stack instead. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01670">1670</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad99ad40409e7ba7a8fdef165542ee268"></a><!-- doxytag: member="ucc::queue::queue" ref="ad99ad40409e7ba7a8fdef165542ee268" args="(mempager *pager=NULL, size_t number=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::queue::queue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00081.html">mempager</a> * </td>
<td class="paramname"> <em>pager</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>number</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a queue that uses a memory pager for internally managed member objects for a specified maximum number of object pointers. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pager</em> </td><td>to use for internal member object or NULL to use heap. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>of pointers that can be in the queue or 0 for unlimited. size limit. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af72f49545e0871dfdafaf1fc39c8643b"></a><!-- doxytag: member="ucc::queue::~queue" ref="af72f49545e0871dfdafaf1fc39c8643b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::queue::~queue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy queue. </p>
<p>If no mempager is used, then frees heap. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae7f69b3d59c9b2b15cd2fd74059862c0"></a><!-- doxytag: member="ucc::queue::count" ref="ae7f69b3d59c9b2b15cd2fd74059862c0" args="(queue &queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static size_t ucc::queue::count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00109.html">queue</a> & </td>
<td class="paramname"> <em>queue</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function to get count of objects in the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to count. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of objects in the queue. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01789">1789</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="a00109_ae7f69b3d59c9b2b15cd2fd74059862c0_cgraph.png" border="0" usemap="#a00109_ae7f69b3d59c9b2b15cd2fd74059862c0_cgraph_map" alt=""></div>
<map name="a00109_ae7f69b3d59c9b2b15cd2fd74059862c0_cgraph_map" id="a00109_ae7f69b3d59c9b2b15cd2fd74059862c0_cgraph">
<area shape="rect" id="node3" href="a00109.html#a7527e496c3f3ea82b110f302420be120" title="Get number of object points currently in the queue." alt="" coords="191,5,348,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ac4830f2fb2b8000a8d06556ebf0334c9"></a><!-- doxytag: member="ucc::queue::fifo" ref="ac4830f2fb2b8000a8d06556ebf0334c9" args="(queue &queue, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00093.html">Object</a>* ucc::queue::fifo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00109.html">queue</a> & </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function get first object from the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to get from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait if empty. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>first object or NULL if timed out empty. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01772">1772</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="a00109_ac4830f2fb2b8000a8d06556ebf0334c9_cgraph.png" border="0" usemap="#a00109_ac4830f2fb2b8000a8d06556ebf0334c9_cgraph_map" alt=""></div>
<map name="a00109_ac4830f2fb2b8000a8d06556ebf0334c9_cgraph_map" id="a00109_ac4830f2fb2b8000a8d06556ebf0334c9_cgraph">
<area shape="rect" id="node3" href="a00109.html#a584797f8acf9c21392107a14a2e9309e" title="Get and remove last object posted to the queue." alt="" coords="175,5,292,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a584797f8acf9c21392107a14a2e9309e"></a><!-- doxytag: member="ucc::queue::fifo" ref="a584797f8acf9c21392107a14a2e9309e" args="(timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00093.html">Object</a>* ucc::queue::fifo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get and remove last 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> </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 in <a class="el" href="a00110.html#a239c9b507998743083d3e021c87f7b71">ucc::queueof< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a7527e496c3f3ea82b110f302420be120"></a><!-- doxytag: member="ucc::queue::getCount" ref="a7527e496c3f3ea82b110f302420be120" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ucc::queue::getCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get number of object points currently in the queue. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of objects in queue. </dd></dl>
</div>
</div>
<a class="anchor" id="a64eea8a95dff583324a0f45a586e199d"></a><!-- doxytag: member="ucc::queue::lifo" ref="a64eea8a95dff583324a0f45a586e199d" args="(queue &queue, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00093.html">Object</a>* ucc::queue::lifo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00109.html">queue</a> & </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function get last object from the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to get from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait if empty. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>last object or NULL if timed out empty. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01781">1781</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="a00109_a64eea8a95dff583324a0f45a586e199d_cgraph.png" border="0" usemap="#a00109_a64eea8a95dff583324a0f45a586e199d_cgraph_map" alt=""></div>
<map name="a00109_a64eea8a95dff583324a0f45a586e199d_cgraph_map" id="a00109_a64eea8a95dff583324a0f45a586e199d_cgraph">
<area shape="rect" id="node3" href="a00109.html#a249082dff3b76ce7371456b36cc9d06f" title="Get and remove first object posted to the queue." alt="" coords="175,5,292,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a249082dff3b76ce7371456b36cc9d06f"></a><!-- doxytag: member="ucc::queue::lifo" ref="a249082dff3b76ce7371456b36cc9d06f" args="(timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00093.html">Object</a>* ucc::queue::lifo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get and remove first 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> </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 in <a class="el" href="a00110.html#ae5b5d50569b9c7ee35d212761a497035">ucc::queueof< T ></a>.</p>
</div>
</div>
<a class="anchor" id="aca3840dcdcda6a0d05e8edef00e405e1"></a><!-- doxytag: member="ucc::queue::post" ref="aca3840dcdcda6a0d05e8edef00e405e1" args="(queue &queue, Object *object, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool ucc::queue::post </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00109.html">queue</a> & </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </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> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function to post object into the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to post into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>to post. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait if full. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if posted, false if timed out while full. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01763">1763</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="a00109_aca3840dcdcda6a0d05e8edef00e405e1_cgraph.png" border="0" usemap="#a00109_aca3840dcdcda6a0d05e8edef00e405e1_cgraph_map" alt=""></div>
<map name="a00109_aca3840dcdcda6a0d05e8edef00e405e1_cgraph_map" id="a00109_aca3840dcdcda6a0d05e8edef00e405e1_cgraph">
<area shape="rect" id="node3" href="a00109.html#a8ccb5325fa240abc5a60a95c443059ed" title="Post an object into the queue by it's pointer." alt="" coords="181,5,309,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a8ccb5325fa240abc5a60a95c443059ed"></a><!-- doxytag: member="ucc::queue::post" ref="a8ccb5325fa240abc5a60a95c443059ed" args="(Object *object, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::queue::post </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </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> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Post an 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 also 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> </td><td>to post. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </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>
</div>
</div>
<a class="anchor" id="a56b85299d970421de9535b5ebdcac5f6"></a><!-- doxytag: member="ucc::queue::remove" ref="a56b85299d970421de9535b5ebdcac5f6" args="(queue &queue, Object *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool ucc::queue::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00109.html">queue</a> & </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </td>
<td class="paramname"> <em>object</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function to remove an object from the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to remove object from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if removed, false if not found. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l01753">1753</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a121f9e0cab42141879e1e979852a4275"></a><!-- doxytag: member="ucc::queue::remove" ref="a121f9e0cab42141879e1e979852a4275" args="(Object *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::queue::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a specific 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 also 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> </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>
</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
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|