<!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::sstream 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="a00144.html">sstream</a>
</div>
</div>
<div class="contents">
<h1>ucommon::sstream Class Reference</h1><!-- doxytag: class="ucommon::sstream" --><!-- doxytag: inherits="ucommon::tcpstream" -->
<p>Secure socket using std::iostream.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00196_source.html">secure.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::sstream:</div>
<div class="dynsection">
<div class="center"><img src="a00531.png" border="0" usemap="#ucommon_1_1sstream_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1sstream_inherit__map" id="ucommon_1_1sstream_inherit__map">
<area shape="rect" id="node2" href="a00153.html" title="Streamable tcp connection between client and server." alt="" coords="45,155,248,181"/><area shape="rect" id="node4" href="a00147.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="21,80,272,107"/><area shape="rect" id="node6" 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>
<div class="dynheader">
Collaboration diagram for ucommon::sstream:</div>
<div class="dynsection">
<div class="center"><img src="a00532.png" border="0" usemap="#ucommon_1_1sstream_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1sstream_coll__map" id="ucommon_1_1sstream_coll__map">
<area shape="rect" id="node2" href="a00153.html" title="Streamable tcp connection between client and server." alt="" coords="45,155,248,181"/><area shape="rect" id="node4" href="a00147.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="21,80,272,107"/><area shape="rect" id="node6" 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="aa04fe65663a164ee74697969c113e30a"></a><!-- doxytag: member="ucommon::sstream::_read" ref="aa04fe65663a164ee74697969c113e30a" args="(char *address, size_t size)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><b>_read</b> (char *address, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ad80ef7c6dac246d0ec41c0117700f3"></a><!-- doxytag: member="ucommon::sstream::_wait" ref="a3ad80ef7c6dac246d0ec41c0117700f3" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><b>_wait</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3e62302b79eace374396e8ccd7984a3"></a><!-- doxytag: member="ucommon::sstream::_write" ref="ab3e62302b79eace374396e8ccd7984a3" args="(const char *address, size_t size)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><b>_write</b> (const char *address, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a676a460a7b05dac2c0d5a38eefb8734d">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an active stream connection. <a href="#a676a460a7b05dac2c0d5a38eefb8734d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affc2fb52792b8bd5663b1e519eed4497"></a><!-- doxytag: member="ucommon::sstream::flush" ref="affc2fb52792b8bd5663b1e519eed4497" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>flush</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5819eb475c716793de3753ad38df5244"></a><!-- doxytag: member="ucommon::sstream::is_secure" ref="a5819eb475c716793de3753ad38df5244" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><b>is_secure</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a329a48f98af943ab3986d56f2c19b056"></a><!-- doxytag: member="ucommon::sstream::open" ref="a329a48f98af943ab3986d56f2c19b056" args="(const char *host, const char *service, size_t size=536)" -->
void </td><td class="memItemRight" valign="bottom"><b>open</b> (const char *host, const char *service, size_t size=536)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a275bd5bf3603df5123a957df6e75cdba"></a><!-- doxytag: member="ucommon::sstream::release" ref="a275bd5bf3603df5123a957df6e75cdba" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a275bd5bf3603df5123a957df6e75cdba">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the tcp stream and destroy the underlying socket. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50b6215a84efaf41f5859a6be3904f51"></a><!-- doxytag: member="ucommon::sstream::sstream" ref="a50b6215a84efaf41f5859a6be3904f51" args="(const TCPServer *server, secure::server_t context, size_t size=536)" -->
</td><td class="memItemRight" valign="bottom"><b>sstream</b> (const <a class="el" href="a00152.html">TCPServer</a> *server, <a class="el" href="a00118.html">secure::server_t</a> context, size_t size=536)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf0e3c8d1cd1079c22d32cb8c6e24492"></a><!-- doxytag: member="ucommon::sstream::sstream" ref="adf0e3c8d1cd1079c22d32cb8c6e24492" args="(secure::client_t context)" -->
</td><td class="memItemRight" valign="bottom"><b>sstream</b> (<a class="el" href="a00118.html">secure::client_t</a> context)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#a69a194b845f9d1cf8431723ec5b3cd2d">sync</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the stream input and output buffers, writes pending output. <a href="#a69a194b845f9d1cf8431723ec5b3cd2d"></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="a144442d6b7550c62aa6b1cb8b53de904"></a><!-- doxytag: member="ucommon::sstream::bio" ref="a144442d6b7550c62aa6b1cb8b53de904" args="" -->
<a class="el" href="a00118.html#acb5b691296783537a3151eefed526887">secure::bufio_t</a> </td><td class="memItemRight" valign="bottom"><b>bio</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04879d6ae1b797b4c62eb323dfd1546e"></a><!-- doxytag: member="ucommon::sstream::server" ref="a04879d6ae1b797b4c62eb323dfd1546e" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>server</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31032dd04c72c40fa8d47d6a05dfd7b9"></a><!-- doxytag: member="ucommon::sstream::ssl" ref="a31032dd04c72c40fa8d47d6a05dfd7b9" args="" -->
<a class="el" href="a00118.html#a24631c3cad76cacbd7d4dd7d296150c9">secure::session_t</a> </td><td class="memItemRight" valign="bottom"><b>ssl</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e250373f358e75aae09dbeab3ab758a"></a><!-- doxytag: member="ucommon::sstream::verify" ref="a0e250373f358e75aae09dbeab3ab758a" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>verify</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Secure socket using std::iostream. </p>
<p>This class is similar to <a class="el" href="a00143.html" title="Secure socket buffer.">SSLBuffer</a> but uses the libstdc++ library to stream i/o. Being based on tcpstream, it also inherits the character protocol. Like <a class="el" href="a00143.html" title="Secure socket buffer.">SSLBuffer</a>, if no context is given or the handshake fails, then the stream defaults to insecure TCP connection behavior. </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="a00196_source.html#l00637">637</a> of file <a class="el" href="a00196_source.html">secure.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a676a460a7b05dac2c0d5a38eefb8734d"></a><!-- doxytag: member="ucommon::sstream::close" ref="a676a460a7b05dac2c0d5a38eefb8734d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::sstream::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 an active stream connection. </p>
<p>This does not release the socket but is a disconnect. </p>
<p>Reimplemented from <a class="el" href="a00153.html#a6b2215f96777d0ef4a8dd2eb9fcff3b3">ucommon::tcpstream</a>.</p>
</div>
</div>
<a class="anchor" id="a69a194b845f9d1cf8431723ec5b3cd2d"></a><!-- doxytag: member="ucommon::sstream::sync" ref="a69a194b845f9d1cf8431723ec5b3cd2d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::sstream::sync </td>
<td>(</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 from <a class="el" href="a00147.html#a6cc2bc9faeb2572487447a4e82aae717">ucommon::StreamProtocol</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00196_source.html">secure.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:04 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>
