/usr/share/doc/libucommon-dev/a00035.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 | <!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::bufferof< T > 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 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="a00035.html">bufferof</a>
</div>
</div>
<div class="contents">
<h1>ucc::bufferof< T > Class Template Reference</h1><!-- doxytag: class="ucc::bufferof" --><!-- doxytag: inherits="ucc::Buffer" -->
<p>A templated typed class for buffering of objects.
<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::bufferof< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00367.png" border="0" usemap="#ucc_1_1bufferof_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1bufferof_3_01_t_01_4_inherit__map" id="ucc_1_1bufferof_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00034.html" title="A thread-safe buffer for serializing and streaming class data." alt="" coords="29,83,120,112"/><area shape="rect" id="node4" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="13,5,136,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::bufferof< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00368.png" border="0" usemap="#ucc_1_1bufferof_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1bufferof_3_01_t_01_4_coll__map" id="ucc_1_1bufferof_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00034.html" title="A thread-safe buffer for serializing and streaming class data." alt="" coords="29,83,120,112"/><area shape="rect" id="node4" href="a00040.html" title="The conditional is a common base for other thread synchronizing classes." alt="" coords="13,5,136,35"/></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a78a7a6681f37c11978ea1ea527da5667">bufferof</a> (unsigned count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a buffer to hold a series of typed objects. <a href="#a78a7a6681f37c11978ea1ea527da5667"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#aa7203da87e2fe72118af980d94eb013e">copy</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the next typed object from the buffer. <a href="#aa7203da87e2fe72118af980d94eb013e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ad071de1bd4e584adccea4fe4361ee0bf">get</a> (T *object, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the next typed object from the buffer. <a href="#ad071de1bd4e584adccea4fe4361ee0bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a4f383a2e0e92b08983f778ee417e7086">get</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next typed object from the buffer. <a href="#a4f383a2e0e92b08983f778ee417e7086"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#ac722ebc172fc443a6717ca7e63d97141">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next typed object from the buffer. <a href="#ac722ebc172fc443a6717ca7e63d97141"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a6f57116b2e04b0b27848bc054d8bdb1e">put</a> (T *object, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put (copy) an object into the buffer. <a href="#a6f57116b2e04b0b27848bc054d8bdb1e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#aec6c2d9df4a15c22150bc91f1f51caf0">put</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put (copy) a typed object into the buffer. <a href="#aec6c2d9df4a15c22150bc91f1f51caf0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucc::bufferof< T ></h3>
<p>A templated typed class for buffering of objects. </p>
<p>This operates as a fifo buffer of typed objects which are physically copied into the buffer. The objects that are buffered are accessed from allocated buffer space. As designed this may be used with multiple producer threads and one consumer thread. To use multiple consumers, one can copy the typed object from the buffer through the get pointer and then call release. The copied object can then be used safely. This is what the copy method is used for. </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#l02244">2244</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a78a7a6681f37c11978ea1ea527da5667"></a><!-- doxytag: member="ucc::bufferof::bufferof" ref="a78a7a6681f37c11978ea1ea527da5667" args="(unsigned count)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00035.html">ucc::bufferof</a>< T >::<a class="el" href="a00035.html">bufferof</a> </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>count</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a buffer to hold a series 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>count</em> </td><td>of typed objects in the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02251">2251</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="aa7203da87e2fe72118af980d94eb013e"></a><!-- doxytag: member="ucc::bufferof::copy" ref="aa7203da87e2fe72118af980d94eb013e" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00035.html">ucc::bufferof</a>< T >::copy </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy the next typed object from the buffer. </p>
<p>This blocks until an object becomes available. </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>pointer to copy typed object into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02292">2292</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="a00035_aa7203da87e2fe72118af980d94eb013e_cgraph.png" border="0" usemap="#a00035_aa7203da87e2fe72118af980d94eb013e_cgraph_map" alt=""></div>
</div>
</p>
</div>
</div>
<a class="anchor" id="ad071de1bd4e584adccea4fe4361ee0bf"></a><!-- doxytag: member="ucc::bufferof::get" ref="ad071de1bd4e584adccea4fe4361ee0bf" args="(T *object, timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00035.html">ucc::bufferof</a>< T >::get </td>
<td>(</td>
<td class="paramtype">T * </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></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy the next typed object from the buffer. </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>pointer to copy typed object into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait when buffer is empty in milliseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if object copied, or false if timed out. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02301">2301</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="a00035_ad071de1bd4e584adccea4fe4361ee0bf_cgraph.png" border="0" usemap="#a00035_ad071de1bd4e584adccea4fe4361ee0bf_cgraph_map" alt=""></div>
<map name="a00035_ad071de1bd4e584adccea4fe4361ee0bf_cgraph_map" id="a00035_ad071de1bd4e584adccea4fe4361ee0bf_cgraph">
<area shape="rect" id="node3" href="a00214.html#a8370bd49e635d1f1c3aec9135f497cec" title="Convenence function to access object copy." alt="" coords="184,5,267,35"/><area shape="rect" id="node5" href="a00093.html#aa0d1f1e892c05c421a4216905a72553d" title="Retain (increase retention of) object when copying." alt="" coords="315,5,445,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a4f383a2e0e92b08983f778ee417e7086"></a><!-- doxytag: member="ucc::bufferof::get" ref="a4f383a2e0e92b08983f778ee417e7086" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00035.html">ucc::bufferof</a>< T >::get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next typed object from the buffer. </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 when buffer is empty in milliseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to next typed object in the buffer or NULL if timed out. </dd></dl>
<p>Reimplemented from <a class="el" href="a00034.html#ac49c701c4694e2326333de3d792f855a">ucc::Buffer</a>.</p>
<p>Definition at line <a class="el" href="a00208_source.html#l02267">2267</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac722ebc172fc443a6717ca7e63d97141"></a><!-- doxytag: member="ucc::bufferof::get" ref="ac722ebc172fc443a6717ca7e63d97141" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00035.html">ucc::bufferof</a>< T >::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next typed object from the buffer. </p>
<p>This blocks until an object becomes available. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to next typed object from buffer. </dd></dl>
<p>Reimplemented from <a class="el" href="a00034.html#ab9f9b4d3e74f6e9569bd862fbe9249ea">ucc::Buffer</a>.</p>
<p>Definition at line <a class="el" href="a00208_source.html#l02259">2259</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6f57116b2e04b0b27848bc054d8bdb1e"></a><!-- doxytag: member="ucc::bufferof::put" ref="a6f57116b2e04b0b27848bc054d8bdb1e" args="(T *object, timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00035.html">ucc::bufferof</a>< T >::put </td>
<td>(</td>
<td class="paramtype">T * </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></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put (copy) an object into the buffer. </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 copy into the buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait if buffer is full. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if copied, false if timed out while full. </dd></dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02284">2284</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="a00035_a6f57116b2e04b0b27848bc054d8bdb1e_cgraph.png" border="0" usemap="#a00035_a6f57116b2e04b0b27848bc054d8bdb1e_cgraph_map" alt=""></div>
</div>
</p>
</div>
</div>
<a class="anchor" id="aec6c2d9df4a15c22150bc91f1f51caf0"></a><!-- doxytag: member="ucc::bufferof::put" ref="aec6c2d9df4a15c22150bc91f1f51caf0" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00035.html">ucc::bufferof</a>< T >::put </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put (copy) a typed object into the buffer. </p>
<p>This blocks while the buffer is full. </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 copy into the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00208_source.html#l02275">2275</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="a00035_aec6c2d9df4a15c22150bc91f1f51caf0_cgraph.png" border="0" usemap="#a00035_aec6c2d9df4a15c22150bc91f1f51caf0_cgraph_map" alt=""></div>
</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:26 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>
|