<!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>GNU CommonC++: ost::SSLStream 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="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>Classes</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>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_s_s_l_stream.html">SSLStream</a>
</div>
</div>
<div class="contents">
<h1>ost::SSLStream Class Reference</h1><!-- doxytag: class="ost::SSLStream" --><!-- doxytag: inherits="ost::TCPStream" -->
<p><code>#include <<a class="el" href="ssl_8h_source.html">ssl.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::SSLStream:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_s_s_l_stream.png" usemap="#ost::SSLStream_map" alt=""/>
<map id="ost::SSLStream_map" name="ost::SSLStream_map">
<area href="classost_1_1_t_c_p_stream.html" alt="ost::TCPStream" shape="rect" coords="0,56,97,80"/>
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,97,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_s_s_l_stream-members.html">List of all members.</a></p>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a560ce0910e41544b34a49201699574a7">SSLStream</a> (<a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#aecc5f6b34232ba0fef048f53fdaa51fc">family</a>=IPV4, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a005229a64cb18e6c39db5bde8f026eac">disconnect</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a6bb3e66b5864c2eca28a5e3408554b48">SSLStream</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#aafcf257f3018b88c4233a2bcad67f3a8">SSLStream</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#aea56ae075e307a3c2d69fe791fb49129">SSLStream</a> (const char *name, <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#aecc5f6b34232ba0fef048f53fdaa51fc">family</a>=IPV4, unsigned mss=536, bool throwflag=false, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a32fc6b15a428fb32ff53820d664188a5">SSLStream</a> (const <a class="el" href="classost_1_1_s_s_l_stream.html">SSLStream</a> &<a class="el" href="classost_1_1_s_s_l_stream.html#afe35b0915bbe639991afeb950dfc47f9">ssl</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a17661ac0e8e03010854fdf858bc11149">isSSL</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#ac7b0d1477500c14f7320e2e413cf000e">getSession</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#aee7eb50ad1e1e9bd9a82e4b1f50a20c3">endStream</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a15db6db6e7f66a286268ec218bbff4d8">~SSLStream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a6ea5b146a83b854ab60ed9bfc8a7b2e0">readLine</a> (char *str, size_t max, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#a2b9f7b71afaf4e23fcdc8f1fa5fea780">readData</a> (void *buf, size_t len, char separator=0, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#acc94d288d3e945c8a228e4f28f8b2d2b">writeData</a> (void *buf, size_t len, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SSL * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_s_s_l_stream.html#afe35b0915bbe639991afeb950dfc47f9">ssl</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a560ce0910e41544b34a49201699574a7"></a><!-- doxytag: member="ost::SSLStream::SSLStream" ref="a560ce0910e41544b34a49201699574a7" args="(Family family=IPV4, bool throwflag=true, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::SSLStream::SSLStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6bb3e66b5864c2eca28a5e3408554b48"></a><!-- doxytag: member="ost::SSLStream::SSLStream" ref="a6bb3e66b5864c2eca28a5e3408554b48" args="(const IPV4Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::SSLStream::SSLStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aafcf257f3018b88c4233a2bcad67f3a8"></a><!-- doxytag: member="ost::SSLStream::SSLStream" ref="aafcf257f3018b88c4233a2bcad67f3a8" args="(const IPV6Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::SSLStream::SSLStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aea56ae075e307a3c2d69fe791fb49129"></a><!-- doxytag: member="ost::SSLStream::SSLStream" ref="aea56ae075e307a3c2d69fe791fb49129" args="(const char *name, Family family=IPV4, unsigned mss=536, bool throwflag=false, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::SSLStream::SSLStream </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a32fc6b15a428fb32ff53820d664188a5"></a><!-- doxytag: member="ost::SSLStream::SSLStream" ref="a32fc6b15a428fb32ff53820d664188a5" args="(const SSLStream &ssl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::SSLStream::SSLStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_s_s_l_stream.html">SSLStream</a> & </td>
<td class="paramname"> <em>ssl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a15db6db6e7f66a286268ec218bbff4d8"></a><!-- doxytag: member="ost::SSLStream::~SSLStream" ref="a15db6db6e7f66a286268ec218bbff4d8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::SSLStream::~SSLStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a005229a64cb18e6c39db5bde8f026eac"></a><!-- doxytag: member="ost::SSLStream::disconnect" ref="a005229a64cb18e6c39db5bde8f026eac" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::SSLStream::disconnect </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_t_c_p_stream.html#a465c1772f8b6c1e1effcdfdc248622af">ost::TCPStream</a>.</p>
</div>
</div>
<a class="anchor" id="aee7eb50ad1e1e9bd9a82e4b1f50a20c3"></a><!-- doxytag: member="ost::SSLStream::endStream" ref="aee7eb50ad1e1e9bd9a82e4b1f50a20c3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::SSLStream::endStream </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_t_c_p_stream.html#ad64fb34a2a8003fac17a471060e89b39">ost::TCPStream</a>.</p>
</div>
</div>
<a class="anchor" id="ac7b0d1477500c14f7320e2e413cf000e"></a><!-- doxytag: member="ost::SSLStream::getSession" ref="ac7b0d1477500c14f7320e2e413cf000e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::SSLStream::getSession </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a17661ac0e8e03010854fdf858bc11149"></a><!-- doxytag: member="ost::SSLStream::isSSL" ref="a17661ac0e8e03010854fdf858bc11149" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::SSLStream::isSSL </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="ssl_8h_source.html#l00076">ssl</a>.</p>
</div>
</div>
<a class="anchor" id="a2b9f7b71afaf4e23fcdc8f1fa5fea780"></a><!-- doxytag: member="ost::SSLStream::readData" ref="a2b9f7b71afaf4e23fcdc8f1fa5fea780" args="(void *buf, size_t len, char separator=0, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::SSLStream::readData </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>separator</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a344ae2c256e388447f198288d2d0b41d">ost::Socket</a>.</p>
</div>
</div>
<a class="anchor" id="a6ea5b146a83b854ab60ed9bfc8a7b2e0"></a><!-- doxytag: member="ost::SSLStream::readLine" ref="a6ea5b146a83b854ab60ed9bfc8a7b2e0" args="(char *str, size_t max, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::SSLStream::readLine </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a74e77522b18ff7f10774c2fd333b99c3">ost::Socket</a>.</p>
</div>
</div>
<a class="anchor" id="acc94d288d3e945c8a228e4f28f8b2d2b"></a><!-- doxytag: member="ost::SSLStream::writeData" ref="acc94d288d3e945c8a228e4f28f8b2d2b" args="(void *buf, size_t len, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::SSLStream::writeData </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="afe35b0915bbe639991afeb950dfc47f9"></a><!-- doxytag: member="ost::SSLStream::ssl" ref="afe35b0915bbe639991afeb950dfc47f9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SSL* <a class="el" href="classost_1_1_s_s_l_stream.html#afe35b0915bbe639991afeb950dfc47f9">ost::SSLStream::ssl</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="ssl_8h_source.html#l00090">isSSL()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ssl_8h_source.html">ssl.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
307
