<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TCPSocket class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:33:01 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>TCPSocket Class Reference</h1>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_h-source.html">socket.h</a>></code>
<p>
<p>Inheritance diagram for TCPSocket:
<p><center><img src="class_tcpsocket.gif" usemap="#TCPSocket_map" border="0"></center>
<map name="TCPSocket_map">
<area href="class_socket.html" alt="Socket" shape="rect" coords="0,0,74,24">
</map>
<a href="class_tcpsocket-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_tcpsocket.html#a0">TCPSocket</a> (const <a class="el" href="class_inetaddress.html">InetAddress</a> &bind, <a class="el" href="socket_h.html#a2">tpport_t</a> port, int backlog=5)</td></tr>
<tr><td> </td><td><font size=-1><em>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.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_inethostaddress.html">InetHostAddress</a> </td><td valign=bottom><a class="el" href="class_tcpsocket.html#a1">getRequest</a> (<a class="el" href="socket_h.html#a2">tpport_t</a> *port=NULL) const</td></tr>
<tr><td> </td><td><font size=-1><em>Return address and port of next connection request.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_tcpsocket.html#a2">Reject</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to reject the next incoming connection request.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_inethostaddress.html">InetHostAddress</a> </td><td valign=bottom><a class="el" href="class_tcpsocket.html#a3">getLocal</a> (<a class="el" href="socket_h.html#a2">tpport_t</a> *port=NULL) const</td></tr>
<tr><td> </td><td><font size=-1><em>Used to get local bound address.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_tcpsocket.html#a4">isPendingConnection</a> (<a class="el" href="thread_h.html#a1">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td> </td><td><font size=-1><em>not const -- jfc.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_tcpsocket.html#a5">~TCPSocket</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Use base socket handler for ending this socket.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_tcpsocket.html#b0">OnAccept</a> (const <a class="el" href="class_inethostaddress.html">InetHostAddress</a> &ia, <a class="el" href="socket_h.html#a2">tpport_t</a> port)</td></tr>
<tr><td> </td><td><font size=-1><em>A method to call in a derived TCPSocket class that is acting as a server when a connection request is being accepted.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="#l0">TCPStream</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="#l1">SocketPort</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="#l2">tcpstream</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 TCPSocket 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="class_tcpstream.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++ TCPSocket 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 TCPSocket also supports a "OnAccept" method which can be called when a <a class="el" href="class_tcpstream.html">TCPStream</a> related object is created from a TCPSocket. By creating a <a class="el" href="class_tcpstream.html">TCPStream</a> from a TCPSocket, an accept operation automatically occurs, and the TCPSocket can then still reject the client connection through the return status of it's OnAccept method.
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
David Sugar <<a href="mailto:dyfet@tycho.com">dyfet@tycho.com</a>> </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="TCPSocket::TCPSocket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TCPSocket::TCPSocket (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="class_inetaddress.html">InetAddress</a> & <em>bind</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="socket_h.html#a2">tpport_t</a> <em>port</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>backlog</em> = 5 )
</b></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.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>bind</em>
</td><td>
local ip address or interface to use. </td></tr>
<tr><td valign=top><em>port</em>
</td><td>
number to bind socket under. </td></tr>
<tr><td valign=top><em>backlog</em>
</td><td>
size of connection request queue. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a5" doxytag="TCPSocket::~TCPSocket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TCPSocket::~TCPSocket (
</b></td>
<td valign="bottom"><b>
)<code> [inline]</code>
</b></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 name="b0" doxytag="TCPSocket::OnAccept"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> TCPSocket::OnAccept (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="class_inethostaddress.html">InetHostAddress</a> & <em>ia</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="socket_h.html#a2">tpport_t</a> <em>port</em> )<code> [inline, protected, virtual]</code>
</b></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 TCPSocket 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><dd>
true if client should be accepted. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ia</em>
</td><td>
internet host address of the client. </td></tr>
<tr><td valign=top><em>port</em>
</td><td>
number of the client. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="TCPSocket::Reject"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void TCPSocket::Reject (
</b></td>
<td valign="bottom"><b>
void )
</b></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 name="a3" doxytag="TCPSocket::getLocal"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_inethostaddress.html">InetHostAddress</a> TCPSocket::getLocal (
</b></td>
<td valign="bottom"><b>
<a class="el" href="socket_h.html#a2">tpport_t</a> * <em>port</em> = NULL ) const<code> [inline]</code>
</b></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="class_socket.html#a4">Socket</a>. </td>
</tr>
</table>
<a name="a1" doxytag="TCPSocket::getRequest"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_inethostaddress.html">InetHostAddress</a> TCPSocket::getRequest (
</b></td>
<td valign="bottom"><b>
<a class="el" href="socket_h.html#a2">tpport_t</a> * <em>port</em> = NULL ) const<code> [inline]</code>
</b></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 <a class="el" href="class_tcpsocket.html#b0">OnAccept</a>() to pre-evaluate connection requests.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
host requesting a connection. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>port</em>
</td><td>
number of requestor. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="TCPSocket::isPendingConnection"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="config_h.html#a17">bool</a> TCPSocket::isPendingConnection (
</b></td>
<td valign="bottom"><b>
<a class="el" href="thread_h.html#a1">timeout_t</a> <em>timeout</em> = TIMEOUT_INF )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
not const -- jfc.
<p>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l1" doxytag="TCPSocket::SocketPort"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
class SocketPort<code> [friend]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l0" doxytag="TCPSocket::TCPStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
class TCPStream<code> [friend]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l2" doxytag="TCPSocket::tcpstream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
class tcpstream<code> [friend]</code>
</b></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_h-source.html">socket.h</a></ul>
<hr><address><small>Generated at Thu Oct 4 15:33:02 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
378
