<!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: ucommon::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="a00208.html">ucommon</a>::<a class="el" href="a00129.html">shell</a>::<a class="el" href="a00135.html">iobuf</a>
</div>
</div>
<div class="contents">
<h1>ucommon::shell::iobuf Class Reference</h1><!-- doxytag: class="ucommon::shell::iobuf" --><!-- doxytag: inherits="ucommon::BufferProtocol,ucommon::shell::pipeio" -->
<p>Process pipe with I/O buffering.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00197_source.html">shell.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::shell::iobuf:</div>
<div class="dynsection">
<div class="center"><img src="a00517.png" border="0" usemap="#ucommon_1_1shell_1_1iobuf_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1shell_1_1iobuf_inherit__map" id="ucommon_1_1shell_1_1iobuf_inherit__map">
<area shape="rect" id="node2" href="a00028.html" title="Common buffer protocol class." alt="" coords="21,80,272,107"/><area shape="rect" id="node4" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/><area shape="rect" id="node6" href="a00138.html" title="A class to control a process that is piped." alt="" coords="296,80,539,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::shell::iobuf:</div>
<div class="dynsection">
<div class="center"><img src="a00518.png" border="0" usemap="#ucommon_1_1shell_1_1iobuf_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1shell_1_1iobuf_coll__map" id="ucommon_1_1shell_1_1iobuf_coll__map">
<area shape="rect" id="node2" href="a00028.html" title="Common buffer protocol class." alt="" coords="21,80,272,107"/><area shape="rect" id="node4" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/><area shape="rect" id="node6" href="a00138.html" title="A class to control a process that is piped." alt="" coords="296,80,539,107"/></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="a00135.html#af35b2959ad71e83e836faea9b0188ed2">cancel</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate child process. <a href="#af35b2959ad71e83e836faea9b0188ed2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#a11f4ea9222679bee518048b5d6e4863a">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the i/o buffer. <a href="#a11f4ea9222679bee518048b5d6e4863a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#a1cf950515213b4eba70046de1a5142bf">iobuf</a> (char *path, char **argv, <a class="el" href="a00129.html#af9ecb49c552362dc89694221e4de7de5">pmode_t</a> mode, size_t size=512, char **env=((void *) 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an i/o buffer for a child process. <a href="#a1cf950515213b4eba70046de1a5142bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#aad7bc3b62923122c6f87ee5b9b8ceb75">iobuf</a> (size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an i/o buffer. <a href="#aad7bc3b62923122c6f87ee5b9b8ceb75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#a9841c2087209ad9b36497960c0d2b63e">open</a> (char *path, char **argv, <a class="el" href="a00129.html#af9ecb49c552362dc89694221e4de7de5">pmode_t</a> mode, size_t size=512, char **env=((void *) 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open the i/o buffer attached to a child process. <a href="#a9841c2087209ad9b36497960c0d2b63e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#aecb63d1bf9e41572d17ce992cb5bcde7">~iobuf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy i/o buffer. <a href="#aecb63d1bf9e41572d17ce992cb5bcde7"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d13ff40dd8475490506f0eddc5c7cf3"></a><!-- doxytag: member="ucommon::shell::iobuf::_clear" ref="a7d13ff40dd8475490506f0eddc5c7cf3" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#a7d13ff40dd8475490506f0eddc5c7cf3">_clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method to clear low level i/o error. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2202084ea96db3ad67f583256c286006"></a><!-- doxytag: member="ucommon::shell::iobuf::_err" ref="a2202084ea96db3ad67f583256c286006" args="(void)" -->
virtual int </td><td class="memItemRight" valign="bottom"><b>_err</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#aea2201eee30b3bc0ffb4dbf13cde4190">_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="#aea2201eee30b3bc0ffb4dbf13cde4190"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bad04e24d7f74a4ed11cfd18f9b6c4e"></a><!-- doxytag: member="ucommon::shell::iobuf::_push" ref="a7bad04e24d7f74a4ed11cfd18f9b6c4e" args="(char *address, size_t size)" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><b>_push</b> (char *address, size_t size)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93d0d93bfaa05ddec9aaa43c31a3ac8a"></a><!-- doxytag: member="ucommon::shell::iobuf::ioerror" ref="a93d0d93bfaa05ddec9aaa43c31a3ac8a" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>ioerror</b></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="ucommon::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="a00197_source.html#l00225">225</a> of file <a class="el" href="a00197_source.html">shell.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aad7bc3b62923122c6f87ee5b9b8ceb75"></a><!-- doxytag: member="ucommon::shell::iobuf::iobuf" ref="aad7bc3b62923122c6f87ee5b9b8ceb75" args="(size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::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="a1cf950515213b4eba70046de1a5142bf"></a><!-- doxytag: member="ucommon::shell::iobuf::iobuf" ref="a1cf950515213b4eba70046de1a5142bf" args="(char *path, char **argv, pmode_t mode, size_t size=512, char **env=((void *) 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::shell::iobuf::iobuf </td>
<td>(</td>
<td class="paramtype">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="a00129.html#af9ecb49c552362dc89694221e4de7de5">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>((void *) 0)</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="a00135.html#a9841c2087209ad9b36497960c0d2b63e" 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 settable. </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="aecb63d1bf9e41572d17ce992cb5bcde7"></a><!-- doxytag: member="ucommon::shell::iobuf::~iobuf" ref="aecb63d1bf9e41572d17ce992cb5bcde7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::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="aea2201eee30b3bc0ffb4dbf13cde4190"></a><!-- doxytag: member="ucommon::shell::iobuf::_pull" ref="aea2201eee30b3bc0ffb4dbf13cde4190" args="(char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t ucommon::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>Implements <a class="el" href="a00028.html#ad9add3680f74ccacc47283a1b2a18b2f">ucommon::BufferProtocol</a>.</p>
</div>
</div>
<a class="anchor" id="af35b2959ad71e83e836faea9b0188ed2"></a><!-- doxytag: member="ucommon::shell::iobuf::cancel" ref="af35b2959ad71e83e836faea9b0188ed2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::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="a00138.html#a2fb95be83234eedc98dba11314c4d3d5">ucommon::shell::pipeio</a>.</p>
</div>
</div>
<a class="anchor" id="a11f4ea9222679bee518048b5d6e4863a"></a><!-- doxytag: member="ucommon::shell::iobuf::close" ref="a11f4ea9222679bee518048b5d6e4863a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::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="a9841c2087209ad9b36497960c0d2b63e"></a><!-- doxytag: member="ucommon::shell::iobuf::open" ref="a9841c2087209ad9b36497960c0d2b63e" args="(char *path, char **argv, pmode_t mode, size_t size=512, char **env=((void *) 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::shell::iobuf::open </td>
<td>(</td>
<td class="paramtype">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="a00129.html#af9ecb49c552362dc89694221e4de7de5">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>((void *) 0)</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 settable. </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="a00197_source.html">shell.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:00 2011 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>
