<!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: sstream Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00146.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>sstream Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="sstream" --><!-- doxytag: inherits="tcpstream" -->
<p>Secure socket using std::iostream.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00195_source.html">secure.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for sstream:</div>
<div class="dyncontent">
<div class="center"><img src="a00468.png" border="0" usemap="#sstream_inherit__map" alt="Inheritance graph"/></div>
<map name="sstream_inherit__map" id="sstream_inherit__map">
<area shape="rect" id="node2" href="a00155.html" title="Streamable tcp connection between client and server." alt="" coords="45,155,157,181"/><area shape="rect" id="node4" href="a00149.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="20,80,183,107"/><area shape="rect" id="node6" href="a00028.html" title="Common character processing protocol." alt="" coords="5,5,197,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for sstream:</div>
<div class="dyncontent">
<div class="center"><img src="a00469.png" border="0" usemap="#sstream_coll__map" alt="Collaboration graph"/></div>
<map name="sstream_coll__map" id="sstream_coll__map">
<area shape="rect" id="node2" href="a00155.html" title="Streamable tcp connection between client and server." alt="" coords="45,155,157,181"/><area shape="rect" id="node4" href="a00149.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="20,80,183,107"/><area shape="rect" id="node6" href="a00028.html" title="Common character processing protocol." alt="" coords="5,5,197,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac92d7f55f3285763aab4fb6cdc9c4806"></a><!-- doxytag: member="sstream::_read" ref="ac92d7f55f3285763aab4fb6cdc9c4806" 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="a5559b768c9843fcea92799fe5ea91f20"></a><!-- doxytag: member="sstream::_wait" ref="a5559b768c9843fcea92799fe5ea91f20" 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="acabf1d4b8cc8e450f74342e89f24ae3c"></a><!-- doxytag: member="sstream::_write" ref="acabf1d4b8cc8e450f74342e89f24ae3c" 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="a00146.html#a2bf19022e6a4c8612a33f18c10de34cc">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an active stream connection. <a href="#a2bf19022e6a4c8612a33f18c10de34cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5619b53441ca005ebf6ffbfd96ff7ca"></a><!-- doxytag: member="sstream::flush" ref="ab5619b53441ca005ebf6ffbfd96ff7ca" 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="aeecbe08c105b776600d0b69d01f9f2c8"></a><!-- doxytag: member="sstream::is_secure" ref="aeecbe08c105b776600d0b69d01f9f2c8" 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="af33abb4e06008c037e07809fe4ec9597"></a><!-- doxytag: member="sstream::open" ref="af33abb4e06008c037e07809fe4ec9597" 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="a4520d2ab37701f2feb32c25a0309317d"></a><!-- doxytag: member="sstream::release" ref="a4520d2ab37701f2feb32c25a0309317d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#a4520d2ab37701f2feb32c25a0309317d">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="a1769fb51359492588b528a7c94953952"></a><!-- doxytag: member="sstream::sstream" ref="a1769fb51359492588b528a7c94953952" args="(secure::client_t context)" -->
 </td><td class="memItemRight" valign="bottom"><b>sstream</b> (<a class="el" href="a00119.html">secure::client_t</a> context)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97c6028a37b31682d2181dbbdee38ce5"></a><!-- doxytag: member="sstream::sstream" ref="a97c6028a37b31682d2181dbbdee38ce5" 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="a00154.html">TCPServer</a> *server, <a class="el" href="a00119.html">secure::server_t</a> context, size_t size=536)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#afc3aef6c91c91397927cf257c138ebf7">sync</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the stream input and output buffers, writes pending output. <a href="#afc3aef6c91c91397927cf257c138ebf7"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24f635e2c4c8fc5c1b4e398f33ac739b"></a><!-- doxytag: member="sstream::bio" ref="a24f635e2c4c8fc5c1b4e398f33ac739b" args="" -->
<a class="el" href="a00119.html#ab1d63dff5d26271f6161dbf5e156bcf8">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="a72746dff339f33a2d210bee556f9c016"></a><!-- doxytag: member="sstream::server" ref="a72746dff339f33a2d210bee556f9c016" 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="abf21a8f953f4fc94adaaf6c734316136"></a><!-- doxytag: member="sstream::ssl" ref="abf21a8f953f4fc94adaaf6c734316136" args="" -->
<a class="el" href="a00119.html#adcd0244d9a8a05b793631922f90f0f17">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="a8455eeed3d5355f47ae7283858b710ba"></a><!-- doxytag: member="sstream::verify" ref="a8455eeed3d5355f47ae7283858b710ba" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>verify</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Secure socket using std::iostream. </p>
<p>This class is similar to <a class="el" href="a00145.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="a00145.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="a00195_source.html#l00593">593</a> of file <a class="el" href="a00195_source.html">secure.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2bf19022e6a4c8612a33f18c10de34cc"></a><!-- doxytag: member="sstream::close" ref="a2bf19022e6a4c8612a33f18c10de34cc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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="a00155.html#ab9b6a7577642c12d2b852b1b6e0aa1da">tcpstream</a>.</p>
</div>
</div>
<a class="anchor" id="afc3aef6c91c91397927cf257c138ebf7"></a><!-- doxytag: member="sstream::sync" ref="afc3aef6c91c91397927cf257c138ebf7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int 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="a00149.html#acf0c2903c84e54547bad7ae936bf660e">StreamProtocol</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00195_source.html">secure.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00146.html">sstream</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
