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>
29 #include "sg_socket.hxx"
31 #if defined(_WIN32) && !defined(__CYGWIN__)
32 # define WINSOCK // use winsock convetions, otherwise standard POSIX
39 #include <cstdio> // for snprintf
45 # include <sys/types.h>
46 # include <sys/socket.h>
47 # include <netinet/in.h>
48 # include <arpa/inet.h>
49 # include <sys/time.h>
55 #if defined(_MSC_VER) && !defined(socklen_t)
59 #include <simgear/debug/logstream.hxx>
60 #include <simgear/structure/exception.hxx>
65 IPAddress::IPAddress ( const char* host, int port )
71 void IPAddress::set ( const char* host, int port )
73 memset(this, 0, sizeof(IPAddress));
75 sin_family = AF_INET ;
76 sin_port = htons (port);
78 /* Convert a string specifying a host name or one of a few symbolic
79 ** names to a numeric IP address. This usually calls gethostbyname()
80 ** to do the work; the names "" and "<broadcast>" are special.
83 if (!host || host[0] == '\0') {
84 sin_addr = INADDR_ANY;
88 if (strcmp(host, "<broadcast>") == 0) {
89 sin_addr = INADDR_BROADCAST;
93 sin_addr = inet_addr ( host ) ;
94 if (sin_addr != INADDR_NONE) {
97 // finally, try gethostbyname
98 struct hostent *hp = gethostbyname ( host ) ;
100 SG_LOG(SG_IO, SG_WARN, "gethostbyname failed for " << host);
101 sin_addr = INADDR_ANY ;
105 memcpy ( (char *) &sin_addr, hp->h_addr, hp->h_length ) ;
109 /* Create a string object representing an IP address.
110 This is always a string of the form 'dd.dd.dd.dd' (with variable
113 const char* IPAddress::getHost () const
116 const char* buf = inet_ntoa ( sin_addr ) ;
118 static char buf [32];
119 long x = ntohl(sin_addr);
120 sprintf(buf, "%d.%d.%d.%d",
121 (int) (x>>24) & 0xff, (int) (x>>16) & 0xff,
122 (int) (x>> 8) & 0xff, (int) (x>> 0) & 0xff );
127 unsigned int IPAddress::getIP () const
132 unsigned int IPAddress::getPort() const
134 return ntohs(sin_port);
137 unsigned int IPAddress::getFamily () const
142 const char* IPAddress::getLocalHost ()
144 //gethostbyname(gethostname())
147 memset(buf, 0, sizeof(buf));
148 gethostname(buf, sizeof(buf)-1);
149 const hostent *hp = gethostbyname(buf);
151 if (hp && *hp->h_addr_list)
153 in_addr addr = *((in_addr*)*hp->h_addr_list);
154 const char* host = inet_ntoa(addr);
164 bool IPAddress::getBroadcast () const
166 return sin_addr == INADDR_BROADCAST;
182 void Socket::setHandle (int _handle)
189 bool Socket::open ( bool stream )
192 handle = ::socket ( AF_INET, (stream? SOCK_STREAM: SOCK_DGRAM), 0 ) ;
194 // Jan 26, 2010: Patch to avoid the problem of the socket resource not
195 // yet being available if the program is restarted quickly after being
198 // Reference: http://www.unixguide.net/network/socketfaq/4.5.shtml
202 #if defined(_WIN32) || defined(__CYGWIN__)
203 setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, (char *)&opt_boolean,
204 sizeof(opt_boolean) );
206 setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, &opt_boolean,
207 sizeof(opt_boolean) );
211 return (handle != -1);
215 void Socket::setBlocking ( bool blocking )
217 assert ( handle != -1 ) ;
220 u_long nblocking = blocking? 0: 1;
221 ::ioctlsocket(handle, FIONBIO, &nblocking);
224 int delay_flag = ::fcntl (handle, F_GETFL, 0);
227 delay_flag &= (~O_NDELAY);
229 delay_flag |= O_NDELAY;
231 ::fcntl (handle, F_SETFL, delay_flag);
236 void Socket::setBroadcast ( bool broadcast )
238 assert ( handle != -1 ) ;
242 #if defined(_WIN32) || defined(__CYGWIN__)
243 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, (char*)&one, sizeof(one) );
245 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, &one, sizeof(one) );
248 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, NULL, 0 );
252 throw sg_exception("Socket::setBroadcast failed");
257 int Socket::bind ( const char* host, int port )
259 assert ( handle != -1 ) ;
260 IPAddress addr ( host, port ) ;
261 return ::bind(handle,(const sockaddr*)&addr,sizeof(IPAddress));
265 int Socket::listen ( int backlog )
267 assert ( handle != -1 ) ;
268 return ::listen(handle,backlog);
272 int Socket::accept ( IPAddress* addr )
274 assert ( handle != -1 ) ;
278 return ::accept(handle,NULL,NULL);
282 socklen_t addr_len = (socklen_t) sizeof(IPAddress) ;
283 return ::accept(handle,(sockaddr*)addr,&addr_len);
288 int Socket::connect ( const char* host, int port )
290 assert ( handle != -1 ) ;
291 IPAddress addr ( host, port ) ;
292 if ( addr.getBroadcast() ) {
293 setBroadcast( true );
295 return ::connect(handle,(const sockaddr*)&addr,sizeof(IPAddress));
299 int Socket::send (const void * buffer, int size, int flags)
301 assert ( handle != -1 ) ;
302 return ::send (handle, (const char*)buffer, size, flags);
306 int Socket::sendto ( const void * buffer, int size,
307 int flags, const IPAddress* to )
309 assert ( handle != -1 ) ;
310 return ::sendto(handle,(const char*)buffer,size,flags,
311 (const sockaddr*)to,sizeof(IPAddress));
315 int Socket::recv (void * buffer, int size, int flags)
317 assert ( handle != -1 ) ;
318 return ::recv (handle, (char*)buffer, size, flags);
322 int Socket::recvfrom ( void * buffer, int size,
323 int flags, IPAddress* from )
325 assert ( handle != -1 ) ;
326 socklen_t fromlen = (socklen_t) sizeof(IPAddress) ;
327 return ::recvfrom(handle,(char*)buffer,size,flags,(sockaddr*)from,&fromlen);
331 void Socket::close (void)
336 ::closesocket( handle );
345 bool Socket::isNonBlockingError ()
348 int wsa_errno = WSAGetLastError();
349 if ( wsa_errno != 0 )
352 SG_LOG(SG_IO, SG_WARN, "isNonBlockingError: WSAGetLastError():" << wsa_errno);
354 case WSAEWOULDBLOCK: // always == NET_EAGAIN?
363 case EWOULDBLOCK: // always == NET_EAGAIN?
374 //////////////////////////////////////////////////////////////////////
376 // modified version by os
378 //////////////////////////////////////////////////////////////////////
379 int Socket::select ( Socket** reads, Socket** writes, int timeout )
392 for ( i=0; reads[i]; i++ )
394 int fd = reads[i]->getHandle();
402 for ( i=0; writes[i]; i++ )
404 int fd = writes[i]->getHandle();
413 /* Set up the timeout */
415 tv.tv_sec = timeout/1000;
416 tv.tv_usec = (timeout%1000)*1000;
418 // It bothers me that select()'s first argument does not appear to
419 // work as advertised... [it hangs like this if called with
420 // anything less than FD_SETSIZE, which seems wasteful?]
422 // Note: we ignore the 'exception' fd_set - I have never had a
423 // need to use it. The name is somewhat misleading - the only
424 // thing I have ever seen it used for is to detect urgent data -
425 // which is an unportable feature anyway.
427 retval = ::select (FD_SETSIZE, &r, &w, 0, &tv);
429 //remove sockets that had no activity
435 for ( k=i=0; reads[i]; i++ )
437 int fd = reads[i]->getHandle();
438 if ( FD_ISSET (fd, &r) )
440 reads[k++] = reads[i];
449 for ( k=i=0; writes[i]; i++ )
451 int fd = writes[i]->getHandle();
452 if ( FD_ISSET (fd, &w) )
454 writes[k++] = writes[i];
461 if (retval == 0) // timeout
463 if (retval == -1)// error
470 /* Init/Exit functions */
472 static void netExit ( void )
475 /* Clean up windows networking */
476 if ( WSACleanup() == SOCKET_ERROR ) {
477 if ( WSAGetLastError() == WSAEINPROGRESS ) {
478 WSACancelBlockingCall();
485 int Socket::initSockets()
487 assert ( sizeof(sockaddr_in) == sizeof(IPAddress) ) ;
490 /* Start up the windows networking */
491 WORD version_wanted = MAKEWORD(1,1);
494 if ( WSAStartup(version_wanted, &wsaData) != 0 ) {
495 throw sg_exception("WinSock initialization failed");
504 } // of namespace simgear