diff options
Diffstat (limited to 'docs/doxygen/nel/tcp__sock_8cpp-source.html')
| -rw-r--r-- | docs/doxygen/nel/tcp__sock_8cpp-source.html | 271 |
1 files changed, 271 insertions, 0 deletions
diff --git a/docs/doxygen/nel/tcp__sock_8cpp-source.html b/docs/doxygen/nel/tcp__sock_8cpp-source.html new file mode 100644 index 00000000..227ae1a4 --- /dev/null +++ b/docs/doxygen/nel/tcp__sock_8cpp-source.html @@ -0,0 +1,271 @@ +<!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>tcp_sock.cpp</h1><a href="tcp__sock_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2000 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#include "<a class="code" href="stdnet_8h.html">stdnet.h</a>"</font> +00027 +00028 <font class="preprocessor">#include "<a class="code" href="tcp__sock_8h.html">nel/net/tcp_sock.h</a>"</font> +00029 +00030 <font class="preprocessor">#ifdef NL_OS_WINDOWS</font> +00031 <font class="preprocessor"></font><font class="preprocessor">#include <winsock2.h></font> +00032 <font class="preprocessor">#define socklen_t int</font> +00033 <font class="preprocessor"></font><font class="preprocessor">#define ERROR_NUM WSAGetLastError()</font> +00034 <font class="preprocessor"></font> +00035 <font class="preprocessor">#elif defined NL_OS_UNIX</font> +00036 <font class="preprocessor"></font><font class="preprocessor">#include <<a class="code" href="unistd_8h.html">unistd.h</a>></font> +00037 <font class="preprocessor">#include <sys/types.h></font> +00038 <font class="preprocessor">#include <sys/time.h></font> +00039 <font class="preprocessor">#include <sys/socket.h></font> +00040 <font class="preprocessor">#include <netinet/in.h></font> +00041 <font class="preprocessor">#include <netinet/tcp.h></font> +00042 <font class="preprocessor">#include <arpa/inet.h></font> +00043 <font class="preprocessor">#include <netdb.h></font> +00044 <font class="preprocessor">#include <errno.h></font> +00045 <font class="preprocessor">#define SOCKET_ERROR -1</font> +00046 <font class="preprocessor"></font><font class="preprocessor">#define INVALID_SOCKET -1</font> +00047 <font class="preprocessor"></font><font class="preprocessor">#define ERROR_NUM errno</font> +00048 <font class="preprocessor"></font><font class="preprocessor">#define ERROR_MSG strerror(errno)</font> +00049 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">int</font> SOCKET; +00050 +00051 <font class="preprocessor">#endif</font> +00052 <font class="preprocessor"></font> +00053 <font class="keyword">using</font> <font class="keyword">namespace </font>NLMISC; +00054 +00055 <font class="keyword">namespace </font>NLNET { +00056 +00057 +00058 <font class="comment">/*</font> +00059 <font class="comment"> * Constructor</font> +00060 <font class="comment"> */</font> +<a name="l00061"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_0">00061</a> CTcpSock::CTcpSock( <font class="keywordtype">bool</font> logging ) : +00062 CSock( logging ) +00063 {} +00064 +00065 +00066 <font class="comment">/*</font> +00067 <font class="comment"> * Construct a CTcpSocket object using an already connected socket </font> +00068 <font class="comment"> */</font> +<a name="l00069"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_1">00069</a> CTcpSock::CTcpSock( SOCKET sock, <font class="keyword">const</font> CInetAddress& remoteaddr ) : +00070 CSock( sock, remoteaddr ) +00071 {} +00072 +00073 +00074 <font class="comment">/* Connection. You can reconnect a socket after being disconnected.</font> +00075 <font class="comment"> * This method does not return a boolean, otherwise a programmer could ignore the result and no</font> +00076 <font class="comment"> * exception would be thrown if connection fails :</font> +00077 <font class="comment"> * - If addr is not valid, an exception ESocket is thrown</font> +00078 <font class="comment"> * - If connect() fails for another reason, an exception ESocketConnectionFailed is thrown</font> +00079 <font class="comment"> */</font> +<a name="l00080"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_2">00080</a> <font class="keywordtype">void</font> CTcpSock::connect( <font class="keyword">const</font> CInetAddress& addr ) +00081 { +00082 <font class="comment">// Create a new socket</font> +00083 <font class="keywordflow">if</font> ( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a> != INVALID_SOCKET ) +00084 { +00085 <font class="keywordflow">if</font> ( _Logging ) +00086 { +00087 <font class="comment">// nldebug( "LNETL0: Closing socket %d before reconnecting", _Sock );</font> +00088 } +00089 <a class="code" href="classNLNET_1_1CSock.html#z343_3">close</a>(); +00090 } +00091 <a class="code" href="classNLNET_1_1CSock.html#b2">createSocket</a>( SOCK_STREAM, IPPROTO_TCP ); +00092 +00093 <font class="comment">// Connection</font> +00094 CSock::connect( addr ); +00095 } +00096 +00097 +00098 <font class="comment">/*</font> +00099 <font class="comment"> * Active disconnection. After disconnecting, you can't connect back with the same socket.</font> +00100 <font class="comment"> */</font> +<a name="l00101"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_8">00101</a> <font class="keywordtype">void</font> CTcpSock::disconnect() +00102 { +00103 <a class="code" href="debug_8h.html#a0">nldebug</a>( <font class="stringliteral">"LNETL0: Socket %d disconnecting from %s..."</font>, <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, <a class="code" href="classNLNET_1_1CSock.html#n2">_RemoteAddr</a>.asString().c_str() ); +00104 +00105 <font class="comment">// This shutdown resets the connection immediatly (not a graceful closure)</font> +00106 <font class="preprocessor">#ifdef NL_OS_WINDOWS</font> +00107 <font class="preprocessor"></font> ::shutdown( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SD_BOTH ); +00108 <font class="preprocessor">#elif defined NL_OS_UNIX</font> +00109 <font class="preprocessor"></font> ::shutdown( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SHUT_RDWR ); +00110 <font class="preprocessor">#endif</font> +00111 <font class="preprocessor"></font> <font class="comment">/*CSynchronized<bool>::CAccessor sync( &_SyncConnected );</font> +00112 <font class="comment"> sync.value() = false;*/</font> +00113 <a class="code" href="classNLNET_1_1CSock.html#n5">_Connected</a> = <font class="keyword">false</font>; +00114 } +00115 +00116 +00117 <font class="comment">/*</font> +00118 <font class="comment"> * Active disconnection for download way only</font> +00119 <font class="comment"> */</font> +<a name="l00120"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_6">00120</a> <font class="keywordtype">void</font> CTcpSock::shutdownReceiving() +00121 { +00122 <font class="preprocessor">#ifdef NL_OS_WINDOWS</font> +00123 <font class="preprocessor"></font> ::shutdown( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SD_RECEIVE ); +00124 <font class="preprocessor">#elif defined NL_OS_UNIX</font> +00125 <font class="preprocessor"></font> ::shutdown( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SHUT_RD ); +00126 <font class="preprocessor">#endif</font> +00127 <font class="preprocessor"></font>} +00128 +00129 +00130 <font class="comment">/*</font> +00131 <font class="comment"> * Active disconnection for upload way only</font> +00132 <font class="comment"> */</font> +<a name="l00133"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_7">00133</a> <font class="keywordtype">void</font> CTcpSock::shutdownSending() +00134 { +00135 <font class="preprocessor">#ifdef NL_OS_WINDOWS</font> +00136 <font class="preprocessor"></font> ::shutdown( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SD_SEND ); +00137 <font class="preprocessor">#elif defined NL_OS_UNIX</font> +00138 <font class="preprocessor"></font> ::shutdown( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SHUT_WR ); +00139 <font class="preprocessor">#endif</font> +00140 <font class="preprocessor"></font>} +00141 +00142 +00143 <font class="comment">/*</font> +00144 <font class="comment"> * Sets/unsets TCP_NODELAY</font> +00145 <font class="comment"> */</font> +<a name="l00146"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_5">00146</a> <font class="keywordtype">void</font> CTcpSock::setNoDelay( <font class="keywordtype">bool</font> value ) +00147 { +00148 <font class="keywordtype">int</font> b = value?1:0; +00149 <font class="keywordflow">if</font> ( setsockopt( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, IPPROTO_TCP, TCP_NODELAY, (<font class="keywordtype">char</font>*)&b, <font class="keyword">sizeof</font>(b) ) != 0 ) +00150 { +00151 <font class="keywordflow">throw</font> ESocket( <font class="stringliteral">"setNoDelay failed"</font> ); +00152 } +00153 } +00154 +00155 +00156 <font class="comment">/* Sets a custom TCP Window size (SO_RCVBUF and SO_SNDBUF).</font> +00157 <font class="comment"> * You must close the socket is necessary, before calling this method.</font> +00158 <font class="comment"> *</font> +00159 <font class="comment"> * See http://www.ncsa.uiuc.edu/People/vwelch/net_perf/tcp_windows.html</font> +00160 <font class="comment"> */</font> +<a name="l00161"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_3">00161</a> <font class="keywordtype">void</font> CTcpSock::connectWithCustomWindowSize( <font class="keyword">const</font> CInetAddress& addr, <font class="keywordtype">int</font> windowsize ) +00162 { +00163 <font class="comment">// Create socket</font> +00164 <font class="keywordflow">if</font> ( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a> != INVALID_SOCKET ) +00165 { +00166 <a class="code" href="debug_8h.html#a3">nlerror</a>( <font class="stringliteral">"Cannot connect with custom window size when already connected"</font> ); +00167 } +00168 <a class="code" href="classNLNET_1_1CSock.html#b2">createSocket</a>( SOCK_STREAM, IPPROTO_TCP ); +00169 +00170 <font class="comment">// Change window size</font> +00171 <font class="keywordflow">if</font> ( setsockopt( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SOL_SOCKET, SO_SNDBUF, (<font class="keywordtype">char</font>*)&windowsize, <font class="keyword">sizeof</font>(windowsize) ) != 0 +00172 || setsockopt( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SOL_SOCKET, SO_RCVBUF, (<font class="keywordtype">char</font>*)&windowsize, <font class="keyword">sizeof</font>(windowsize) ) != 0 ) +00173 { +00174 <font class="keywordflow">throw</font> ESocket( <font class="stringliteral">"setWindowSize failed"</font> ); +00175 } +00176 +00177 <font class="comment">// Connection</font> +00178 CSock::connect( addr ); +00179 } +00180 +00181 +00182 <font class="comment">/*</font> +00183 <font class="comment"> * Returns the TCP Window Size for the current socket</font> +00184 <font class="comment"> */</font> +<a name="l00185"></a><a class="code" href="classNLNET_1_1CTcpSock.html#z347_4">00185</a> <a class="code" href="types__nl_8h.html#a9">uint32</a> CTcpSock::getWindowSize() +00186 { +00187 <font class="keywordtype">int</font> windowsize = 0; +00188 socklen_t <a class="code" href="driver__opengl__extension__def_8h.html#a230">len</a> = <font class="keyword">sizeof</font>( windowsize ); +00189 +00190 <font class="comment">/* send buffer -- query for buffer size */</font> +00191 <font class="keywordflow">if</font> ( getsockopt( <a class="code" href="classNLNET_1_1CSock.html#n0">_Sock</a>, SOL_SOCKET, SO_SNDBUF, (<font class="keywordtype">char</font>*) &windowsize, &<a class="code" href="driver__opengl__extension__def_8h.html#a230">len</a> ) == 0 ) +00192 { +00193 <font class="keywordflow">return</font> windowsize; +00194 } +00195 <font class="keywordflow">else</font> +00196 { +00197 <font class="keywordflow">return</font> 0; +00198 } +00199 } +00200 +00201 +00202 } <font class="comment">// NLNET</font> +</pre></div> + +<!-- 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> |