<!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::TCPSession 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_t_c_p_session.html">TCPSession</a>
</div>
</div>
<div class="contents">
<h1>ost::TCPSession Class Reference</h1><!-- doxytag: class="ost::TCPSession" --><!-- doxytag: inherits="ost::Thread,ost::TCPStream" -->
<p>The TCP session is used to primarily to represent a client connection that can be managed on a seperate thread.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="socket_8h_source.html">socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::TCPSession:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_t_c_p_session.png" usemap="#ost::TCPSession_map" alt=""/>
<map id="ost::TCPSession_map" name="ost::TCPSession_map">
<area href="classost_1_1_thread.html" alt="ost::Thread" shape="rect" coords="0,56,102,80"/>
<area href="classost_1_1_t_c_p_stream.html" alt="ost::TCPStream" shape="rect" coords="112,56,214,80"/>
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="112,0,214,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_t_c_p_session-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_t_c_p_session.html#a70bc06626fdd05d061772794255f64e7">TCPSession</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, size_t size=536, int pri=0, size_t stack=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a TCP socket that will be connected to a remote TCP server and that will execute under it's own thread. <a href="#a70bc06626fdd05d061772794255f64e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_session.html#a4d3b25b7a96a1ea0115182740096b824">TCPSession</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, size_t size=536, int pri=0, size_t stack=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_session.html#a25cbaa17d60d4dc693bf48bd36933231">TCPSession</a> (<a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &server, int pri=0, size_t stack=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a TCP socket from a bound TCP server by accepting a pending connection from that server and execute a thread for the accepted connection. <a href="#a25cbaa17d60d4dc693bf48bd36933231"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_session.html#af6d0c9073780fd0549b79c1131fec04f">TCPSession</a> (<a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> &server, int pri=0, size_t stack=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_session.html#a4d5b8693e78bab5c68c2e8ea1c2c024c">~TCPSession</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make sure destruction happens through a virtual. <a href="#a4d5b8693e78bab5c68c2e8ea1c2c024c"></a><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="classost_1_1_t_c_p_session.html#afed206d2ae166a3f40dbea3eab924a34">waitConnection</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normally called during the thread Initial() method by default, this will wait for the socket connection to complete when connecting to a remote socket. <a href="#afed206d2ae166a3f40dbea3eab924a34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_session.html#ad0a0568018d48cc3079222156a6af093">initial</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The initial method is used to esablish a connection when delayed completion is used. <a href="#ad0a0568018d48cc3079222156a6af093"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The TCP session is used to primarily to represent a client connection that can be managed on a seperate thread. </p>
<p>The TCP session also supports a non-blocking connection scheme which prevents blocking during the constructor and moving the process of completing a connection into the thread that executes for the session.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Threaded streamable socket with non-blocking constructor. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="tcpthread_8cpp-example.html#_a5">tcpthread.cpp</a>.</p>
</dd>
</dl><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a70bc06626fdd05d061772794255f64e7"></a><!-- doxytag: member="ost::TCPSession::TCPSession" ref="a70bc06626fdd05d061772794255f64e7" args="(const IPV4Host &host, tpport_t port, size_t size=536, int pri=0, size_t stack=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPSession::TCPSession </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">size_t </td>
<td class="paramname"> <em>size</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>pri</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>stack</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>Create a TCP socket that will be connected to a remote TCP server and that will execute under it's own thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>internet address of remote TCP server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number of remote server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of streaming buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pri</em> </td><td>execution priority relative to parent. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stack</em> </td><td>allocation needed on some platforms. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4d3b25b7a96a1ea0115182740096b824"></a><!-- doxytag: member="ost::TCPSession::TCPSession" ref="a4d3b25b7a96a1ea0115182740096b824" args="(const IPV6Host &host, tpport_t port, size_t size=536, int pri=0, size_t stack=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPSession::TCPSession </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">size_t </td>
<td class="paramname"> <em>size</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>pri</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>stack</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="a25cbaa17d60d4dc693bf48bd36933231"></a><!-- doxytag: member="ost::TCPSession::TCPSession" ref="a25cbaa17d60d4dc693bf48bd36933231" args="(TCPSocket &server, int pri=0, size_t stack=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPSession::TCPSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> & </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>pri</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>stack</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>Create a TCP socket from a bound TCP server by accepting a pending connection from that server and execute a thread for the accepted 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>server</em> </td><td>tcp socket to accept a connection from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pri</em> </td><td>execution priority relative to parent. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stack</em> </td><td>allocation needed on some platforms. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af6d0c9073780fd0549b79c1131fec04f"></a><!-- doxytag: member="ost::TCPSession::TCPSession" ref="af6d0c9073780fd0549b79c1131fec04f" args="(TCPV6Socket &server, int pri=0, size_t stack=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPSession::TCPSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> & </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>pri</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>stack</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="a4d5b8693e78bab5c68c2e8ea1c2c024c"></a><!-- doxytag: member="ost::TCPSession::~TCPSession" ref="a4d5b8693e78bab5c68c2e8ea1c2c024c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::TCPSession::~TCPSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Make sure destruction happens through a virtual. </p>
<p>.. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad0a0568018d48cc3079222156a6af093"></a><!-- doxytag: member="ost::TCPSession::initial" ref="ad0a0568018d48cc3079222156a6af093" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPSession::initial </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The initial method is used to esablish a connection when delayed completion is used. </p>
<p>This assures the constructor terminates without having to wait for a connection request to complete. </p>
<p>Reimplemented from <a class="el" href="classost_1_1_thread.html#a300c229e76725eeddc69867f7ecea91f">ost::Thread</a>.</p>
</div>
</div>
<a class="anchor" id="afed206d2ae166a3f40dbea3eab924a34"></a><!-- doxytag: member="ost::TCPSession::waitConnection" ref="afed206d2ae166a3f40dbea3eab924a34" args="(timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::TCPSession::waitConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>TIMEOUT_INF</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Normally called during the thread Initial() method by default, this will wait for the socket connection to complete when connecting to a remote socket. </p>
<p>One might wish to use <a class="el" href="classost_1_1_socket.html#a16eb72794ce956b2af6b935eb59b2e24" title="Used to specify blocking mode for the socket.">setCompletion()</a> to change the socket back to blocking I/O calls after the connection completes. To implement the session one must create a derived class which implements <a class="el" href="classost_1_1_thread.html#add7d339d94b8a1ed2b2b0324a95b7e74" title="All threads execute by deriving the Run method of Thread.">run()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, -1 if timed out. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to wait for completion in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="socket_8h_source.html">socket.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
>
371
