diff options
| author | Erwin Nindl <nine@wirdorange.org> | 2007-10-07 22:07:03 +0000 |
|---|---|---|
| committer | Erwin Nindl <nine@wirdorange.org> | 2007-10-07 22:07:03 +0000 |
| commit | 7763f07327f3abce839a690df46ced3bfd1d3d09 (patch) | |
| tree | c80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/classTCPSocket.html | |
| parent | added doxygen, and doxygen makefile target (diff) | |
added doxygen generatet documentation
Diffstat (limited to 'doc/html/classTCPSocket.html')
| -rw-r--r-- | doc/html/classTCPSocket.html | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/doc/html/classTCPSocket.html b/doc/html/classTCPSocket.html new file mode 100644 index 0000000..b757215 --- /dev/null +++ b/doc/html/classTCPSocket.html @@ -0,0 +1,153 @@ +<!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>anytun: 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.5.1 --> +<div class="tabs"> + <ul> + <li><a href="main.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li id="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <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> +<h1>TCPSocket Class Reference</h1><!-- doxytag: class="TCPSocket" --><!-- doxytag: inherits="CommunicatingSocket" --><code>#include <<a class="el" href="PracticalSocket_8h-source.html">PracticalSocket.h</a>></code> +<p> +<p>Inheritance diagram for TCPSocket: +<p><center><img src="classTCPSocket.png" usemap="#TCPSocket_map" border="0" alt=""></center> +<map name="TCPSocket_map"> +<area href="classCommunicatingSocket.html" alt="CommunicatingSocket" shape="rect" coords="0,56,135,80"> +<area href="classSocket.html" alt="Socket" shape="rect" coords="0,0,135,24"> +</map> +<a href="classTCPSocket-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCPSocket.html#7a50427a401d1a6f3209d51818bad901">TCPSocket</a> () throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCPSocket.html#7b246b66f6dc3246ab2777b771e5f917">TCPSocket</a> (const string &foreignAddress, unsigned short foreignPort) throw (SocketException)</td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCPSocket.html#4763ac3be0d7d5e143884bef45e351c5">TCPSocket</a> (int newConnSD)</td></tr> + +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCPSocket.html#e8bcdc0d25881a17b23e557296236fa9">TCPServerSocket</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +TCP socket for communication with other TCP sockets +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="7a50427a401d1a6f3209d51818bad901"></a><!-- doxytag: member="TCPSocket::TCPSocket" ref="7a50427a401d1a6f3209d51818bad901" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TCPSocket::TCPSocket </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Construct a TCP socket with no connection <dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to create TCP socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="7b246b66f6dc3246ab2777b771e5f917"></a><!-- doxytag: member="TCPSocket::TCPSocket" ref="7b246b66f6dc3246ab2777b771e5f917" args="(const string &foreignAddress, unsigned short foreignPort)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TCPSocket::TCPSocket </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"> <em>foreignAddress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned short </td> + <td class="paramname"> <em>foreignPort</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Construct a TCP socket with a connection to the given foreign address and port <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>foreignAddress</em> </td><td>foreign address (IP address or name) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>foreignPort</em> </td><td>foreign port </td></tr> + </table> +</dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to create TCP socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="4763ac3be0d7d5e143884bef45e351c5"></a><!-- doxytag: member="TCPSocket::TCPSocket" ref="4763ac3be0d7d5e143884bef45e351c5" args="(int newConnSD)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TCPSocket::TCPSocket </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>newConnSD</em> </td> + <td> ) </td> + <td width="100%"><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="e8bcdc0d25881a17b23e557296236fa9"></a><!-- doxytag: member="TCPSocket::TCPServerSocket" ref="e8bcdc0d25881a17b23e557296236fa9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classTCPServerSocket.html">TCPServerSocket</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="PracticalSocket_8h-source.html">PracticalSocket.h</a><li><a class="el" href="PracticalSocket_8cpp.html">PracticalSocket.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:50 2007 for anytun by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address> +</body> +</html> |