Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-updates > by-pkgid > f36f42783f75191f5f2d47f1e8c5504e > files > 374

lib64commoncpp-devel-1.8.0-5.1mdv2010.1.x86_64.rpm

<!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::TCPSocket 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;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_socket.html">TCPSocket</a>
  </div>
</div>
<div class="contents">
<h1>ost::TCPSocket Class Reference</h1><!-- doxytag: class="ost::TCPSocket" --><!-- doxytag: inherits="ost::Socket" -->
<p>TCP sockets are used for stream based connected sessions between two sockets.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="socket_8h_source.html">socket.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ost::TCPSocket:</div>
<div class="dynsection">
 <div class="center">
  <img src="classost_1_1_t_c_p_socket.png" usemap="#ost::TCPSocket_map" alt=""/>
  <map id="ost::TCPSocket_map" name="ost::TCPSocket_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,96,24"/>
</map>
 </div>
</div>

<p><a href="classost_1_1_t_c_p_socket-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">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a8ba3a6ecd27ab319e83bb6445828f7ef">onAccept</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &amp;ia, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method to call in a derived <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">TCPSocket</a> class that is acting as a server when a connection request is being accepted.  <a href="#a8ba3a6ecd27ab319e83bb6445828f7ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a58d0e49f75856b2e888e9ac894c489a2">getSocket</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fetch out the socket.  <a href="#a58d0e49f75856b2e888e9ac894c489a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#ae25df03dd4c3abd8da25e20a59ffbc62">getSegmentSize</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the buffer size for servers.  <a href="#ae25df03dd4c3abd8da25e20a59ffbc62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a8d86e9b2df64e14b4aebe9cd38903c73">TCPSocket</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &amp;bind, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned backlog=5, unsigned mss=536)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#a8d86e9b2df64e14b4aebe9cd38903c73"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a94e6b4e3dc2906799ea2fa7367c7eadb">TCPSocket</a> (const char *name, unsigned backlog=5, unsigned mss=536)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a named tcp socket by service and/or interface id.  <a href="#a94e6b4e3dc2906799ea2fa7367c7eadb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#abb20f4723de2e9641528d9c82f9389d1">getRequest</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return address and port of next connection request.  <a href="#abb20f4723de2e9641528d9c82f9389d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a22c104eee3b3494189754f25f1d7075e">reject</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to reject the next incoming connection request.  <a href="#a22c104eee3b3494189754f25f1d7075e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#aa0779bf0973ae5b54a5f323ef62ab4ae">getLocal</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to get local bound address.  <a href="#aa0779bf0973ae5b54a5f323ef62ab4ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a112e8235b317f15e15f6ea264fe81eb7">isPendingConnection</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to wait for pending connection requests.  <a href="#a112e8235b317f15e15f6ea264fe81eb7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a64201dd76b9d05cba0ea2db73b4bdd6b">~TCPSocket</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use base socket handler for ending this socket.  <a href="#a64201dd76b9d05cba0ea2db73b4bdd6b"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a7dc58365b578003db6679097965ef42c">setSegmentSize</a> (unsigned mss)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_socket.html#a926afdde97f8074cfe21a6c0d23830ed">segsize</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>TCP sockets are used for stream based connected sessions between two sockets. </p>
<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>
<p>An implicit and unique <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">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" title="TCP streams are used to represent TCP client connections to a server by TCP protocol...">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" title="TCP sockets are used for stream based connected sessions between two sockets.">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>
<p>The <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">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" title="TCP streams are used to represent TCP client connections to a server by TCP protocol...">TCPStream</a> related object is created from a <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">TCPSocket</a>. By creating a <a class="el" href="classost_1_1_t_c_p_stream.html" title="TCP streams are used to represent TCP client connections to a server by TCP protocol...">TCPStream</a> from a <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">TCPSocket</a>, an accept operation automatically occurs, and the <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">TCPSocket</a> can then still reject the client connection through the return status of it's OnAccept method.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@tycho.com">dyfet@tycho.com</a>&gt; bound server for TCP streams and sessions. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="tcp_8cpp-example.html#_a0">tcp.cpp</a>, <a class="el" href="tcpservice_8cpp-example.html#_a2">tcpservice.cpp</a>, <a class="el" href="tcpstr1_8cpp-example.html#_a6">tcpstr1.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#_a0">tcpthread.cpp</a>.</p>
</dd>
</dl><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8d86e9b2df64e14b4aebe9cd38903c73"></a><!-- doxytag: member="ost::TCPSocket::TCPSocket" ref="a8d86e9b2df64e14b4aebe9cd38903c73" args="(const IPV4Address &amp;bind, tpport_t port, unsigned backlog=5, unsigned mss=536)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::TCPSocket::TCPSocket </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>bind</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a>&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>backlog</em> = <code>5</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>mss</em> = <code>536</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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>
<p>If the server cannot be created, an exception is thrown.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>bind</em>&nbsp;</td><td>local ip address or interface to use. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>number to bind socket under. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>backlog</em>&nbsp;</td><td>size of connection request queue. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mss</em>&nbsp;</td><td>maximum segment size for accepted streams. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a94e6b4e3dc2906799ea2fa7367c7eadb"></a><!-- doxytag: member="ost::TCPSocket::TCPSocket" ref="a94e6b4e3dc2906799ea2fa7367c7eadb" args="(const char *name, unsigned backlog=5, unsigned mss=536)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::TCPSocket::TCPSocket </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>backlog</em> = <code>5</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>mss</em> = <code>536</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a named tcp socket by service and/or interface id. </p>
<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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of host interface and service port to bind. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>backlog</em>&nbsp;</td><td>size of connection request queue. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mss</em>&nbsp;</td><td>maximum segment size for streaming buffers. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a64201dd76b9d05cba0ea2db73b4bdd6b"></a><!-- doxytag: member="ost::TCPSocket::~TCPSocket" ref="a64201dd76b9d05cba0ea2db73b4bdd6b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ost::TCPSocket::~TCPSocket </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Use base socket handler for ending this socket. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa0779bf0973ae5b54a5f323ef62ab4ae"></a><!-- doxytag: member="ost::TCPSocket::getLocal" ref="aa0779bf0973ae5b54a5f323ef62ab4ae" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::TCPSocket::getLocal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *&nbsp;</td>
          <td class="paramname"> <em>port</em> = <code>NULL</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to get local bound address. </p>

