<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::TCPSocket Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a></div>
<h1>ost::TCPSocket Class Reference</h1><!-- doxytag: class="ost::TCPSocket" --><!-- doxytag: inherits="ost::Socket" -->TCP sockets are used for stream based connected sessions between two sockets.bound server for TCP streams and sessions.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="socket_8h-source.html">socket.h</a>></code>
<p>
<p>Inheritance diagram for ost::TCPSocket:
<p><center><img src="classost_1_1_t_c_p_socket.png" usemap="#ost::TCPSocket_map" border="0" alt=""></center>
<map name="ost::TCPSocket_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,96,24">
</map>
<a href="classost_1_1_t_c_p_socket-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#8ba3a6ecd27ab319e83bb6445828f7ef">onAccept</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &ia, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A method to call in a derived <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> class that is acting as a server when a connection request is being accepted. <a href="#8ba3a6ecd27ab319e83bb6445828f7ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#58d0e49f75856b2e888e9ac894c489a2">getSocket</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch out the socket. <a href="#58d0e49f75856b2e888e9ac894c489a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#e25df03dd4c3abd8da25e20a59ffbc62">getSegmentSize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer size for servers. <a href="#e25df03dd4c3abd8da25e20a59ffbc62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#8d86e9b2df64e14b4aebe9cd38903c73">TCPSocket</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &bind, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned backlog=5, unsigned mss=536)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A TCP "server" is created as a TCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests. <a href="#8d86e9b2df64e14b4aebe9cd38903c73"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#94e6b4e3dc2906799ea2fa7367c7eadb">TCPSocket</a> (const char *name, unsigned backlog=5, unsigned mss=536)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named tcp socket by service and/or interface id. <a href="#94e6b4e3dc2906799ea2fa7367c7eadb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#bb20f4723de2e9641528d9c82f9389d1">getRequest</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return address and port of next connection request. <a href="#bb20f4723de2e9641528d9c82f9389d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#22c104eee3b3494189754f25f1d7075e">reject</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to reject the next incoming connection request. <a href="#22c104eee3b3494189754f25f1d7075e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a0779bf0973ae5b54a5f323ef62ab4ae">getLocal</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to get local bound address. <a href="#a0779bf0973ae5b54a5f323ef62ab4ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#112e8235b317f15e15f6ea264fe81eb7">isPendingConnection</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to wait for pending connection requests. <a href="#112e8235b317f15e15f6ea264fe81eb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#64201dd76b9d05cba0ea2db73b4bdd6b">~TCPSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use base socket handler for ending this socket. <a href="#64201dd76b9d05cba0ea2db73b4bdd6b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#7dc58365b578003db6679097965ef42c">setSegmentSize</a> (unsigned mss)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#926afdde97f8074cfe21a6c0d23830ed">segsize</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
TCP sockets are used for stream based connected sessions between two sockets.bound server for TCP streams and sessions.
<p>
Both error recovery and flow control operate transparently for a TCP socket connection. The TCP socket base class is primary used to bind a TCP "server" for accepting TCP streams.<p>
An implicit and unique <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> object exists in Common C++ to represent a bound TCP socket acting as a "server" for receiving connection requests. This class is not part of <a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> because such objects normally perform no physical I/O (read or write operations) other than to specify a listen backlog queue and perform "accept" operations for pending connections. The Common C++ <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> offers a Peek method to examine where the next pending connection is coming from, and a Reject method to flush the next request from the queue without having to create a session.<p>
The <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> also supports a "OnAccept" method which can be called when a <a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> related object is created from a <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a>. By creating a <a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> from a <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a>, an accept operation automatically occurs, and the <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> can then still reject the client connection through the return status of it's OnAccept method.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@tycho.com">dyfet@tycho.com</a>> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="tcp_8cpp-example.html#_a34">tcp.cpp</a>, <a class="el" href="tcpservice_8cpp-example.html#_a47">tcpservice.cpp</a>, <a class="el" href="tcpstr1_8cpp-example.html#_a71">tcpstr1.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#_a73">tcpthread.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8d86e9b2df64e14b4aebe9cd38903c73"></a><!-- doxytag: member="ost::TCPSocket::TCPSocket" ref="8d86e9b2df64e14b4aebe9cd38903c73" args="(const IPV4Address &bind, tpport_t port, unsigned backlog=5, unsigned mss=536)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPSocket::TCPSocket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname" nowrap> <em>bind</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>backlog</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A TCP "server" is created as a TCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests.
<p>
If the server cannot be created, an exception is thrown.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bind</em> </td><td>local ip address or interface to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to bind socket under. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backlog</em> </td><td>size of connection request queue. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mss</em> </td><td>maximum segment size for accepted streams. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="94e6b4e3dc2906799ea2fa7367c7eadb"></a><!-- doxytag: member="ost::TCPSocket::TCPSocket" ref="94e6b4e3dc2906799ea2fa7367c7eadb" args="(const char *name, unsigned backlog=5, unsigned mss=536)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPSocket::TCPSocket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>backlog</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a named tcp socket by service and/or interface id.
<p>
For IPV4 we use [host:]svc or [host/]svc for the string. If we have getaddrinfo, we use that to obtain the addr to bind for.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of host interface and service port to bind. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backlog</em> </td><td>size of connection request queue. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mss</em> </td><td>maximum segment size for streaming buffers. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="64201dd76b9d05cba0ea2db73b4bdd6b"></a><!-- doxytag: member="ost::TCPSocket::~TCPSocket" ref="64201dd76b9d05cba0ea2db73b4bdd6b" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::TCPSocket::~TCPSocket </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Use base socket handler for ending this socket.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0779bf0973ae5b54a5f323ef62ab4ae"></a><!-- doxytag: member="ost::TCPSocket::getLocal" ref="a0779bf0973ae5b54a5f323ef62ab4ae" args="(tpport_t *port=NULL) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::TCPSocket::getLocal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to get local bound address.
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#ca71d871bfda4dfcab0891cb0c8df1d4">ost::Socket</a>. </td>
</tr>
</table>
<a class="anchor" name="bb20f4723de2e9641528d9c82f9389d1"></a><!-- doxytag: member="ost::TCPSocket::getRequest" ref="bb20f4723de2e9641528d9c82f9389d1" args="(tpport_t *port=NULL) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::TCPSocket::getRequest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return address and port of next connection request.
<p>
This can be used instead of OnAccept() to pre-evaluate connection requests.<p>
<dl compact><dt><b>Returns:</b></dt><dd>host requesting a connection. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number of requestor. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e25df03dd4c3abd8da25e20a59ffbc62"></a><!-- doxytag: member="ost::TCPSocket::getSegmentSize" ref="e25df03dd4c3abd8da25e20a59ffbc62" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::TCPSocket::getSegmentSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the buffer size for servers.
<p>
</td>
</tr>
</table>
<a class="anchor" name="58d0e49f75856b2e888e9ac894c489a2"></a><!-- doxytag: member="ost::TCPSocket::getSocket" ref="58d0e49f75856b2e888e9ac894c489a2" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> ost::TCPSocket::getSocket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Fetch out the socket.
<p>
</td>
</tr>
</table>
<a class="anchor" name="112e8235b317f15e15f6ea264fe81eb7"></a><!-- doxytag: member="ost::TCPSocket::isPendingConnection" ref="112e8235b317f15e15f6ea264fe81eb7" args="(timeout_t timeout=TIMEOUT_INF)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::TCPSocket::isPendingConnection </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> = <code>TIMEOUT_INF</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to wait for pending connection requests.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if data packets available. </dd></dl>
<dl compact><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>in milliseconds. TIMEOUT_INF if not specified. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpstr1_8cpp-example.html#a72">tcpstr1.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#a85">tcpthread.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="8ba3a6ecd27ab319e83bb6445828f7ef"></a><!-- doxytag: member="ost::TCPSocket::onAccept" ref="8ba3a6ecd27ab319e83bb6445828f7ef" args="(const IPV4Host &ia, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool ost::TCPSocket::onAccept </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="mdname" nowrap> <em>ia</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A method to call in a derived <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> class that is acting as a server when a connection request is being accepted.
<p>
The server can implement protocol specific rules to exclude the remote socket from being accepted by returning false. The Peek method can also be used for this purpose.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if client should be accepted. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ia</em> </td><td>internet host address of the client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number of the client. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp_8cpp-example.html#a35">tcp.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#a74">tcpthread.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="22c104eee3b3494189754f25f1d7075e"></a><!-- doxytag: member="ost::TCPSocket::reject" ref="22c104eee3b3494189754f25f1d7075e" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPSocket::reject </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to reject the next incoming connection request.
<p>
</td>
</tr>
</table>
<a class="anchor" name="7dc58365b578003db6679097965ef42c"></a><!-- doxytag: member="ost::TCPSocket::setSegmentSize" ref="7dc58365b578003db6679097965ef42c" args="(unsigned mss)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPSocket::setSegmentSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned </td>
<td class="mdname1" valign="top" nowrap> <em>mss</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="926afdde97f8074cfe21a6c0d23830ed"></a><!-- doxytag: member="ost::TCPSocket::segsize" ref="926afdde97f8074cfe21a6c0d23830ed" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="classost_1_1_t_c_p_socket.html#926afdde97f8074cfe21a6c0d23830ed">ost::TCPSocket::segsize</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
