<!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::StreamProtocol 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="a00147.html">StreamProtocol</a>
</div>
</div>
<div class="contents">
<h1>ucommon::StreamProtocol Class Reference</h1><!-- doxytag: class="ucommon::StreamProtocol" --><!-- doxytag: inherits="std::streambuf,std::iostream,ucommon::CharacterProtocol" -->
<p>Common stream protocol for std C++ i/o classes.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00200_source.html">stream.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::StreamProtocol:</div>
<div class="dynsection">
<div class="center"><img src="a00537.png" border="0" usemap="#ucommon_1_1_stream_protocol_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_stream_protocol_inherit__map" id="ucommon_1_1_stream_protocol_inherit__map">
<area shape="rect" id="node5" href="a00051.html" title="Streamable tcp connection between client and server." alt="" coords="5,155,216,181"/><area shape="rect" id="node7" href="a00109.html" title="Streamable tcp connection between client and server." alt="" coords="240,155,451,181"/><area shape="rect" id="node9" href="a00153.html" title="Streamable tcp connection between client and server." alt="" coords="475,155,677,181"/><area shape="rect" id="node2" href="a00030.html" title="Common character processing protocol." alt="" coords="204,5,487,32"/><area shape="rect" id="node11" href="a00144.html" title="Secure socket using std::iostream." alt="" coords="485,229,667,256"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::StreamProtocol:</div>
<div class="dynsection">
<div class="center"><img src="a00538.png" border="0" usemap="#ucommon_1_1_stream_protocol_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_stream_protocol_coll__map" id="ucommon_1_1_stream_protocol_coll__map">
<area shape="rect" id="node2" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/></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="anchor" id="ad664413cee0f09e413884beb57664e1c"></a><!-- doxytag: member="ucommon::StreamProtocol::is_open" ref="ad664413cee0f09e413884beb57664e1c" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><b>is_open</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae36a6637980745f9bb4e85c0251dd62c"></a><!-- doxytag: member="ucommon::StreamProtocol::operator bool" ref="ae36a6637980745f9bb4e85c0251dd62c" args="()" -->
</td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa09f7975c4fe6f2375f6275a8243073e"></a><!-- doxytag: member="ucommon::StreamProtocol::operator!" ref="aa09f7975c4fe6f2375f6275a8243073e" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#a6cc2bc9faeb2572487447a4e82aae717">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="#a6cc2bc9faeb2572487447a4e82aae717"></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="ab2f500e55ce22a642f067c3dbeda8196"></a><!-- doxytag: member="ucommon::StreamProtocol::allocate" ref="ab2f500e55ce22a642f067c3dbeda8196" args="(size_t size)" -->
void </td><td class="memItemRight" valign="bottom"><b>allocate</b> (size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af97e1ce91f090d5b3b3c07ee016f2dfa"></a><!-- doxytag: member="ucommon::StreamProtocol::overflow" ref="af97e1ce91f090d5b3b3c07ee016f2dfa" args="(int code)" -->
int </td><td class="memItemRight" valign="bottom"><b>overflow</b> (int code)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5aeaae8ce84f2ea5875df36481b924cc"></a><!-- doxytag: member="ucommon::StreamProtocol::release" ref="a5aeaae8ce84f2ea5875df36481b924cc" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>release</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#ad6f11c50590cec92ba540d8a5643f320">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="#ad6f11c50590cec92ba540d8a5643f320"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e0b0860d54b0b2bf1f0e2a2ef6b65de"></a><!-- doxytag: member="ucommon::StreamProtocol::underflow" ref="a2e0b0860d54b0b2bf1f0e2a2ef6b65de" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>underflow</b> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affad8839da5de1604d6c3732eb6d5406"></a><!-- doxytag: member="ucommon::StreamProtocol::bufsize" ref="affad8839da5de1604d6c3732eb6d5406" 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="aeb16bb5d6bb3fdedf2d3ce120d93015c"></a><!-- doxytag: member="ucommon::StreamProtocol::gbuf" ref="aeb16bb5d6bb3fdedf2d3ce120d93015c" 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="a540423a67362a0efac38964acbeb96dd"></a><!-- doxytag: member="ucommon::StreamProtocol::pbuf" ref="a540423a67362a0efac38964acbeb96dd" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>pbuf</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common stream protocol for std C++ i/o classes. </p>
<p>This both binds the character protocol to iostream and offers a common base class for all other c++ stdlib based streaming classes. </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="a00200_source.html#l00058">58</a> of file <a class="el" href="a00200_source.html">stream.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6cc2bc9faeb2572487447a4e82aae717"></a><!-- doxytag: member="ucommon::StreamProtocol::sync" ref="a6cc2bc9faeb2572487447a4e82aae717" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::StreamProtocol::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>
<p>Reimplemented in <a class="el" href="a00144.html#a69a194b845f9d1cf8431723ec5b3cd2d">ucommon::sstream</a>.</p>
</div>
</div>
<a class="anchor" id="ad6f11c50590cec92ba540d8a5643f320"></a><!-- doxytag: member="ucommon::StreamProtocol::uflow" ref="ad6f11c50590cec92ba540d8a5643f320" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::StreamProtocol::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 interactive mode.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char from tcp socket connection, 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="a00200_source.html">stream.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:06 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>
