/usr/share/doc/libucommon-dev/a00055.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 | <!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::filestream 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="a00055.html">filestream</a>
</div>
</div>
<div class="contents">
<h1>ucc::filestream Class Reference</h1><!-- doxytag: class="ucc::filestream" --><!-- doxytag: inherits="std::streambuf,std::iostream" -->
<p>Streamable tcp connection between client and server.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00206_source.html">stream.h</a>></code></p>
<p>Inherits std::streambuf, and std::iostream.</p>
<div class="dynheader">
Collaboration diagram for ucc::filestream:</div>
<div class="dynsection">
<div class="center"><img src="a00395.png" border="0" usemap="#ucc_1_1filestream_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1filestream_coll__map" id="ucc_1_1filestream_coll__map">
<area shape="rect" id="node2" href="a00056.html" title="A container for generic and o/s portable threadsafe file system functions." alt="" coords="24,5,101,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 Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>access_t</b> { <b>RDONLY</b>,
<b>WRONLY</b>,
<b>RDWR</b>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73bde2c9985207e41dbb0679a2b51bb0"></a><!-- doxytag: member="ucc::filestream::close" ref="a73bde2c9985207e41dbb0679a2b51bb0" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a73bde2c9985207e41dbb0679a2b51bb0">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an active stream connection. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0a99ddbcf7cc471a4ba3b379fffa58b"></a><!-- doxytag: member="ucc::filestream::create" ref="af0a99ddbcf7cc471a4ba3b379fffa58b" args="(const char *filename, fsys::access_t access, unsigned mode, size_t buffering=512)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#af0a99ddbcf7cc471a4ba3b379fffa58b">create</a> (const char *filename, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, unsigned mode, size_t buffering=512)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a stream connection to a tcp service. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#ad879c0dbf22fe8acf0accd8a5317e2fb">error</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get error flag from last i/o operation. <a href="#ad879c0dbf22fe8acf0accd8a5317e2fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d81ef0200e1b2996306d42c2a6502e0"></a><!-- doxytag: member="ucc::filestream::filestream" ref="a0d81ef0200e1b2996306d42c2a6502e0" args="(const char *path, fsys::access_t access, size_t bufsize)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a0d81ef0200e1b2996306d42c2a6502e0">filestream</a> (const char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, size_t bufsize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open file stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3c18b1df0f6aba953c7cbf4bf251177"></a><!-- doxytag: member="ucc::filestream::filestream" ref="ae3c18b1df0f6aba953c7cbf4bf251177" args="(const char *path, fsys::access_t access, unsigned mode, size_t bufsize)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#ae3c18b1df0f6aba953c7cbf4bf251177">filestream</a> (const char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, unsigned mode, size_t bufsize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create file stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af592435d348b479c9479c11059054cc5"></a><!-- doxytag: member="ucc::filestream::filestream" ref="af592435d348b479c9479c11059054cc5" args="(const filestream &copy)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#af592435d348b479c9479c11059054cc5">filestream</a> (const <a class="el" href="a00055.html">filestream</a> &copy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create duplicate stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37273c606298f27603b5d075021c077c"></a><!-- doxytag: member="ucc::filestream::filestream" ref="a37273c606298f27603b5d075021c077c" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a37273c606298f27603b5d075021c077c">filestream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unopened pipe stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86bd688bf8baf2dc45e43729a443e684"></a><!-- doxytag: member="ucc::filestream::open" ref="a86bd688bf8baf2dc45e43729a443e684" args="(const char *filename, fsys::access_t access, size_t buffering=512)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a86bd688bf8baf2dc45e43729a443e684">open</a> (const char *filename, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, size_t buffering=512)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a stream connection to a tcp service. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a1a53903e3d6a1366302a092967423ab0">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if stream connection is active. <a href="#a1a53903e3d6a1366302a092967423ab0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a94847b740ad9edbe14aea7dc88d24c72">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if stream is disconnected. <a href="#a94847b740ad9edbe14aea7dc88d24c72"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4448e2e03d51651b82eb4c0d42de22e1"></a><!-- doxytag: member="ucc::filestream::seek" ref="a4448e2e03d51651b82eb4c0d42de22e1" args="(fsys::offset_t offset)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a4448e2e03d51651b82eb4c0d42de22e1">seek</a> (<a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">fsys::offset_t</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Seek position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#ad05c069af92a983f065c691769abfc3c">sync</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the stream input and output buffers, writes pending output. <a href="#ad05c069af92a983f065c691769abfc3c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a639b73246bcaa029af4c7b0a1d3b5c28"></a><!-- doxytag: member="ucc::filestream::~filestream" ref="a639b73246bcaa029af4c7b0a1d3b5c28" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a639b73246bcaa029af4c7b0a1d3b5c28">~filestream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a file stream. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#ab996b18fe7bd211ab1ae7192770a3505">overflow</a> (int ch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used to write the output buffer through the established pipe connection. <a href="#ab996b18fe7bd211ab1ae7192770a3505"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#ae7dd5e74f7f27a86aba015fd8c16a1e7">uflow</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. <a href="#ae7dd5e74f7f27a86aba015fd8c16a1e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html#a503b6ebaad9efd3db95509eb684b139e">underflow</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used to load the input buffer through the established pipe connection. <a href="#a503b6ebaad9efd3db95509eb684b139e"></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="a947ae357ef8c56cac983eb27fe6173df"></a><!-- doxytag: member="ucc::filestream::ac" ref="a947ae357ef8c56cac983eb27fe6173df" args="" -->
<a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> </td><td class="memItemRight" valign="bottom"><b>ac</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab51de79217465f1bd59287869a255f18"></a><!-- doxytag: member="ucc::filestream::bufsize" ref="ab51de79217465f1bd59287869a255f18" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>bufsize</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a475c134f8a9d3bf1a873ffd817aecd0f"></a><!-- doxytag: member="ucc::filestream::fd" ref="a475c134f8a9d3bf1a873ffd817aecd0f" args="" -->
<a class="el" href="a00056.html">fsys_t</a> </td><td class="memItemRight" valign="bottom"><b>fd</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecf1bdc94c2beaacae4e6c1ace7e71b9"></a><!-- doxytag: member="ucc::filestream::gbuf" ref="aecf1bdc94c2beaacae4e6c1ace7e71b9" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>gbuf</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ae150451a34689fd3f159b6d56b491b"></a><!-- doxytag: member="ucc::filestream::pbuf" ref="a9ae150451a34689fd3f159b6d56b491b" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>pbuf</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Streamable tcp connection between client and server. </p>
<p>The tcp stream class can represent a client connection to a server or an instance of a service generated by a tcp listener. As a stream class, data can be manipulated using the << and >> operators.</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="a00206_source.html#l00294">294</a> of file <a class="el" href="a00206_source.html">stream.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad879c0dbf22fe8acf0accd8a5317e2fb"></a><!-- doxytag: member="ucc::filestream::error" ref="ad879c0dbf22fe8acf0accd8a5317e2fb" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucc::filestream::error </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get error flag from last i/o operation. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>last error. </dd></dl>
<p>Definition at line <a class="el" href="a00206_source.html#l00409">409</a> of file <a class="el" href="a00206_source.html">stream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1a53903e3d6a1366302a092967423ab0"></a><!-- doxytag: member="ucc::filestream::operator bool" ref="a1a53903e3d6a1366302a092967423ab0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::filestream::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if stream connection is active. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if stream is active. </dd></dl>
<p>Definition at line <a class="el" href="a00206_source.html#l00369">369</a> of file <a class="el" href="a00206_source.html">stream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a94847b740ad9edbe14aea7dc88d24c72"></a><!-- doxytag: member="ucc::filestream::operator!" ref="a94847b740ad9edbe14aea7dc88d24c72" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::filestream::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if stream is disconnected. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if stream disconnected. </dd></dl>
<p>Definition at line <a class="el" href="a00206_source.html#l00376">376</a> of file <a class="el" href="a00206_source.html">stream.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab996b18fe7bd211ab1ae7192770a3505"></a><!-- doxytag: member="ucc::filestream::overflow" ref="ab996b18fe7bd211ab1ae7192770a3505" args="(int ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucc::filestream::overflow </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ch</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This streambuf method is used to write the output buffer through the established pipe connection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ch</em> </td><td>char to push through. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>char pushed through. </dd></dl>
</div>
</div>
<a class="anchor" id="ad05c069af92a983f065c691769abfc3c"></a><!-- doxytag: member="ucc::filestream::sync" ref="ad05c069af92a983f065c691769abfc3c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucc::filestream::sync </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flush the stream input and output buffers, writes pending output. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code. </dd></dl>
</div>
</div>
<a class="anchor" id="ae7dd5e74f7f27a86aba015fd8c16a1e7"></a><!-- doxytag: member="ucc::filestream::uflow" ref="ae7dd5e74f7f27a86aba015fd8c16a1e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucc::filestream::uflow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. </p>
<p>Also this method will handle proper use of buffers if not in interative mode.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char from pipe connection, EOF if not connected. </dd></dl>
</div>
</div>
<a class="anchor" id="a503b6ebaad9efd3db95509eb684b139e"></a><!-- doxytag: member="ucc::filestream::underflow" ref="a503b6ebaad9efd3db95509eb684b139e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucc::filestream::underflow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This streambuf method is used to load the input buffer through the established pipe connection. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char from get buffer, EOF if not connected. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00206_source.html">stream.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:29 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>
|