diff options
Diffstat (limited to 'docs/doxygen/nel/classNLNET_1_1CDummyTcpSock.html')
| -rw-r--r-- | docs/doxygen/nel/classNLNET_1_1CDummyTcpSock.html | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLNET_1_1CDummyTcpSock.html b/docs/doxygen/nel/classNLNET_1_1CDummyTcpSock.html new file mode 100644 index 00000000..3ee79e5e --- /dev/null +++ b/docs/doxygen/nel/classNLNET_1_1CDummyTcpSock.html @@ -0,0 +1,291 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</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="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLNET::CDummyTcpSock Class Reference</h1>Dummy <a class="el" href="classNLNET_1_1CTcpSock.html">CTcpSock</a> replacement for replay mode. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="dummy__tcp__sock_8h-source.html">dummy_tcp_sock.h</a>></code> +<p> +<p>Inheritance diagram for NLNET::CDummyTcpSock: +<p><center><img src="classNLNET_1_1CDummyTcpSock.gif" usemap="#NLNET::CDummyTcpSock_map" border="0"></center> +<map name="NLNET::CDummyTcpSock_map"> +<area href="classNLNET_1_1CTcpSock.html" alt="NLNET::CTcpSock" shape="rect" coords="0,56,157,80"> +<area href="classNLNET_1_1CSock.html" alt="NLNET::CSock" shape="rect" coords="0,0,157,24"> +</map> +<a href="classNLNET_1_1CDummyTcpSock-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="classNLNET_1_1CDummyTcpSock.html#a0">CDummyTcpSock</a> (bool logging=true)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLNET_1_1CDummyTcpSock.html#a1">connect</a> (const <a class="el" href="classNLNET_1_1CInetAddress.html">CInetAddress</a> &addr)</td></tr> +<tr><td> </td><td><font size=-1><em>Connection.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLNET_1_1CDummyTcpSock.html#a2">disconnect</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Active disconnection (shutdown) (mutexed). <a class="el" href="classNLNET_1_1CSock.html#z351_0">connected</a>() becomes false.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLNET_1_1CDummyTcpSock.html#a3">setNoDelay</a> (bool value)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/unsets TCP_NODELAY (by default, it is off, i.e.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLNET_1_1CDummyTcpSock.html#a4">close</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Closes the socket (without shutdown) In general you don't need to call this method.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Dummy <a class="el" href="classNLNET_1_1CTcpSock.html">CTcpSock</a> replacement for replay mode. +<p> +<dl compact><dt><b> +Author: </b><dd> +Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="dummy__tcp__sock_8h-source.html#l00042">42</a> of file <a class="el" href="dummy__tcp__sock_8h-source.html">dummy_tcp_sock.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLNET::CDummyTcpSock::CDummyTcpSock"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLNET::CDummyTcpSock::CDummyTcpSock </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>logging</em> = true </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> + +<p> +Definition at line <a class="el" href="dummy__tcp__sock_8h-source.html#l00047">47</a> of file <a class="el" href="dummy__tcp__sock_8h-source.html">dummy_tcp_sock.h</a>. +<p> +References <a class="el" href="tcp__sock_8cpp-source.html#l00061">NLNET::CTcpSock::CTcpSock</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="NLNET::CDummyTcpSock::close"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLNET::CDummyTcpSock::close </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> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Closes the socket (without shutdown) In general you don't need to call this method. +<p> +But you can call it to:<ul> +<li>close a listening socket (i.e. stop accepting connections), or<li>stop a select() in progress in another thread (in this case, just calling the destructor is not enough) </ul> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CSock.html#z348_3">NLNET::CSock</a>. +<p> +Definition at line <a class="el" href="dummy__tcp__sock_8h-source.html#l00059">59</a> of file <a class="el" href="dummy__tcp__sock_8h-source.html">dummy_tcp_sock.h</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLNET::CDummyTcpSock::connect"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::CDummyTcpSock::connect </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLNET_1_1CInetAddress.html">CInetAddress</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>addr</em> </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> +Connection. +<p> +You can reconnect a socket after being disconnected. This method does not return a boolean, otherwise a programmer could ignore the result and no exception would be thrown if connection fails :<ul> +<li>If addr is not valid, an exception <a class="el" href="structNLNET_1_1ESocket.html">ESocket</a> is thrown<li>If <a class="el" href="classNLNET_1_1CDummyTcpSock.html#a1">connect</a>() fails for another reason, an exception <a class="el" href="structNLNET_1_1ESocketConnectionFailed.html">ESocketConnectionFailed</a> is thrown </ul> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CTcpSock.html#z352_2">NLNET::CTcpSock</a>. +<p> +Definition at line <a class="el" href="dummy__tcp__sock_8cpp-source.html#l00039">39</a> of file <a class="el" href="dummy__tcp__sock_8cpp-source.html">dummy_tcp_sock.cpp</a>. +<p> +References <a class="el" href="sock_8h-source.html#l00294">NLNET::CSock::_BytesReceived</a>, <a class="el" href="sock_8h-source.html#l00297">NLNET::CSock::_BytesSent</a>, <a class="el" href="sock_8h-source.html#l00291">NLNET::CSock::_Connected</a>, <a class="el" href="sock_8h-source.html#l00281">NLNET::CSock::_RemoteAddr</a>, <a class="el" href="sock_8h-source.html#l00275">NLNET::CSock::_Sock</a>, and <a class="el" href="debug_8h-source.html#l00088">nldebug</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLNET::CDummyTcpSock::disconnect"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLNET::CDummyTcpSock::disconnect </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> +Active disconnection (shutdown) (mutexed). <a class="el" href="classNLNET_1_1CSock.html#z351_0">connected</a>() becomes false. +<p> + +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CTcpSock.html#z352_8">NLNET::CTcpSock</a>. +<p> +Definition at line <a class="el" href="dummy__tcp__sock_8cpp-source.html#l00058">58</a> of file <a class="el" href="dummy__tcp__sock_8cpp-source.html">dummy_tcp_sock.cpp</a>. +<p> +References <a class="el" href="sock_8h-source.html#l00291">NLNET::CSock::_Connected</a>, <a class="el" href="sock_8h-source.html#l00281">NLNET::CSock::_RemoteAddr</a>, and <a class="el" href="debug_8h-source.html#l00088">nldebug</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLNET::CDummyTcpSock::setNoDelay"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLNET::CDummyTcpSock::setNoDelay </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>value</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/unsets TCP_NODELAY (by default, it is off, i.e. +<p> +the Nagle buffering algorithm is enabled). You must call this method *after* <a class="el" href="classNLNET_1_1CDummyTcpSock.html#a1">connect</a>(). +<p> +Reimplemented from <a class="el" href="classNLNET_1_1CTcpSock.html#z352_5">NLNET::CTcpSock</a>. +<p> +Definition at line <a class="el" href="dummy__tcp__sock_8h-source.html#l00056">56</a> of file <a class="el" href="dummy__tcp__sock_8h-source.html">dummy_tcp_sock.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="dummy__tcp__sock_8h-source.html">dummy_tcp_sock.h</a><li><a class="el" href="dummy__tcp__sock_8cpp-source.html">dummy_tcp_sock.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |