/usr/share/doc/libucommon-dev/a00146.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 | <!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::shell::iobuf 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="a00142.html">shell</a>::<a class="el" href="a00146.html">iobuf</a>
</div>
</div>
<div class="contents">
<h1>ucc::shell::iobuf Class Reference</h1><!-- doxytag: class="ucc::shell::iobuf" --><!-- doxytag: inherits="ucc::IOBuffer,ucc::shell::pipeio" -->
<p>Process pipe with I/O buffering.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00204_source.html">shell.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::shell::iobuf:</div>
<div class="dynsection">
<div class="center"><img src="a00539.png" border="0" usemap="#ucc_1_1shell_1_1iobuf_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1shell_1_1iobuf_inherit__map" id="ucc_1_1shell_1_1iobuf_inherit__map">
<area shape="rect" id="node2" href="a00057.html" title="Common buffered I/O class." alt="" coords="5,5,107,35"/><area shape="rect" id="node4" href="a00149.html" title="A class to control a process that is piped." alt="" coords="131,5,256,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::shell::iobuf:</div>
<div class="dynsection">
<div class="center"><img src="a00540.png" border="0" usemap="#ucc_1_1shell_1_1iobuf_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1shell_1_1iobuf_coll__map" id="ucc_1_1shell_1_1iobuf_coll__map">
<area shape="rect" id="node2" href="a00057.html" title="Common buffered I/O class." alt="" coords="5,5,107,35"/><area shape="rect" id="node4" href="a00149.html" title="A class to control a process that is piped." alt="" coords="131,5,256,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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#a721f03b72c2202b0d68ffd08b892a572">cancel</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate child process. <a href="#a721f03b72c2202b0d68ffd08b892a572"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#a73148fe3f1e33c1db963459c262f1aab">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the i/o buffer. <a href="#a73148fe3f1e33c1db963459c262f1aab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#ac6f66c5bb2e4592bf24e8e066b0321af">iobuf</a> (const char *path, char **argv, <a class="el" href="a00142.html#af7525d05d6f9ea8f71492a42de9c528c">pmode_t</a> mode, size_t size=512, char **env=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an i/o buffer for a child process. <a href="#ac6f66c5bb2e4592bf24e8e066b0321af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#ad716feca4a0aeafed86948dde789ff27">iobuf</a> (size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an i/o buffer. <a href="#ad716feca4a0aeafed86948dde789ff27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#ae4b706c2acf4fd3da246d332862af108">open</a> (const char *path, char **argv, <a class="el" href="a00142.html#af7525d05d6f9ea8f71492a42de9c528c">pmode_t</a> mode, size_t size=512, char **env=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open the i/o buffer attached to a child process. <a href="#ae4b706c2acf4fd3da246d332862af108"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#a2e2138112c8da67a35c2f87bb2a00d59">~iobuf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy i/o buffer. <a href="#a2e2138112c8da67a35c2f87bb2a00d59"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#a9adaa2dc286acdcfc27eaac603a29614">_pull</a> (char *address, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method to pull buffer from physical i/o (read). <a href="#a9adaa2dc286acdcfc27eaac603a29614"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#ab60dd4c37e328a520f6e00ab78c9ff99">_push</a> (const char *address, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method to push buffer into physical i/o (write). <a href="#ab60dd4c37e328a520f6e00ab78c9ff99"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49e70af2c7a3eaa8894f0535560fdbc4"></a><!-- doxytag: member="ucc::shell::iobuf::shell" ref="a49e70af2c7a3eaa8894f0535560fdbc4" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>shell</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Process pipe with I/O buffering. </p>
<p>This allows the creation and management of a shell pipe with buffered I/O support. This also offers a common class to manage stdio sessions generically in the child process. </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="a00204_source.html#l00176">176</a> of file <a class="el" href="a00204_source.html">shell.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad716feca4a0aeafed86948dde789ff27"></a><!-- doxytag: member="ucc::shell::iobuf::iobuf" ref="ad716feca4a0aeafed86948dde789ff27" args="(size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shell::iobuf::iobuf </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an i/o buffer. </p>
<p>If a non-zero size is specified, then the object is attached to the process's stdin & stdout. Otherwise an un-opened object is created. </p>
</div>
</div>
<a class="anchor" id="ac6f66c5bb2e4592bf24e8e066b0321af"></a><!-- doxytag: member="ucc::shell::iobuf::iobuf" ref="ac6f66c5bb2e4592bf24e8e066b0321af" args="(const char *path, char **argv, pmode_t mode, size_t size=512, char **env=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shell::iobuf::iobuf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00142.html#af7525d05d6f9ea8f71492a42de9c528c">pmode_t</a> </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>512</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>env</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an i/o buffer for a child process. </p>
<p>This is used to create a child process directly when the object is made. It essentially is the same as the <a class="el" href="a00146.html#ae4b706c2acf4fd3da246d332862af108" title="Open the i/o buffer attached to a child process.">open()</a> method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>of program to execute, if filename uses $PATH. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>to pass to child process. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>of pipe, rdonly, wronly, or rdwr. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of buffering, and atomic pipe size if setable. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>that may be passed to child process. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2e2138112c8da67a35c2f87bb2a00d59"></a><!-- doxytag: member="ucc::shell::iobuf::~iobuf" ref="a2e2138112c8da67a35c2f87bb2a00d59" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shell::iobuf::~iobuf </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy i/o buffer. </p>
<p>This may cancel and block waiting for a child process to terminate. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9adaa2dc286acdcfc27eaac603a29614"></a><!-- doxytag: member="ucc::shell::iobuf::_pull" ref="a9adaa2dc286acdcfc27eaac603a29614" args="(char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t ucc::shell::iobuf::_pull </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method to pull buffer from physical i/o (read). </p>
<p>The address is passed to this virtual since it is hidden as private. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of buffer to pull data into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of buffer area being pulled.. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of read written, 0 on error or end of data. </dd></dl>
<p>Reimplemented from <a class="el" href="a00057.html#ad6089d06f36137661b2f0c37943a4187">ucc::IOBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="ab60dd4c37e328a520f6e00ab78c9ff99"></a><!-- doxytag: member="ucc::shell::iobuf::_push" ref="ab60dd4c37e328a520f6e00ab78c9ff99" args="(const char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t ucc::shell::iobuf::_push </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method to push buffer into physical i/o (write). </p>
<p>The address is passed to this virtual since it is hidden as private. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of data to push. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of data to push. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes written, 0 on error. </dd></dl>
<p>Reimplemented from <a class="el" href="a00057.html#abe10b39c40a9cc0ba70b9e025dec072a">ucc::IOBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="a721f03b72c2202b0d68ffd08b892a572"></a><!-- doxytag: member="ucc::shell::iobuf::cancel" ref="a721f03b72c2202b0d68ffd08b892a572" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::shell::iobuf::cancel </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Terminate child process. </p>
<p>This also waits for the child process to exit and then closes buffers. </p>
<p>Reimplemented from <a class="el" href="a00149.html#a1defcaec4f8b27791f4b896c5ebbb302">ucc::shell::pipeio</a>.</p>
</div>
</div>
<a class="anchor" id="a73148fe3f1e33c1db963459c262f1aab"></a><!-- doxytag: member="ucc::shell::iobuf::close" ref="a73148fe3f1e33c1db963459c262f1aab" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::shell::iobuf::close </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the i/o buffer. </p>
<p>If attached to a child process it will wait for the child to exit. </p>
</div>
</div>
<a class="anchor" id="ae4b706c2acf4fd3da246d332862af108"></a><!-- doxytag: member="ucc::shell::iobuf::open" ref="ae4b706c2acf4fd3da246d332862af108" args="(const char *path, char **argv, pmode_t mode, size_t size=512, char **env=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::shell::iobuf::open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00142.html#af7525d05d6f9ea8f71492a42de9c528c">pmode_t</a> </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>512</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>env</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open the i/o buffer attached to a child process. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>of program to execute, if filename uses $PATH. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>to pass to child process. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>of pipe, rdonly, wronly, or rdwr. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of buffering, and atomic pipe size if setable. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>that may be passed to child process. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00204_source.html">shell.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:46 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>
|