<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#aca71d871bfda4dfcab0891cb0c8df1d4">ost::Socket</a>.</p>

<p>References <a class="el" href="classost_1_1_socket.html#af72396adf4cac5113e722447e48b7916">ost::Socket::getIPV4Local()</a>.</p>

</div>
</div>
<a class="anchor" id="abb20f4723de2e9641528d9c82f9389d1"></a><!-- doxytag: member="ost::TCPSocket::getRequest" ref="abb20f4723de2e9641528d9c82f9389d1" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::TCPSocket::getRequest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *&nbsp;</td>
          <td class="paramname"> <em>port</em> = <code>NULL</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return address and port of next connection request. </p>
<p>This can be used instead of OnAccept() to pre-evaluate connection requests.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>host requesting a connection. </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>port</em>&nbsp;</td><td>number of requestor. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="classost_1_1_socket.html#a68a7acd6af1686e66e88e9e466a9903f">ost::Socket::getIPV4Sender()</a>.</p>

</div>
</div>
<a class="anchor" id="ae25df03dd4c3abd8da25e20a59ffbc62"></a><!-- doxytag: member="ost::TCPSocket::getSegmentSize" ref="ae25df03dd4c3abd8da25e20a59ffbc62" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ost::TCPSocket::getSegmentSize </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the buffer size for servers. </p>

</div>
</div>
<a class="anchor" id="a58d0e49f75856b2e888e9ac894c489a2"></a><!-- doxytag: member="ost::TCPSocket::getSocket" ref="a58d0e49f75856b2e888e9ac894c489a2" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> ost::TCPSocket::getSocket </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Fetch out the socket. </p>

</div>
</div>
<a class="anchor" id="a112e8235b317f15e15f6ea264fe81eb7"></a><!-- doxytag: member="ost::TCPSocket::isPendingConnection" ref="a112e8235b317f15e15f6ea264fe81eb7" args="(timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ost::TCPSocket::isPendingConnection </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>TIMEOUT_INF</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to wait for pending connection requests. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if data packets available. </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>&nbsp;</td><td>in milliseconds. TIMEOUT_INF if not specified. </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcpstr1_8cpp-example.html#a7">tcpstr1.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#a12">tcpthread.cpp</a>.</dd>
</dl>
<p>References <a class="el" href="classost_1_1_socket.html#a8eb84be4b5cc91731c16be4f32f5bf3d">ost::Socket::isPending()</a>, and <a class="el" href="socket_8h_source.html#l00175">ost::Socket::pendingInput</a>.</p>

</div>
</div>
<a class="anchor" id="a8ba3a6ecd27ab319e83bb6445828f7ef"></a><!-- doxytag: member="ost::TCPSocket::onAccept" ref="a8ba3a6ecd27ab319e83bb6445828f7ef" args="(const IPV4Host &amp;ia, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ost::TCPSocket::onAccept </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ia</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a>&nbsp;</td>
          <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A method to call in a derived <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">TCPSocket</a> class that is acting as a server when a connection request is being accepted. </p>
<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 class="return"><dt><b>Returns:</b></dt><dd>true if client should be accepted. </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>ia</em>&nbsp;</td><td>internet host address of the client. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>number of the client. </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcp_8cpp-example.html#a1">tcp.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#a1">tcpthread.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a22c104eee3b3494189754f25f1d7075e"></a><!-- doxytag: member="ost::TCPSocket::reject" ref="a22c104eee3b3494189754f25f1d7075e" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::TCPSocket::reject </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to reject the next incoming connection request. </p>

</div>
</div>
<a class="anchor" id="a7dc58365b578003db6679097965ef42c"></a><!-- doxytag: member="ost::TCPSocket::setSegmentSize" ref="a7dc58365b578003db6679097965ef42c" args="(unsigned mss)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::TCPSocket::setSegmentSize </td>
          <td>(</td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>mss</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a926afdde97f8074cfe21a6c0d23830ed"></a><!-- doxytag: member="ost::TCPSocket::segsize" ref="a926afdde97f8074cfe21a6c0d23830ed" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classost_1_1_t_c_p_socket.html#a926afdde97f8074cfe21a6c0d23830ed">ost::TCPSocket::segsize</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</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:57:40 2010 for GNU CommonC++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>