nel/src/net/tcp_sock.cpp

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2014  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #include "stdnet.h"
  21
  22 #include "nel/net/tcp_sock.h"
  23 #include "nel/net/net_log.h"
  24
  25 #ifdef NL_OS_WINDOWS
  26 #       include <winsock2.h>
  27 #       ifndef NL_COMP_MINGW
  28 #               define NOMINMAX
  29 #       endif
  30 #       include <windows.h>
  31 #       define socklen_t int
  32 #       define ERROR_NUM WSAGetLastError()
  33 #elif defined NL_OS_UNIX
  34 #       include <unistd.h>
  35 #       include <sys/types.h>
  36 #       include <sys/time.h>
  37 #       include <sys/socket.h>
  38 #       include <netinet/in.h>
  39 #       include <netinet/tcp.h>
  40 #       include <arpa/inet.h>
  41 #       include <netdb.h>
  42 #       include <cerrno>
  43 #       define SOCKET_ERROR -1
  44 #       define INVALID_SOCKET -1
  45 #       define ERROR_NUM errno
  46 #       define ERROR_MSG strerror(errno)
  47 typedef int SOCKET;
  48 #endif
  49
  50 using namespace NLMISC;
  51
  52 namespace NLNET {
  53
  54
  55 /*
  56  * Constructor
  57  */
  58 CTcpSock::CTcpSock( bool logging ) :
  59         CSock( logging )
  60 {}
  61
  62
  63 /*
  64  * Construct a CTcpSocket object using an already connected socket
  65  */
  66 CTcpSock::CTcpSock( SOCKET sock, const CInetAddress& remoteaddr ) :
  67         CSock( sock, remoteaddr )
  68 {}
  69
  70
  71 /* Connection. You can reconnect a socket after being disconnected.
  72  * This method does not return a boolean, otherwise a programmer could ignore the result and no
  73  * exception would be thrown if connection fails :
  74  * - If addr is not valid, an exception ESocket is thrown
  75  * - If connect() fails for another reason, an exception ESocketConnectionFailed is thrown
  76  */
  77 void CTcpSock::connect( const CInetAddress& addr )
  78 {
  79         // Create a new socket
  80         if ( _Sock != INVALID_SOCKET )
  81         {
  82           if ( _Logging )
  83             {
  84 //              LNETL0_DEBUG( "LNETL0: Closing socket %d before reconnecting", _Sock );
  85             }
  86           close();
  87         }
  88         createSocket( SOCK_STREAM, IPPROTO_TCP );
  89
  90         // activate keep alive
  91         setKeepAlive(true);
  92
  93         // Connection
  94         CSock::connect( addr );
  95 }
  96
  97
  98 /*
  99  * Active disconnection. After disconnecting, you can't connect back with the same socket.
 100  */
 101 void CTcpSock::disconnect()
 102 {
 103         LNETL0_DEBUG( "LNETL0: Socket %d disconnecting from %s...", _Sock, _RemoteAddr.asString().c_str() );
 104
 105         // This shutdown resets the connection immediately (not a graceful closure)
 106 #ifdef NL_OS_WINDOWS
 107         ::shutdown( _Sock, SD_BOTH );
 108 #elif defined NL_OS_UNIX
 109         ::shutdown( _Sock, SHUT_RDWR );
 110 #endif
 111         /*CSynchronized<bool>::CAccessor sync( &_SyncConnected );
 112         sync.value() = false;*/
 113         _Connected = false;
 114 }
 115
 116
 117 /*
 118  * Active disconnection for download way only
 119  */
 120 void CTcpSock::shutdownReceiving()
 121 {
 122 #ifdef NL_OS_WINDOWS
 123         ::shutdown( _Sock, SD_RECEIVE );
 124 #elif defined NL_OS_UNIX
 125         ::shutdown( _Sock, SHUT_RD );
 126 #endif
 127 }
 128
 129
 130 /*
 131  * Active disconnection for upload way only
 132  */
 133 void CTcpSock::shutdownSending()
 134 {
 135 #ifdef NL_OS_WINDOWS
 136         ::shutdown( _Sock, SD_SEND );
 137 #elif defined NL_OS_UNIX
 138         ::shutdown( _Sock, SHUT_WR );
 139 #endif
 140 }
 141
 142
 143
 144 void CTcpSock::setKeepAlive( bool keepAlive)
 145 {
 146         nlassert(_Sock != INVALID_SOCKET);
 147         int b = keepAlive?1:0;
 148         if ( setsockopt( _Sock, SOL_SOCKET, SO_KEEPALIVE, (char*)&b, sizeof(b) ) != 0 )
 149         {
 150                 throw ESocket( "setKeepAlive failed" );
 151         }
 152 }
 153
 154 /*
 155  * Sets/unsets TCP_NODELAY
 156  */
 157 void CTcpSock::setNoDelay( bool value )
 158 {
 159         int b = value?1:0;
 160         if ( setsockopt( _Sock, IPPROTO_TCP, TCP_NODELAY, (char*)&b, sizeof(b) ) != 0 )
 161         {
 162                 throw ESocket( "setNoDelay failed" );
 163         }
 164 }
 165
 166
 167 /* Sets a custom TCP Window size (SO_RCVBUF and SO_SNDBUF).
 168  * You must close the socket is necessary, before calling this method.
 169  *
 170  * See http://www.ncsa.uiuc.edu/People/vwelch/net_perf/tcp_windows.html
 171  */
 172 void CTcpSock::connectWithCustomWindowSize( const CInetAddress& addr, int windowsize )
 173 {
 174         // Create socket
 175         if ( _Sock != INVALID_SOCKET )
 176         {
 177                 nlerror( "Cannot connect with custom window size when already connected" );
 178         }
 179         createSocket( SOCK_STREAM, IPPROTO_TCP );
 180
 181         // Change window size
 182         if ( setsockopt( _Sock, SOL_SOCKET, SO_SNDBUF, (char*)&windowsize, sizeof(windowsize) ) != 0
 183           || setsockopt( _Sock, SOL_SOCKET, SO_RCVBUF, (char*)&windowsize, sizeof(windowsize) ) != 0 )
 184         {
 185                 throw ESocket( "setWindowSize failed" );
 186         }
 187
 188         // Connection
 189         CSock::connect( addr );
 190 }
 191
 192
 193 /*
 194  * Returns the TCP Window Size for the current socket
 195  */
 196 uint32 CTcpSock::getWindowSize()
 197 {
 198         int windowsize = 0;
 199         socklen_t len = sizeof( windowsize );
 200
 201         /* send buffer -- query for buffer size */
 202         if ( getsockopt( _Sock, SOL_SOCKET, SO_SNDBUF, (char*) &windowsize, &len ) == 0 )
 203         {
 204                 return windowsize;
 205         }
 206         else
 207         {
 208                 return 0;
 209         }
 210 }
 211
 212
 213 } // NLNET