2 simgear::Socket, adapted from PLIB Socket by James Turner
3 Copyright (C) 2010 James Turner
5 PLIB - A Suite of Portable Game Libraries
6 Copyright (C) 1998,2002 Steve Baker
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Library General Public
10 License as published by the Free Software Foundation; either
11 version 2 of the License, or (at your option) any later version.
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Library General Public License for more details.
18 You should have received a copy of the GNU Library General Public
19 License along with this library; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 # include <simgear_config.h>
27 #include <simgear/compiler.h>
28 #include "raw_socket.hxx"
30 #if defined(_WIN32) && !defined(__CYGWIN__)
31 # define WINSOCK // use winsock convetions, otherwise standard POSIX
38 #include <cstdio> // for snprintf
42 # include <winsock2.h>
43 # include <ws2tcpip.h>
46 # include <sys/types.h>
47 # include <sys/socket.h>
48 # include <netinet/in.h>
49 # include <arpa/inet.h>
50 # include <sys/time.h>
56 #if defined(_MSC_VER) && !defined(socklen_t)
60 #include <simgear/debug/logstream.hxx>
61 #include <simgear/structure/exception.hxx>
66 IPAddress::IPAddress ( const char* host, int port )
71 IPAddress::IPAddress( const IPAddress& other ) :
75 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
76 memcpy(addr, other.addr, sizeof(struct sockaddr_in));
80 const IPAddress& IPAddress::operator=(const IPAddress& other)
88 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
89 memcpy(addr, other.addr, sizeof(struct sockaddr_in));
95 void IPAddress::set ( const char* host, int port )
97 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
98 memset(addr, 0, sizeof(struct sockaddr_in));
100 addr->sin_family = AF_INET ;
101 addr->sin_port = htons (port);
103 /* Convert a string specifying a host name or one of a few symbolic
104 ** names to a numeric IP address. This usually calls getaddrinfo()
105 ** to do the work; the names "" and "<broadcast>" are special.
108 if (!host || host[0] == '\0') {
109 addr->sin_addr.s_addr = INADDR_ANY;
113 if (strcmp(host, "<broadcast>") == 0) {
114 addr->sin_addr.s_addr = INADDR_BROADCAST;
118 struct addrinfo* result = NULL;
119 int err = getaddrinfo(host, NULL, NULL /* no hints */, &result);
121 SG_LOG(SG_IO, SG_WARN, "getaddrinfo failed for '" << host << "' : " << gai_strerror(err));
122 } else if (result->ai_addrlen != getAddrLen()) {
123 SG_LOG(SG_IO, SG_ALERT, "mismatch in socket address sizes");
125 memcpy(addr, result->ai_addr, result->ai_addrlen);
128 freeaddrinfo(result);
129 addr->sin_port = htons (port); // fix up port after getaddrinfo
132 IPAddress::~IPAddress()
139 /* Create a string object representing an IP address.
140 This is always a string of the form 'dd.dd.dd.dd' (with variable
143 const char* IPAddress::getHost () const
145 static char buf [32];
146 long x = ntohl(addr->sin_addr.s_addr);
147 sprintf(buf, "%d.%d.%d.%d",
148 (int) (x>>24) & 0xff, (int) (x>>16) & 0xff,
149 (int) (x>> 8) & 0xff, (int) (x>> 0) & 0xff );
153 unsigned int IPAddress::getIP () const
155 return addr->sin_addr.s_addr;
158 unsigned int IPAddress::getPort() const
160 return ntohs(addr->sin_port);
163 unsigned int IPAddress::getFamily () const
165 return addr->sin_family;
168 const char* IPAddress::getLocalHost ()
170 //gethostbyname(gethostname())
173 memset(buf, 0, sizeof(buf));
174 gethostname(buf, sizeof(buf)-1);
175 const hostent *hp = gethostbyname(buf);
177 if (hp && *hp->h_addr_list)
179 in_addr addr = *((in_addr*)*hp->h_addr_list);
180 const char* host = inet_ntoa(addr);
190 bool IPAddress::getBroadcast () const
192 return (addr->sin_addr.s_addr == INADDR_BROADCAST);
195 unsigned int IPAddress::getAddrLen() const
197 return sizeof(struct sockaddr_in);
200 struct sockaddr* IPAddress::getAddr() const
202 return (struct sockaddr*) addr;
217 void Socket::setHandle (int _handle)
224 bool Socket::open ( bool stream )
227 handle = ::socket ( AF_INET, (stream? SOCK_STREAM: SOCK_DGRAM), 0 ) ;
229 // Jan 26, 2010: Patch to avoid the problem of the socket resource not
230 // yet being available if the program is restarted quickly after being
233 // Reference: http://www.unixguide.net/network/socketfaq/4.5.shtml
235 // Also required for joining multicast domains
238 #if defined(_WIN32) || defined(__CYGWIN__)
239 setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, (char *)&opt_boolean,
240 sizeof(opt_boolean) );
242 setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, &opt_boolean,
243 sizeof(opt_boolean) );
247 return (handle != -1);
251 void Socket::setBlocking ( bool blocking )
253 assert ( handle != -1 ) ;
256 u_long nblocking = blocking? 0: 1;
257 ::ioctlsocket(handle, FIONBIO, &nblocking);
260 int delay_flag = ::fcntl (handle, F_GETFL, 0);
263 delay_flag &= (~O_NDELAY);
265 delay_flag |= O_NDELAY;
267 ::fcntl (handle, F_SETFL, delay_flag);
272 void Socket::setBroadcast ( bool broadcast )
274 assert ( handle != -1 ) ;
278 #if defined(_WIN32) || defined(__CYGWIN__)
279 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, (char*)&one, sizeof(one) );
281 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, &one, sizeof(one) );
284 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, NULL, 0 );
288 throw sg_exception("Socket::setBroadcast failed");
293 int Socket::bind ( const char* host, int port )
296 assert ( handle != -1 ) ;
297 IPAddress addr ( host, port ) ;
299 #if !defined(WINSOCK)
300 if( (result = ::bind(handle, addr.getAddr(), addr.getAddrLen() ) ) < 0 ) {
301 SG_LOG(SG_IO, SG_ALERT, "bind(" << addr.getHost() << ":" << addr.getPort() << ") failed. Errno " << errno << " (" << strerror(errno) << ")");
306 // 224.0.0.0 - 239.255.255.255 are multicast
307 // Usage of 239.x.x.x is recommended for local scope
308 // Reference: http://tools.ietf.org/html/rfc5771
309 if( ntohl(addr.getIP()) >= 0xe0000000 && ntohl(addr.getIP()) <= 0xefffffff ) {
312 struct sockaddr_in a;
313 a.sin_addr.S_un.S_addr = INADDR_ANY;
314 a.sin_family = AF_INET;
315 a.sin_port = htons(port);
317 if( (result = ::bind(handle,(const sockaddr*)&a,sizeof(a))) < 0 ) {
318 SG_LOG(SG_IO, SG_ALERT, "bind(any:" << port << ") failed. Errno " << errno << " (" << strerror(errno) << ")");
324 mreq.imr_multiaddr.s_addr = addr.getIP();
325 mreq.imr_interface.s_addr = htonl(INADDR_ANY);
326 if( (result=::setsockopt(getHandle(), IPPROTO_IP, IP_ADD_MEMBERSHIP, (const char *)&mreq, sizeof(mreq))) != 0 ) {
327 SG_LOG(SG_IO, SG_ALERT, "setsockopt(IP_ADD_MEMBERSHIP) failed. Errno " << errno << " (" << strerror(errno) << ")");
332 else if( (result = ::bind(handle,addr.getAddr(), addr.getAddrLen())) < 0 ) {
333 SG_LOG(SG_IO, SG_ALERT, "bind(" << host << ":" << port << ") failed. Errno " << errno << " (" << strerror(errno) << ")");
342 int Socket::listen ( int backlog )
344 assert ( handle != -1 ) ;
345 return ::listen(handle,backlog);
349 int Socket::accept ( IPAddress* addr )
351 assert ( handle != -1 ) ;
355 return ::accept(handle,NULL,NULL);
359 socklen_t addr_len = addr->getAddrLen(); ;
360 return ::accept(handle, addr->getAddr(), &addr_len);
365 int Socket::connect ( const char* host, int port )
367 IPAddress addr ( host, port ) ;
368 return connect ( &addr );
372 int Socket::connect ( IPAddress* addr )
374 assert ( handle != -1 ) ;
375 if ( addr->getBroadcast() ) {
376 setBroadcast( true );
378 return ::connect(handle, addr->getAddr(), addr->getAddrLen() );
382 int Socket::send (const void * buffer, int size, int flags)
384 assert ( handle != -1 ) ;
385 return ::send (handle, (const char*)buffer, size, flags);
389 int Socket::sendto ( const void * buffer, int size,
390 int flags, const IPAddress* to )
392 assert ( handle != -1 ) ;
393 return ::sendto(handle,(const char*)buffer,size,flags,
394 (const sockaddr*) to->getAddr(), to->getAddrLen());
398 int Socket::recv (void * buffer, int size, int flags)
400 assert ( handle != -1 ) ;
401 return ::recv (handle, (char*)buffer, size, flags);
405 int Socket::recvfrom ( void * buffer, int size,
406 int flags, IPAddress* from )
408 assert ( handle != -1 ) ;
409 socklen_t fromlen = (socklen_t) from->getAddrLen() ;
410 return ::recvfrom(handle,(char*)buffer,size,flags, from->getAddr(),&fromlen);
414 void Socket::close (void)
419 ::closesocket( handle );
428 bool Socket::isNonBlockingError ()
431 int wsa_errno = WSAGetLastError();
432 if ( wsa_errno != 0 )
435 SG_LOG(SG_IO, SG_WARN, "isNonBlockingError: WSAGetLastError():" << wsa_errno);
437 case WSAEWOULDBLOCK: // always == NET_EAGAIN?
446 case EWOULDBLOCK: // always == NET_EAGAIN?
457 //////////////////////////////////////////////////////////////////////
459 // modified version by os
461 //////////////////////////////////////////////////////////////////////
462 int Socket::select ( Socket** reads, Socket** writes, int timeout )
475 for ( i=0; reads[i]; i++ )
477 int fd = reads[i]->getHandle();
485 for ( i=0; writes[i]; i++ )
487 int fd = writes[i]->getHandle();
496 /* Set up the timeout */
498 tv.tv_sec = timeout/1000;
499 tv.tv_usec = (timeout%1000)*1000;
501 // It bothers me that select()'s first argument does not appear to
502 // work as advertised... [it hangs like this if called with
503 // anything less than FD_SETSIZE, which seems wasteful?]
505 // Note: we ignore the 'exception' fd_set - I have never had a
506 // need to use it. The name is somewhat misleading - the only
507 // thing I have ever seen it used for is to detect urgent data -
508 // which is an unportable feature anyway.
510 retval = ::select (FD_SETSIZE, &r, &w, 0, &tv);
512 //remove sockets that had no activity
518 for ( k=i=0; reads[i]; i++ )
520 int fd = reads[i]->getHandle();
521 if ( FD_ISSET (fd, &r) )
523 reads[k++] = reads[i];
532 for ( k=i=0; writes[i]; i++ )
534 int fd = writes[i]->getHandle();
535 if ( FD_ISSET (fd, &w) )
537 writes[k++] = writes[i];
544 if (retval == 0) // timeout
546 if (retval == -1)// error
553 /* Init/Exit functions */
555 static void netExit ( void )
558 /* Clean up windows networking */
559 if ( WSACleanup() == SOCKET_ERROR ) {
560 if ( WSAGetLastError() == WSAEINPROGRESS ) {
561 WSACancelBlockingCall();
568 int Socket::initSockets()
571 /* Start up the windows networking */
572 WORD version_wanted = MAKEWORD(1,1);
575 if ( WSAStartup(version_wanted, &wsaData) != 0 ) {
576 throw sg_exception("WinSock initialization failed");
585 } // of namespace simgear