1 /* -------------------------------------------------------------------------
2 * Project: GSocket (Generic Socket) for WX
4 * Authors: David Elliott (C++ conversion, maintainer)
6 * Guillermo Rodriguez Garcia <guille@iies.es>
7 * Purpose: GSocket main Unix and OS/2 file
8 * Licence: The wxWindows licence
10 * -------------------------------------------------------------------------
14 * PLEASE don't put C++ comments here - this is a C source file.
17 #ifndef __GSOCKET_STANDALONE__
21 #if defined(__VISAGECPP__)
22 /* Seems to be needed by Visual Age C++, though I don't see how it manages
23 to not break on including a C++ header into a plain C source file */
25 #define BSD_SELECT /* use Berkley Sockets select */
28 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
31 #include <sys/types.h>
36 #include <netinet/in.h>
39 #include <sys/ioctl.h>
45 u_char sun_len
; /* sockaddr len including null */
46 u_char sun_family
; /* AF_UNIX */
47 char sun_path
[108]; /* path name (gag) */
50 #include <sys/socket.h>
56 #include <netinet/in.h>
57 #include <arpa/inet.h>
64 #include <machine/endian.h>
70 #define EBADF SOCEBADF
76 #include <sys/socket.h>
77 #include <sys/ioctl.h>
78 #include <sys/select.h>
80 #define close(a) soclose(a)
81 #define select(a,b,c,d,e) bsdselect(a,b,c,d,e)
82 int _System
bsdselect(int,
87 int _System
soclose(int);
91 #include <sys/select.h>
99 # include <sys/filio.h>
102 # include <bstring.h>
109 # define SOCKLEN_T unsigned int
113 # define SOCKLEN_T socklen_t
116 # define SOCKLEN_T int
121 /* undefine for OSX - its really an int */
124 # define SOCKLEN_T int
126 #endif /* SOCKLEN_T */
129 * MSW defines this, Unices don't.
131 #ifndef INVALID_SOCKET
132 #define INVALID_SOCKET -1
135 /* UnixWare reportedly needs this for FIONBIO definition */
137 #include <sys/filio.h>
141 * INADDR_BROADCAST is identical to INADDR_NONE which is not defined
142 * on all systems. INADDR_BROADCAST should be fine to indicate an error.
145 #define INADDR_NONE INADDR_BROADCAST
148 #define MASK_SIGNAL() \
150 void (*old_handler)(int); \
152 old_handler = signal(SIGPIPE, SIG_IGN);
154 #define UNMASK_SIGNAL() \
155 signal(SIGPIPE, old_handler); \
159 #ifndef __GSOCKET_STANDALONE__
160 # include "wx/unix/gsockunx.h"
161 # include "wx/gsocket.h"
163 # include "gsockunx.h"
164 # include "gsocket.h"
165 #endif /* __GSOCKET_STANDALONE__ */
167 /* debugging helpers */
168 #ifdef __GSOCKET_DEBUG__
169 # define GSocket_Debug(args) printf args
171 # define GSocket_Debug(args)
172 #endif /* __GSOCKET_DEBUG__ */
174 /* Table of GUI-related functions. We must call them indirectly because
175 * of wxBase and GUI separation: */
177 static GSocketGUIFunctionsTable
*gs_gui_functions
;
179 class GSocketGUIFunctionsTableNull
: public GSocketGUIFunctionsTable
182 virtual bool OnInit();
183 virtual void OnExit();
184 virtual bool CanUseEventLoop();
185 virtual bool Init_Socket(GSocket
*socket
);
186 virtual void Destroy_Socket(GSocket
*socket
);
187 virtual void Install_Callback(GSocket
*socket
, GSocketEvent event
);
188 virtual void Uninstall_Callback(GSocket
*socket
, GSocketEvent event
);
189 virtual void Enable_Events(GSocket
*socket
);
190 virtual void Disable_Events(GSocket
*socket
);
193 bool GSocketGUIFunctionsTableNull::OnInit()
195 void GSocketGUIFunctionsTableNull::OnExit()
197 bool GSocketGUIFunctionsTableNull::CanUseEventLoop()
199 bool GSocketGUIFunctionsTableNull::Init_Socket(GSocket
*socket
)
201 void GSocketGUIFunctionsTableNull::Destroy_Socket(GSocket
*socket
)
203 void GSocketGUIFunctionsTableNull::Install_Callback(GSocket
*socket
, GSocketEvent event
)
205 void GSocketGUIFunctionsTableNull::Uninstall_Callback(GSocket
*socket
, GSocketEvent event
)
207 void GSocketGUIFunctionsTableNull::Enable_Events(GSocket
*socket
)
209 void GSocketGUIFunctionsTableNull::Disable_Events(GSocket
*socket
)
211 /* Global initialisers */
213 void GSocket_SetGUIFunctions(GSocketGUIFunctionsTable
*guifunc
)
215 gs_gui_functions
= guifunc
;
218 int GSocket_Init(void)
220 if (!gs_gui_functions
)
222 static GSocketGUIFunctionsTableNull table
;
223 gs_gui_functions
= &table
;
225 if ( !gs_gui_functions
->OnInit() )
230 void GSocket_Cleanup(void)
232 if (gs_gui_functions
)
234 gs_gui_functions
->OnExit();
238 /* Constructors / Destructors for GSocket */
244 m_fd
= INVALID_SOCKET
;
245 for (i
=0;i
<GSOCK_MAX_EVENT
;i
++)
252 m_error
= GSOCK_NOERROR
;
255 m_gui_dependent
= NULL
;
256 m_non_blocking
= false;
258 m_timeout
= 10*60*1000;
259 /* 10 minutes * 60 sec * 1000 millisec */
260 m_establishing
= false;
262 assert(gs_gui_functions
);
263 /* Per-socket GUI-specific initialization */
264 m_ok
= gs_gui_functions
->Init_Socket(this);
267 void GSocket::Close()
269 gs_gui_functions
->Disable_Events(this);
270 /* gsockosx.c calls CFSocketInvalidate which closes the socket for us */
271 #if !(defined(__DARWIN__) && (defined(__WXMAC__) || defined(__WXCOCOA__)))
274 m_fd
= INVALID_SOCKET
;
281 /* Check that the socket is really shutdowned */
282 if (m_fd
!= INVALID_SOCKET
)
285 /* Per-socket GUI-specific cleanup */
286 gs_gui_functions
->Destroy_Socket(this);
288 /* Destroy private addresses */
290 GAddress_destroy(m_local
);
293 GAddress_destroy(m_peer
);
297 * Disallow further read/write operations on this socket, close
298 * the fd and disable all callbacks.
300 void GSocket::Shutdown()
306 /* If socket has been created, shutdown it */
307 if (m_fd
!= INVALID_SOCKET
)
313 /* Disable GUI callbacks */
314 for (evt
= 0; evt
< GSOCK_MAX_EVENT
; evt
++)
315 m_cbacks
[evt
] = NULL
;
317 m_detected
= GSOCK_LOST_FLAG
;
320 /* Address handling */
326 * Set or get the local or peer address for this socket. The 'set'
327 * functions return GSOCK_NOERROR on success, an error code otherwise.
328 * The 'get' functions return a pointer to a GAddress object on success,
329 * or NULL otherwise, in which case they set the error code of the
330 * corresponding GSocket.
333 * GSOCK_INVSOCK - the socket is not valid.
334 * GSOCK_INVADDR - the address is not valid.
336 GSocketError
GSocket::SetLocal(GAddress
*address
)
340 /* the socket must be initialized, or it must be a server */
341 if ((m_fd
!= INVALID_SOCKET
&& !m_server
))
343 m_error
= GSOCK_INVSOCK
;
344 return GSOCK_INVSOCK
;
348 if (address
== NULL
|| address
->m_family
== GSOCK_NOFAMILY
)
350 m_error
= GSOCK_INVADDR
;
351 return GSOCK_INVADDR
;
355 GAddress_destroy(m_local
);
357 m_local
= GAddress_copy(address
);
359 return GSOCK_NOERROR
;
362 GSocketError
GSocket::SetPeer(GAddress
*address
)
367 if (address
== NULL
|| address
->m_family
== GSOCK_NOFAMILY
)
369 m_error
= GSOCK_INVADDR
;
370 return GSOCK_INVADDR
;
374 GAddress_destroy(m_peer
);
376 m_peer
= GAddress_copy(address
);
378 return GSOCK_NOERROR
;
381 GAddress
*GSocket::GetLocal()
384 struct sockaddr addr
;
385 SOCKLEN_T size
= sizeof(addr
);
390 /* try to get it from the m_local var first */
392 return GAddress_copy(m_local
);
394 /* else, if the socket is initialized, try getsockname */
395 if (m_fd
== INVALID_SOCKET
)
397 m_error
= GSOCK_INVSOCK
;
401 if (getsockname(m_fd
, &addr
, (SOCKLEN_T
*) &size
) < 0)
403 m_error
= GSOCK_IOERR
;
407 /* got a valid address from getsockname, create a GAddress object */
408 address
= GAddress_new();
411 m_error
= GSOCK_MEMERR
;
415 err
= _GAddress_translate_from(address
, &addr
, size
);
416 if (err
!= GSOCK_NOERROR
)
418 GAddress_destroy(address
);
426 GAddress
*GSocket::GetPeer()
430 /* try to get it from the m_peer var */
432 return GAddress_copy(m_peer
);
437 /* Server specific parts */
439 /* GSocket_SetServer:
440 * Sets up this socket as a server. The local address must have been
441 * set with GSocket_SetLocal() before GSocket_SetServer() is called.
442 * Returns GSOCK_NOERROR on success, one of the following otherwise:
445 * GSOCK_INVSOCK - the socket is in use.
446 * GSOCK_INVADDR - the local address has not been set.
447 * GSOCK_IOERR - low-level error.
449 GSocketError
GSocket::SetServer()
455 /* must not be in use */
456 if (m_fd
!= INVALID_SOCKET
)
458 m_error
= GSOCK_INVSOCK
;
459 return GSOCK_INVSOCK
;
462 /* the local addr must have been set */
465 m_error
= GSOCK_INVADDR
;
466 return GSOCK_INVADDR
;
469 /* Initialize all fields */
473 /* Create the socket */
474 m_fd
= socket(m_local
->m_realfamily
, SOCK_STREAM
, 0);
476 if (m_fd
== INVALID_SOCKET
)
478 m_error
= GSOCK_IOERR
;
481 #if defined(__EMX__) || defined(__VISAGECPP__)
482 ioctl(m_fd
, FIONBIO
, (char*)&arg
, sizeof(arg
));
484 ioctl(m_fd
, FIONBIO
, &arg
);
486 gs_gui_functions
->Enable_Events(this);
488 /* allow a socket to re-bind if the socket is in the TIME_WAIT
489 state after being previously closed.
492 setsockopt(m_fd
, SOL_SOCKET
, SO_REUSEADDR
, (const char*)&arg
, sizeof(u_long
));
494 /* Bind to the local address,
495 * retrieve the actual address bound,
496 * and listen up to 5 connections.
498 if ((bind(m_fd
, m_local
->m_addr
, m_local
->m_len
) != 0) ||
501 (SOCKLEN_T
*) &m_local
->m_len
) != 0) ||
502 (listen(m_fd
, 5) != 0))
505 m_error
= GSOCK_IOERR
;
509 return GSOCK_NOERROR
;
512 /* GSocket_WaitConnection:
513 * Waits for an incoming client connection. Returns a pointer to
514 * a GSocket object, or NULL if there was an error, in which case
515 * the last error field will be updated for the calling GSocket.
517 * Error codes (set in the calling GSocket)
518 * GSOCK_INVSOCK - the socket is not valid or not a server.
519 * GSOCK_TIMEDOUT - timeout, no incoming connections.
520 * GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
521 * GSOCK_MEMERR - couldn't allocate memory.
522 * GSOCK_IOERR - low-level error.
524 GSocket
*GSocket::WaitConnection()
526 struct sockaddr from
;
527 SOCKLEN_T fromlen
= sizeof(from
);
534 /* Reenable CONNECTION events */
535 Enable(GSOCK_CONNECTION
);
537 /* If the socket has already been created, we exit immediately */
538 if (m_fd
== INVALID_SOCKET
|| !m_server
)
540 m_error
= GSOCK_INVSOCK
;
544 /* Create a GSocket object for the new connection */
545 connection
= GSocket_new();
549 m_error
= GSOCK_MEMERR
;
553 /* Wait for a connection (with timeout) */
554 if (Input_Timeout() == GSOCK_TIMEDOUT
)
557 /* m_error set by _GSocket_Input_Timeout */
561 connection
->m_fd
= accept(m_fd
, &from
, (SOCKLEN_T
*) &fromlen
);
563 if (connection
->m_fd
== INVALID_SOCKET
)
565 if (errno
== EWOULDBLOCK
)
566 m_error
= GSOCK_WOULDBLOCK
;
568 m_error
= GSOCK_IOERR
;
574 /* Initialize all fields */
575 connection
->m_server
= false;
576 connection
->m_stream
= true;
578 /* Setup the peer address field */
579 connection
->m_peer
= GAddress_new();
580 if (!connection
->m_peer
)
583 m_error
= GSOCK_MEMERR
;
586 err
= _GAddress_translate_from(connection
->m_peer
, &from
, fromlen
);
587 if (err
!= GSOCK_NOERROR
)
589 GAddress_destroy(connection
->m_peer
);
594 #if defined(__EMX__) || defined(__VISAGECPP__)
595 ioctl(connection
->m_fd
, FIONBIO
, (char*)&arg
, sizeof(arg
));
597 ioctl(connection
->m_fd
, FIONBIO
, &arg
);
599 gs_gui_functions
->Enable_Events(connection
);
604 bool GSocket::SetReusable()
606 /* socket must not be null, and must not be in use/already bound */
607 if (this && m_fd
== INVALID_SOCKET
) {
614 /* Client specific parts */
617 * For stream (connection oriented) sockets, GSocket_Connect() tries
618 * to establish a client connection to a server using the peer address
619 * as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the
620 * connection has been succesfully established, or one of the error
621 * codes listed below. Note that for nonblocking sockets, a return
622 * value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
623 * request can be completed later; you should use GSocket_Select()
624 * to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the
625 * corresponding asynchronous events.
627 * For datagram (non connection oriented) sockets, GSocket_Connect()
628 * just sets the peer address established with GSocket_SetPeer() as
629 * default destination.
632 * GSOCK_INVSOCK - the socket is in use or not valid.
633 * GSOCK_INVADDR - the peer address has not been established.
634 * GSOCK_TIMEDOUT - timeout, the connection failed.
635 * GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
636 * GSOCK_MEMERR - couldn't allocate memory.
637 * GSOCK_IOERR - low-level error.
639 GSocketError
GSocket::Connect(GSocketStream stream
)
646 /* Enable CONNECTION events (needed for nonblocking connections) */
647 Enable(GSOCK_CONNECTION
);
649 if (m_fd
!= INVALID_SOCKET
)
651 m_error
= GSOCK_INVSOCK
;
652 return GSOCK_INVSOCK
;
657 m_error
= GSOCK_INVADDR
;
658 return GSOCK_INVADDR
;
661 /* Streamed or dgram socket? */
662 m_stream
= (stream
== GSOCK_STREAMED
);
664 m_establishing
= false;
666 /* Create the socket */
667 m_fd
= socket(m_peer
->m_realfamily
,
668 m_stream
? SOCK_STREAM
: SOCK_DGRAM
, 0);
670 if (m_fd
== INVALID_SOCKET
)
672 m_error
= GSOCK_IOERR
;
675 #if defined(__EMX__) || defined(__VISAGECPP__)
676 ioctl(m_fd
, FIONBIO
, (char*)&arg
, sizeof(arg
));
678 ioctl(m_fd
, FIONBIO
, &arg
);
680 gs_gui_functions
->Enable_Events(this);
682 /* Connect it to the peer address, with a timeout (see below) */
683 ret
= connect(m_fd
, m_peer
->m_addr
, m_peer
->m_len
);
689 /* If connect failed with EINPROGRESS and the GSocket object
690 * is in blocking mode, we select() for the specified timeout
691 * checking for writability to see if the connection request
694 if ((err
== EINPROGRESS
) && (!m_non_blocking
))
696 if (Output_Timeout() == GSOCK_TIMEDOUT
)
699 /* m_error is set in _GSocket_Output_Timeout */
700 return GSOCK_TIMEDOUT
;
705 SOCKLEN_T len
= sizeof(error
);
707 getsockopt(m_fd
, SOL_SOCKET
, SO_ERROR
, (void*) &error
, &len
);
710 return GSOCK_NOERROR
;
714 /* If connect failed with EINPROGRESS and the GSocket object
715 * is set to nonblocking, we set m_error to GSOCK_WOULDBLOCK
716 * (and return GSOCK_WOULDBLOCK) but we don't close the socket;
717 * this way if the connection completes, a GSOCK_CONNECTION
718 * event will be generated, if enabled.
720 if ((err
== EINPROGRESS
) && (m_non_blocking
))
722 m_establishing
= true;
723 m_error
= GSOCK_WOULDBLOCK
;
724 return GSOCK_WOULDBLOCK
;
727 /* If connect failed with an error other than EINPROGRESS,
728 * then the call to GSocket_Connect has failed.
731 m_error
= GSOCK_IOERR
;
735 return GSOCK_NOERROR
;
738 /* Datagram sockets */
740 /* GSocket_SetNonOriented:
741 * Sets up this socket as a non-connection oriented (datagram) socket.
742 * Before using this function, the local address must have been set
743 * with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR
744 * on success, or one of the following otherwise.
747 * GSOCK_INVSOCK - the socket is in use.
748 * GSOCK_INVADDR - the local address has not been set.
749 * GSOCK_IOERR - low-level error.
751 GSocketError
GSocket::SetNonOriented()
757 if (m_fd
!= INVALID_SOCKET
)
759 m_error
= GSOCK_INVSOCK
;
760 return GSOCK_INVSOCK
;
765 m_error
= GSOCK_INVADDR
;
766 return GSOCK_INVADDR
;
769 /* Initialize all fields */
773 /* Create the socket */
774 m_fd
= socket(m_local
->m_realfamily
, SOCK_DGRAM
, 0);
776 if (m_fd
== INVALID_SOCKET
)
778 m_error
= GSOCK_IOERR
;
781 #if defined(__EMX__) || defined(__VISAGECPP__)
782 ioctl(m_fd
, FIONBIO
, (char*)&arg
, sizeof(arg
));
784 ioctl(m_fd
, FIONBIO
, &arg
);
786 gs_gui_functions
->Enable_Events(this);
788 /* Bind to the local address,
789 * and retrieve the actual address bound.
791 if ((bind(m_fd
, m_local
->m_addr
, m_local
->m_len
) != 0) ||
794 (SOCKLEN_T
*) &m_local
->m_len
) != 0))
797 m_error
= GSOCK_IOERR
;
801 return GSOCK_NOERROR
;
806 /* Like recv(), send(), ... */
807 int GSocket::Read(char *buffer
, int size
)
813 if (m_fd
== INVALID_SOCKET
|| m_server
)
815 m_error
= GSOCK_INVSOCK
;
819 /* Disable events during query of socket status */
820 Disable(GSOCK_INPUT
);
822 /* If the socket is blocking, wait for data (with a timeout) */
823 if (Input_Timeout() == GSOCK_TIMEDOUT
)
824 /* We no longer return here immediately, otherwise socket events would not be re-enabled! */
829 ret
= Recv_Stream(buffer
, size
);
831 ret
= Recv_Dgram(buffer
, size
);
836 if (errno
== EWOULDBLOCK
)
837 m_error
= GSOCK_WOULDBLOCK
;
839 m_error
= GSOCK_IOERR
;
842 /* Enable events again now that we are done processing */
848 int GSocket::Write(const char *buffer
, int size
)
854 GSocket_Debug(( "GSocket_Write #1, size %d\n", size
));
856 if (m_fd
== INVALID_SOCKET
|| m_server
)
858 m_error
= GSOCK_INVSOCK
;
862 GSocket_Debug(( "GSocket_Write #2, size %d\n", size
));
864 /* If the socket is blocking, wait for writability (with a timeout) */
865 if (Output_Timeout() == GSOCK_TIMEDOUT
)
868 GSocket_Debug(( "GSocket_Write #3, size %d\n", size
));
872 ret
= Send_Stream(buffer
, size
);
874 ret
= Send_Dgram(buffer
, size
);
876 GSocket_Debug(( "GSocket_Write #4, size %d\n", size
));
880 if (errno
== EWOULDBLOCK
)
882 m_error
= GSOCK_WOULDBLOCK
;
883 GSocket_Debug(( "GSocket_Write error WOULDBLOCK\n" ));
887 m_error
= GSOCK_IOERR
;
888 GSocket_Debug(( "GSocket_Write error IOERR\n" ));
891 /* Only reenable OUTPUT events after an error (just like WSAAsyncSelect
892 * in MSW). Once the first OUTPUT event is received, users can assume
893 * that the socket is writable until a read operation fails. Only then
894 * will further OUTPUT events be posted.
896 Enable(GSOCK_OUTPUT
);
900 GSocket_Debug(( "GSocket_Write #5, size %d ret %d\n", size
, ret
));
906 * Polls the socket to determine its status. This function will
907 * check for the events specified in the 'flags' parameter, and
908 * it will return a mask indicating which operations can be
909 * performed. This function won't block, regardless of the
910 * mode (blocking | nonblocking) of the socket.
912 GSocketEventFlags
GSocket::Select(GSocketEventFlags flags
)
914 if (!gs_gui_functions
->CanUseEventLoop())
917 GSocketEventFlags result
= 0;
925 /* Do not use a static struct, Linux can garble it */
926 tv
.tv_sec
= m_timeout
/ 1000;
927 tv
.tv_usec
= (m_timeout
% 1000) * 1000;
932 FD_SET(m_fd
, &readfds
);
933 if (flags
& GSOCK_OUTPUT_FLAG
|| flags
& GSOCK_CONNECTION_FLAG
)
934 FD_SET(m_fd
, &writefds
);
935 FD_SET(m_fd
, &exceptfds
);
937 /* Check 'sticky' CONNECTION flag first */
938 result
|= (GSOCK_CONNECTION_FLAG
& m_detected
);
940 /* If we have already detected a LOST event, then don't try
941 * to do any further processing.
943 if ((m_detected
& GSOCK_LOST_FLAG
) != 0)
945 m_establishing
= false;
947 return (GSOCK_LOST_FLAG
& flags
);
951 if (select(m_fd
+ 1, &readfds
, &writefds
, &exceptfds
, &tv
) <= 0)
953 /* What to do here? */
954 return (result
& flags
);
957 /* Check for readability */
958 if (FD_ISSET(m_fd
, &readfds
))
962 if (recv(m_fd
, &c
, 1, MSG_PEEK
) > 0)
964 result
|= GSOCK_INPUT_FLAG
;
968 if (m_server
&& m_stream
)
970 result
|= GSOCK_CONNECTION_FLAG
;
971 m_detected
|= GSOCK_CONNECTION_FLAG
;
975 m_detected
= GSOCK_LOST_FLAG
;
976 m_establishing
= false;
978 /* LOST event: Abort any further processing */
979 return (GSOCK_LOST_FLAG
& flags
);
984 /* Check for writability */
985 if (FD_ISSET(m_fd
, &writefds
))
987 if (m_establishing
&& !m_server
)
990 SOCKLEN_T len
= sizeof(error
);
992 m_establishing
= false;
994 getsockopt(m_fd
, SOL_SOCKET
, SO_ERROR
, (void*)&error
, &len
);
998 m_detected
= GSOCK_LOST_FLAG
;
1000 /* LOST event: Abort any further processing */
1001 return (GSOCK_LOST_FLAG
& flags
);
1005 result
|= GSOCK_CONNECTION_FLAG
;
1006 m_detected
|= GSOCK_CONNECTION_FLAG
;
1011 result
|= GSOCK_OUTPUT_FLAG
;
1015 /* Check for exceptions and errors (is this useful in Unices?) */
1016 if (FD_ISSET(m_fd
, &exceptfds
))
1018 m_establishing
= false;
1019 m_detected
= GSOCK_LOST_FLAG
;
1021 /* LOST event: Abort any further processing */
1022 return (GSOCK_LOST_FLAG
& flags
);
1025 return (result
& flags
);
1032 return flags
& m_detected
;
1039 /* GSocket_SetNonBlocking:
1040 * Sets the socket to non-blocking mode. All IO calls will return
1043 void GSocket::SetNonBlocking(bool non_block
)
1047 GSocket_Debug( ("GSocket_SetNonBlocking: %d\n", (int)non_block
) );
1049 m_non_blocking
= non_block
;
1052 /* GSocket_SetTimeout:
1053 * Sets the timeout for blocking calls. Time is expressed in
1056 void GSocket::SetTimeout(unsigned long millisec
)
1060 m_timeout
= millisec
;
1063 /* GSocket_GetError:
1064 * Returns the last error occured for this socket. Note that successful
1065 * operations do not clear this back to GSOCK_NOERROR, so use it only
1068 GSocketError WXDLLIMPEXP_NET
GSocket::GetError()
1078 * There is data to be read in the input buffer. If, after a read
1079 * operation, there is still data available, the callback function will
1082 * The socket is available for writing. That is, the next write call
1083 * won't block. This event is generated only once, when the connection is
1084 * first established, and then only if a call failed with GSOCK_WOULDBLOCK,
1085 * when the output buffer empties again. This means that the app should
1086 * assume that it can write since the first OUTPUT event, and no more
1087 * OUTPUT events will be generated unless an error occurs.
1089 * Connection succesfully established, for client sockets, or incoming
1090 * client connection, for server sockets. Wait for this event (also watch
1091 * out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
1093 * The connection is lost (or a connection request failed); this could
1094 * be due to a failure, or due to the peer closing it gracefully.
1097 /* GSocket_SetCallback:
1098 * Enables the callbacks specified by 'flags'. Note that 'flags'
1099 * may be a combination of flags OR'ed toghether, so the same
1100 * callback function can be made to accept different events.
1101 * The callback function must have the following prototype:
1103 * void function(GSocket *socket, GSocketEvent event, char *cdata)
1105 void GSocket::SetCallback(GSocketEventFlags flags
,
1106 GSocketCallback callback
, char *cdata
)
1112 for (count
= 0; count
< GSOCK_MAX_EVENT
; count
++)
1114 if ((flags
& (1 << count
)) != 0)
1116 m_cbacks
[count
] = callback
;
1117 m_data
[count
] = cdata
;
1122 /* GSocket_UnsetCallback:
1123 * Disables all callbacks specified by 'flags', which may be a
1124 * combination of flags OR'ed toghether.
1126 void GSocket::UnsetCallback(GSocketEventFlags flags
)
1132 for (count
= 0; count
< GSOCK_MAX_EVENT
; count
++)
1134 if ((flags
& (1 << count
)) != 0)
1136 m_cbacks
[count
] = NULL
;
1137 m_data
[count
] = NULL
;
1142 GSocketError
GSocket::GetSockOpt(int level
, int optname
,
1143 void *optval
, int *optlen
)
1145 if (getsockopt(m_fd
, level
, optname
, optval
, (SOCKLEN_T
*)optlen
) == 0)
1147 return GSOCK_NOERROR
;
1149 return GSOCK_OPTERR
;
1152 GSocketError
GSocket::SetSockOpt(int level
, int optname
,
1153 const void *optval
, int optlen
)
1155 if (setsockopt(m_fd
, level
, optname
, optval
, optlen
) == 0)
1157 return GSOCK_NOERROR
;
1159 return GSOCK_OPTERR
;
1162 #define CALL_CALLBACK(socket, event) { \
1163 socket->Disable(event); \
1164 if (socket->m_cbacks[event]) \
1165 socket->m_cbacks[event](socket, event, socket->m_data[event]); \
1169 void GSocket::Enable(GSocketEvent event
)
1171 m_detected
&= ~(1 << event
);
1172 gs_gui_functions
->Install_Callback(this, event
);
1175 void GSocket::Disable(GSocketEvent event
)
1177 m_detected
|= (1 << event
);
1178 gs_gui_functions
->Uninstall_Callback(this, event
);
1181 /* _GSocket_Input_Timeout:
1182 * For blocking sockets, wait until data is available or
1183 * until timeout ellapses.
1185 GSocketError
GSocket::Input_Timeout()
1191 /* Linux select() will overwrite the struct on return */
1192 tv
.tv_sec
= (m_timeout
/ 1000);
1193 tv
.tv_usec
= (m_timeout
% 1000) * 1000;
1195 if (!m_non_blocking
)
1198 FD_SET(m_fd
, &readfds
);
1199 ret
= select(m_fd
+ 1, &readfds
, NULL
, NULL
, &tv
);
1202 GSocket_Debug(( "GSocket_Input_Timeout, select returned 0\n" ));
1203 m_error
= GSOCK_TIMEDOUT
;
1204 return GSOCK_TIMEDOUT
;
1208 GSocket_Debug(( "GSocket_Input_Timeout, select returned -1\n" ));
1209 if (errno
== EBADF
) { GSocket_Debug(( "Invalid file descriptor\n" )); }
1210 if (errno
== EINTR
) { GSocket_Debug(( "A non blocked signal was caught\n" )); }
1211 if (errno
== EINVAL
) { GSocket_Debug(( "The highest number descriptor is negative\n" )); }
1212 if (errno
== ENOMEM
) { GSocket_Debug(( "Not enough memory\n" )); }
1213 m_error
= GSOCK_TIMEDOUT
;
1214 return GSOCK_TIMEDOUT
;
1217 return GSOCK_NOERROR
;
1220 /* _GSocket_Output_Timeout:
1221 * For blocking sockets, wait until data can be sent without
1222 * blocking or until timeout ellapses.
1224 GSocketError
GSocket::Output_Timeout()
1230 /* Linux select() will overwrite the struct on return */
1231 tv
.tv_sec
= (m_timeout
/ 1000);
1232 tv
.tv_usec
= (m_timeout
% 1000) * 1000;
1234 GSocket_Debug( ("m_non_blocking has: %d\n", (int)m_non_blocking
) );
1236 if (!m_non_blocking
)
1239 FD_SET(m_fd
, &writefds
);
1240 ret
= select(m_fd
+ 1, NULL
, &writefds
, NULL
, &tv
);
1243 GSocket_Debug(( "GSocket_Output_Timeout, select returned 0\n" ));
1244 m_error
= GSOCK_TIMEDOUT
;
1245 return GSOCK_TIMEDOUT
;
1249 GSocket_Debug(( "GSocket_Output_Timeout, select returned -1\n" ));
1250 if (errno
== EBADF
) { GSocket_Debug(( "Invalid file descriptor\n" )); }
1251 if (errno
== EINTR
) { GSocket_Debug(( "A non blocked signal was caught\n" )); }
1252 if (errno
== EINVAL
) { GSocket_Debug(( "The highest number descriptor is negative\n" )); }
1253 if (errno
== ENOMEM
) { GSocket_Debug(( "Not enough memory\n" )); }
1254 m_error
= GSOCK_TIMEDOUT
;
1255 return GSOCK_TIMEDOUT
;
1257 if ( ! FD_ISSET(m_fd
, &writefds
) ) {
1258 GSocket_Debug(( "GSocket_Output_Timeout is buggy!\n" ));
1261 GSocket_Debug(( "GSocket_Output_Timeout seems correct\n" ));
1266 GSocket_Debug(( "GSocket_Output_Timeout, didn't try select!\n" ));
1269 return GSOCK_NOERROR
;
1272 int GSocket::Recv_Stream(char *buffer
, int size
)
1274 return recv(m_fd
, buffer
, size
, 0);
1277 int GSocket::Recv_Dgram(char *buffer
, int size
)
1279 struct sockaddr from
;
1280 SOCKLEN_T fromlen
= sizeof(from
);
1284 fromlen
= sizeof(from
);
1286 ret
= recvfrom(m_fd
, buffer
, size
, 0, &from
, (SOCKLEN_T
*) &fromlen
);
1291 /* Translate a system address into a GSocket address */
1294 m_peer
= GAddress_new();
1297 m_error
= GSOCK_MEMERR
;
1301 err
= _GAddress_translate_from(m_peer
, &from
, fromlen
);
1302 if (err
!= GSOCK_NOERROR
)
1304 GAddress_destroy(m_peer
);
1313 int GSocket::Send_Stream(const char *buffer
, int size
)
1317 #ifndef __VISAGECPP__
1319 ret
= send(m_fd
, buffer
, size
, 0);
1322 ret
= send(m_fd
, (char *)buffer
, size
, 0);
1328 int GSocket::Send_Dgram(const char *buffer
, int size
)
1330 struct sockaddr
*addr
;
1336 m_error
= GSOCK_INVADDR
;
1340 err
= _GAddress_translate_to(m_peer
, &addr
, &len
);
1341 if (err
!= GSOCK_NOERROR
)
1347 #ifndef __VISAGECPP__
1349 ret
= sendto(m_fd
, buffer
, size
, 0, addr
, len
);
1352 ret
= sendto(m_fd
, (char *)buffer
, size
, 0, addr
, len
);
1355 /* Frees memory allocated from _GAddress_translate_to */
1361 void GSocket::Detected_Read()
1365 /* If we have already detected a LOST event, then don't try
1366 * to do any further processing.
1368 if ((m_detected
& GSOCK_LOST_FLAG
) != 0)
1370 m_establishing
= false;
1372 CALL_CALLBACK(this, GSOCK_LOST
);
1377 if (recv(m_fd
, &c
, 1, MSG_PEEK
) > 0)
1379 CALL_CALLBACK(this, GSOCK_INPUT
);
1383 if (m_server
&& m_stream
)
1385 CALL_CALLBACK(this, GSOCK_CONNECTION
);
1389 CALL_CALLBACK(this, GSOCK_LOST
);
1395 void GSocket::Detected_Write()
1397 /* If we have already detected a LOST event, then don't try
1398 * to do any further processing.
1400 if ((m_detected
& GSOCK_LOST_FLAG
) != 0)
1402 m_establishing
= false;
1404 CALL_CALLBACK(this, GSOCK_LOST
);
1409 if (m_establishing
&& !m_server
)
1412 SOCKLEN_T len
= sizeof(error
);
1414 m_establishing
= false;
1416 getsockopt(m_fd
, SOL_SOCKET
, SO_ERROR
, (void*)&error
, &len
);
1420 CALL_CALLBACK(this, GSOCK_LOST
);
1425 CALL_CALLBACK(this, GSOCK_CONNECTION
);
1426 /* We have to fire this event by hand because CONNECTION (for clients)
1427 * and OUTPUT are internally the same and we just disabled CONNECTION
1428 * events with the above macro.
1430 CALL_CALLBACK(this, GSOCK_OUTPUT
);
1435 CALL_CALLBACK(this, GSOCK_OUTPUT
);
1439 /* Compatibility functions for GSocket */
1440 GSocket
*GSocket_new(void)
1442 GSocket
*newsocket
= new GSocket();
1443 if(newsocket
->IsOk())
1450 * -------------------------------------------------------------------------
1452 * -------------------------------------------------------------------------
1455 /* CHECK_ADDRESS verifies that the current address family is either
1456 * GSOCK_NOFAMILY or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it
1457 * initalizes it to be a GSOCK_*family*. In other cases, it returns
1458 * an appropiate error code.
1460 * CHECK_ADDRESS_RETVAL does the same but returning 'retval' on error.
1462 #define CHECK_ADDRESS(address, family) \
1464 if (address->m_family == GSOCK_NOFAMILY) \
1465 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1466 return address->m_error; \
1467 if (address->m_family != GSOCK_##family) \
1469 address->m_error = GSOCK_INVADDR; \
1470 return GSOCK_INVADDR; \
1474 #define CHECK_ADDRESS_RETVAL(address, family, retval) \
1476 if (address->m_family == GSOCK_NOFAMILY) \
1477 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1479 if (address->m_family != GSOCK_##family) \
1481 address->m_error = GSOCK_INVADDR; \
1487 GAddress
*GAddress_new(void)
1491 if ((address
= (GAddress
*) malloc(sizeof(GAddress
))) == NULL
)
1494 address
->m_family
= GSOCK_NOFAMILY
;
1495 address
->m_addr
= NULL
;
1501 GAddress
*GAddress_copy(GAddress
*address
)
1505 assert(address
!= NULL
);
1507 if ((addr2
= (GAddress
*) malloc(sizeof(GAddress
))) == NULL
)
1510 memcpy(addr2
, address
, sizeof(GAddress
));
1512 if (address
->m_addr
&& address
->m_len
> 0)
1514 addr2
->m_addr
= (struct sockaddr
*)malloc(addr2
->m_len
);
1515 if (addr2
->m_addr
== NULL
)
1520 memcpy(addr2
->m_addr
, address
->m_addr
, addr2
->m_len
);
1526 void GAddress_destroy(GAddress
*address
)
1528 assert(address
!= NULL
);
1530 if (address
->m_addr
)
1531 free(address
->m_addr
);
1536 void GAddress_SetFamily(GAddress
*address
, GAddressType type
)
1538 assert(address
!= NULL
);
1540 address
->m_family
= type
;
1543 GAddressType
GAddress_GetFamily(GAddress
*address
)
1545 assert(address
!= NULL
);
1547 return address
->m_family
;
1550 GSocketError
_GAddress_translate_from(GAddress
*address
,
1551 struct sockaddr
*addr
, int len
)
1553 address
->m_realfamily
= addr
->sa_family
;
1554 switch (addr
->sa_family
)
1557 address
->m_family
= GSOCK_INET
;
1560 address
->m_family
= GSOCK_UNIX
;
1564 address
->m_family
= GSOCK_INET6
;
1569 address
->m_error
= GSOCK_INVOP
;
1574 if (address
->m_addr
)
1575 free(address
->m_addr
);
1577 address
->m_len
= len
;
1578 address
->m_addr
= (struct sockaddr
*)malloc(len
);
1580 if (address
->m_addr
== NULL
)
1582 address
->m_error
= GSOCK_MEMERR
;
1583 return GSOCK_MEMERR
;
1585 memcpy(address
->m_addr
, addr
, len
);
1587 return GSOCK_NOERROR
;
1590 GSocketError
_GAddress_translate_to(GAddress
*address
,
1591 struct sockaddr
**addr
, int *len
)
1593 if (!address
->m_addr
)
1595 address
->m_error
= GSOCK_INVADDR
;
1596 return GSOCK_INVADDR
;
1599 *len
= address
->m_len
;
1600 *addr
= (struct sockaddr
*)malloc(address
->m_len
);
1603 address
->m_error
= GSOCK_MEMERR
;
1604 return GSOCK_MEMERR
;
1607 memcpy(*addr
, address
->m_addr
, address
->m_len
);
1608 return GSOCK_NOERROR
;
1612 * -------------------------------------------------------------------------
1613 * Internet address family
1614 * -------------------------------------------------------------------------
1617 GSocketError
_GAddress_Init_INET(GAddress
*address
)
1619 address
->m_len
= sizeof(struct sockaddr_in
);
1620 address
->m_addr
= (struct sockaddr
*) malloc(address
->m_len
);
1621 if (address
->m_addr
== NULL
)
1623 address
->m_error
= GSOCK_MEMERR
;
1624 return GSOCK_MEMERR
;
1627 address
->m_family
= GSOCK_INET
;
1628 address
->m_realfamily
= PF_INET
;
1629 ((struct sockaddr_in
*)address
->m_addr
)->sin_family
= AF_INET
;
1630 ((struct sockaddr_in
*)address
->m_addr
)->sin_addr
.s_addr
= INADDR_ANY
;
1632 return GSOCK_NOERROR
;
1635 GSocketError
GAddress_INET_SetHostName(GAddress
*address
, const char *hostname
)
1638 struct in_addr
*addr
;
1640 assert(address
!= NULL
);
1642 CHECK_ADDRESS(address
, INET
);
1644 addr
= &(((struct sockaddr_in
*)address
->m_addr
)->sin_addr
);
1646 /* If it is a numeric host name, convert it now */
1647 #if defined(HAVE_INET_ATON)
1648 if (inet_aton(hostname
, addr
) == 0)
1650 #elif defined(HAVE_INET_ADDR)
1651 if ( (addr
->s_addr
= inet_addr(hostname
)) == -1 )
1654 /* Use gethostbyname by default */
1656 int val
= 1; /* VA doesn't like constants in conditional expressions */
1661 struct in_addr
*array_addr
;
1663 /* It is a real name, we solve it */
1664 if ((he
= gethostbyname(hostname
)) == NULL
)
1666 /* Reset to invalid address */
1667 addr
->s_addr
= INADDR_NONE
;
1668 address
->m_error
= GSOCK_NOHOST
;
1669 return GSOCK_NOHOST
;
1671 array_addr
= (struct in_addr
*) *(he
->h_addr_list
);
1672 addr
->s_addr
= array_addr
[0].s_addr
;
1674 return GSOCK_NOERROR
;
1677 GSocketError
GAddress_INET_SetAnyAddress(GAddress
*address
)
1679 return GAddress_INET_SetHostAddress(address
, INADDR_ANY
);
1682 GSocketError
GAddress_INET_SetHostAddress(GAddress
*address
,
1683 unsigned long hostaddr
)
1685 struct in_addr
*addr
;
1687 assert(address
!= NULL
);
1689 CHECK_ADDRESS(address
, INET
);
1691 addr
= &(((struct sockaddr_in
*)address
->m_addr
)->sin_addr
);
1692 addr
->s_addr
= htonl(hostaddr
);
1694 return GSOCK_NOERROR
;
1697 GSocketError
GAddress_INET_SetPortName(GAddress
*address
, const char *port
,
1698 const char *protocol
)
1701 struct sockaddr_in
*addr
;
1703 assert(address
!= NULL
);
1704 CHECK_ADDRESS(address
, INET
);
1708 address
->m_error
= GSOCK_INVPORT
;
1709 return GSOCK_INVPORT
;
1712 se
= getservbyname(port
, protocol
);
1715 /* the cast to int suppresses compiler warnings about subscript having the
1717 if (isdigit((int)port
[0]))
1721 port_int
= atoi(port
);
1722 addr
= (struct sockaddr_in
*)address
->m_addr
;
1723 addr
->sin_port
= htons(port_int
);
1724 return GSOCK_NOERROR
;
1727 address
->m_error
= GSOCK_INVPORT
;
1728 return GSOCK_INVPORT
;
1731 addr
= (struct sockaddr_in
*)address
->m_addr
;
1732 addr
->sin_port
= se
->s_port
;
1734 return GSOCK_NOERROR
;
1737 GSocketError
GAddress_INET_SetPort(GAddress
*address
, unsigned short port
)
1739 struct sockaddr_in
*addr
;
1741 assert(address
!= NULL
);
1742 CHECK_ADDRESS(address
, INET
);
1744 addr
= (struct sockaddr_in
*)address
->m_addr
;
1745 addr
->sin_port
= htons(port
);
1747 return GSOCK_NOERROR
;
1750 GSocketError
GAddress_INET_GetHostName(GAddress
*address
, char *hostname
, size_t sbuf
)
1754 struct sockaddr_in
*addr
;
1756 assert(address
!= NULL
);
1757 CHECK_ADDRESS(address
, INET
);
1759 addr
= (struct sockaddr_in
*)address
->m_addr
;
1760 addr_buf
= (char *)&(addr
->sin_addr
);
1762 he
= gethostbyaddr(addr_buf
, sizeof(addr
->sin_addr
), AF_INET
);
1765 address
->m_error
= GSOCK_NOHOST
;
1766 return GSOCK_NOHOST
;
1769 strncpy(hostname
, he
->h_name
, sbuf
);
1771 return GSOCK_NOERROR
;
1774 unsigned long GAddress_INET_GetHostAddress(GAddress
*address
)
1776 struct sockaddr_in
*addr
;
1778 assert(address
!= NULL
);
1779 CHECK_ADDRESS_RETVAL(address
, INET
, 0);
1781 addr
= (struct sockaddr_in
*)address
->m_addr
;
1783 return ntohl(addr
->sin_addr
.s_addr
);
1786 unsigned short GAddress_INET_GetPort(GAddress
*address
)
1788 struct sockaddr_in
*addr
;
1790 assert(address
!= NULL
);
1791 CHECK_ADDRESS_RETVAL(address
, INET
, 0);
1793 addr
= (struct sockaddr_in
*)address
->m_addr
;
1794 return ntohs(addr
->sin_port
);
1798 * -------------------------------------------------------------------------
1799 * Unix address family
1800 * -------------------------------------------------------------------------
1803 #ifndef __VISAGECPP__
1804 GSocketError
_GAddress_Init_UNIX(GAddress
*address
)
1806 address
->m_len
= sizeof(struct sockaddr_un
);
1807 address
->m_addr
= (struct sockaddr
*)malloc(address
->m_len
);
1808 if (address
->m_addr
== NULL
)
1810 address
->m_error
= GSOCK_MEMERR
;
1811 return GSOCK_MEMERR
;
1814 address
->m_family
= GSOCK_UNIX
;
1815 address
->m_realfamily
= PF_UNIX
;
1816 ((struct sockaddr_un
*)address
->m_addr
)->sun_family
= AF_UNIX
;
1817 ((struct sockaddr_un
*)address
->m_addr
)->sun_path
[0] = 0;
1819 return GSOCK_NOERROR
;
1822 #define UNIX_SOCK_PATHLEN (sizeof(addr->sun_path)/sizeof(addr->sun_path[0]))
1824 GSocketError
GAddress_UNIX_SetPath(GAddress
*address
, const char *path
)
1826 struct sockaddr_un
*addr
;
1828 assert(address
!= NULL
);
1830 CHECK_ADDRESS(address
, UNIX
);
1832 addr
= ((struct sockaddr_un
*)address
->m_addr
);
1833 strncpy(addr
->sun_path
, path
, UNIX_SOCK_PATHLEN
);
1834 addr
->sun_path
[UNIX_SOCK_PATHLEN
- 1] = '\0';
1836 return GSOCK_NOERROR
;
1839 GSocketError
GAddress_UNIX_GetPath(GAddress
*address
, char *path
, size_t sbuf
)
1841 struct sockaddr_un
*addr
;
1843 assert(address
!= NULL
);
1844 CHECK_ADDRESS(address
, UNIX
);
1846 addr
= (struct sockaddr_un
*)address
->m_addr
;
1848 strncpy(path
, addr
->sun_path
, sbuf
);
1850 return GSOCK_NOERROR
;
1852 #endif /* !defined(__VISAGECPP__) */
1853 #endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */