]>
git.saurik.com Git - wxWidgets.git/blob - src/unix/gsocket.c
1 /* -------------------------------------------------------------------------
2 * Project: GSocket (Generic Socket) for WX
4 * Authors: Guilhem Lavaux,
5 * Guillermo Rodriguez Garcia <guille@iies.es> (maintainer)
6 * Purpose: GSocket main Unix file
8 * -------------------------------------------------------------------------
12 * PLEASE don't put C++ comments here - this is a C source file.
15 #ifndef __GSOCKET_STANDALONE__
19 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
22 #include <sys/types.h>
24 #include <sys/ioctl.h>
30 u_char sun_len
; /* sockaddr len including null */
31 u_char sun_family
; /* AF_UNIX */
32 char sun_path
[108]; /* path name (gag) */
35 #include <sys/socket.h>
40 #include <netinet/in.h>
41 #include <arpa/inet.h>
50 # include <sys/filio.h>
60 # define SOCKLEN_T unsigned int
64 # define SOCKLEN_T socklen_t
67 # define SOCKLEN_T int
71 #endif /* SOCKLEN_T */
74 * MSW defines this, Unices don't.
76 #ifndef INVALID_SOCKET
77 #define INVALID_SOCKET -1
81 * INADDR_BROADCAST is identical to INADDR_NONE which is not defined
82 * on all systems. INADDR_BROADCAST should be fine to indicate an error.
85 #define INADDR_NONE INADDR_BROADCAST
88 #define MASK_SIGNAL() \
90 void (*old_handler)(int); \
92 old_handler = signal(SIGPIPE, SIG_IGN);
94 #define UNMASK_SIGNAL() \
95 signal(SIGPIPE, old_handler); \
99 #ifndef __GSOCKET_STANDALONE__
100 # include "wx/unix/gsockunx.h"
101 # include "wx/gsocket.h"
103 # include "gsockunx.h"
104 # include "gsocket.h"
105 #endif /* __GSOCKET_STANDALONE__ */
107 /* redefine some GUI-only functions to do nothing in console mode */
108 #if defined(wxUSE_GUI) && !wxUSE_GUI
109 # define _GSocket_GUI_Init(socket) (1)
110 # define _GSocket_GUI_Destroy(socket)
111 # define _GSocket_Enable_Events(socket)
112 # define _GSocket_Disable_Events(socket)
113 # define _GSocket_Install_Callback(socket, event)
114 # define _GSocket_Uninstall_Callback(socket, event)
115 #endif /* wxUSE_GUI */
117 /* debugging helpers */
118 #ifdef __GSOCKET_DEBUG__
119 # define GSocket_Debug(args) printf args
121 # define GSocket_Debug(args)
122 #endif /* __GSOCKET_DEBUG__ */
124 /* Global initialisers */
126 int GSocket_Init(void)
131 void GSocket_Cleanup(void)
135 /* Constructors / Destructors for GSocket */
137 GSocket
*GSocket_new(void)
142 socket
= (GSocket
*)malloc(sizeof(GSocket
));
147 socket
->m_fd
= INVALID_SOCKET
;
148 for (i
=0;i
<GSOCK_MAX_EVENT
;i
++)
150 socket
->m_cbacks
[i
] = NULL
;
152 socket
->m_detected
= 0;
153 socket
->m_local
= NULL
;
154 socket
->m_peer
= NULL
;
155 socket
->m_error
= GSOCK_NOERROR
;
156 socket
->m_server
= FALSE
;
157 socket
->m_stream
= TRUE
;
158 socket
->m_gui_dependent
= NULL
;
159 socket
->m_non_blocking
= FALSE
;
160 socket
->m_timeout
= 10*60*1000;
161 /* 10 minutes * 60 sec * 1000 millisec */
162 socket
->m_establishing
= FALSE
;
164 /* Per-socket GUI-specific initialization */
165 success
= _GSocket_GUI_Init(socket
);
175 void GSocket_close(GSocket
*socket
)
177 _GSocket_Disable_Events(socket
);
179 socket
->m_fd
= INVALID_SOCKET
;
182 void GSocket_destroy(GSocket
*socket
)
184 assert(socket
!= NULL
);
186 /* Check that the socket is really shutdowned */
187 if (socket
->m_fd
!= INVALID_SOCKET
)
188 GSocket_Shutdown(socket
);
190 /* Per-socket GUI-specific cleanup */
191 _GSocket_GUI_Destroy(socket
);
193 /* Destroy private addresses */
195 GAddress_destroy(socket
->m_local
);
198 GAddress_destroy(socket
->m_peer
);
200 /* Destroy the socket itself */
205 * Disallow further read/write operations on this socket, close
206 * the fd and disable all callbacks.
208 void GSocket_Shutdown(GSocket
*socket
)
212 assert(socket
!= NULL
);
214 /* If socket has been created, shutdown it */
215 if (socket
->m_fd
!= INVALID_SOCKET
)
217 shutdown(socket
->m_fd
, 2);
218 GSocket_close(socket
);
221 /* Disable GUI callbacks */
222 for (evt
= 0; evt
< GSOCK_MAX_EVENT
; evt
++)
223 socket
->m_cbacks
[evt
] = NULL
;
225 socket
->m_detected
= GSOCK_LOST_FLAG
;
228 /* Address handling */
234 * Set or get the local or peer address for this socket. The 'set'
235 * functions return GSOCK_NOERROR on success, an error code otherwise.
236 * The 'get' functions return a pointer to a GAddress object on success,
237 * or NULL otherwise, in which case they set the error code of the
238 * corresponding GSocket.
241 * GSOCK_INVSOCK - the socket is not valid.
242 * GSOCK_INVADDR - the address is not valid.
244 GSocketError
GSocket_SetLocal(GSocket
*socket
, GAddress
*address
)
246 assert(socket
!= NULL
);
248 /* the socket must be initialized, or it must be a server */
249 if ((socket
->m_fd
!= INVALID_SOCKET
&& !socket
->m_server
))
251 socket
->m_error
= GSOCK_INVSOCK
;
252 return GSOCK_INVSOCK
;
256 if (address
== NULL
|| address
->m_family
== GSOCK_NOFAMILY
)
258 socket
->m_error
= GSOCK_INVADDR
;
259 return GSOCK_INVADDR
;
263 GAddress_destroy(socket
->m_local
);
265 socket
->m_local
= GAddress_copy(address
);
267 return GSOCK_NOERROR
;
270 GSocketError
GSocket_SetPeer(GSocket
*socket
, GAddress
*address
)
272 assert(socket
!= NULL
);
275 if (address
== NULL
|| address
->m_family
== GSOCK_NOFAMILY
)
277 socket
->m_error
= GSOCK_INVADDR
;
278 return GSOCK_INVADDR
;
282 GAddress_destroy(socket
->m_peer
);
284 socket
->m_peer
= GAddress_copy(address
);
286 return GSOCK_NOERROR
;
289 GAddress
*GSocket_GetLocal(GSocket
*socket
)
292 struct sockaddr addr
;
293 SOCKLEN_T size
= sizeof(addr
);
296 assert(socket
!= NULL
);
298 /* try to get it from the m_local var first */
300 return GAddress_copy(socket
->m_local
);
302 /* else, if the socket is initialized, try getsockname */
303 if (socket
->m_fd
== INVALID_SOCKET
)
305 socket
->m_error
= GSOCK_INVSOCK
;
309 if (getsockname(socket
->m_fd
, &addr
, (SOCKLEN_T
*) &size
) < 0)
311 socket
->m_error
= GSOCK_IOERR
;
315 /* got a valid address from getsockname, create a GAddress object */
316 address
= GAddress_new();
319 socket
->m_error
= GSOCK_MEMERR
;
323 err
= _GAddress_translate_from(address
, &addr
, size
);
324 if (err
!= GSOCK_NOERROR
)
326 GAddress_destroy(address
);
327 socket
->m_error
= err
;
334 GAddress
*GSocket_GetPeer(GSocket
*socket
)
336 assert(socket
!= NULL
);
338 /* try to get it from the m_peer var */
340 return GAddress_copy(socket
->m_peer
);
345 /* Server specific parts */
347 /* GSocket_SetServer:
348 * Sets up this socket as a server. The local address must have been
349 * set with GSocket_SetLocal() before GSocket_SetServer() is called.
350 * Returns GSOCK_NOERROR on success, one of the following otherwise:
353 * GSOCK_INVSOCK - the socket is in use.
354 * GSOCK_INVADDR - the local address has not been set.
355 * GSOCK_IOERR - low-level error.
357 GSocketError
GSocket_SetServer(GSocket
*sck
)
363 /* must not be in use */
364 if (sck
->m_fd
!= INVALID_SOCKET
)
366 sck
->m_error
= GSOCK_INVSOCK
;
367 return GSOCK_INVSOCK
;
370 /* the local addr must have been set */
373 sck
->m_error
= GSOCK_INVADDR
;
374 return GSOCK_INVADDR
;
377 /* Initialize all fields */
378 sck
->m_stream
= TRUE
;
379 sck
->m_server
= TRUE
;
380 sck
->m_oriented
= TRUE
;
382 /* Create the socket */
383 sck
->m_fd
= socket(sck
->m_local
->m_realfamily
, SOCK_STREAM
, 0);
385 if (sck
->m_fd
== INVALID_SOCKET
)
387 sck
->m_error
= GSOCK_IOERR
;
391 ioctl(sck
->m_fd
, FIONBIO
, &arg
);
392 _GSocket_Enable_Events(sck
);
394 /* Bind to the local address,
395 * retrieve the actual address bound,
396 * and listen up to 5 connections.
398 if ((bind(sck
->m_fd
, sck
->m_local
->m_addr
, sck
->m_local
->m_len
) != 0) ||
399 (getsockname(sck
->m_fd
,
400 sck
->m_local
->m_addr
,
401 (SOCKLEN_T
*) &sck
->m_local
->m_len
) != 0) ||
402 (listen(sck
->m_fd
, 5) != 0))
405 sck
->m_error
= GSOCK_IOERR
;
409 return GSOCK_NOERROR
;
412 /* GSocket_WaitConnection:
413 * Waits for an incoming client connection. Returns a pointer to
414 * a GSocket object, or NULL if there was an error, in which case
415 * the last error field will be updated for the calling GSocket.
417 * Error codes (set in the calling GSocket)
418 * GSOCK_INVSOCK - the socket is not valid or not a server.
419 * GSOCK_TIMEDOUT - timeout, no incoming connections.
420 * GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
421 * GSOCK_MEMERR - couldn't allocate memory.
422 * GSOCK_IOERR - low-level error.
424 GSocket
*GSocket_WaitConnection(GSocket
*socket
)
426 struct sockaddr from
;
427 SOCKLEN_T fromlen
= sizeof(from
);
432 assert(socket
!= NULL
);
434 /* Reenable CONNECTION events */
435 _GSocket_Enable(socket
, GSOCK_CONNECTION
);
437 /* If the socket has already been created, we exit immediately */
438 if (socket
->m_fd
== INVALID_SOCKET
|| !socket
->m_server
)
440 socket
->m_error
= GSOCK_INVSOCK
;
444 /* Create a GSocket object for the new connection */
445 connection
= GSocket_new();
449 socket
->m_error
= GSOCK_MEMERR
;
453 /* Wait for a connection (with timeout) */
454 if (_GSocket_Input_Timeout(socket
) == GSOCK_TIMEDOUT
)
456 GSocket_destroy(connection
);
457 /* socket->m_error set by _GSocket_Input_Timeout */
461 connection
->m_fd
= accept(socket
->m_fd
, &from
, (SOCKLEN_T
*) &fromlen
);
463 if (connection
->m_fd
== INVALID_SOCKET
)
465 if (errno
== EWOULDBLOCK
)
466 socket
->m_error
= GSOCK_WOULDBLOCK
;
468 socket
->m_error
= GSOCK_IOERR
;
470 GSocket_destroy(connection
);
474 /* Initialize all fields */
475 connection
->m_server
= FALSE
;
476 connection
->m_stream
= TRUE
;
477 connection
->m_oriented
= TRUE
;
479 /* Setup the peer address field */
480 connection
->m_peer
= GAddress_new();
481 if (!connection
->m_peer
)
483 GSocket_destroy(connection
);
484 socket
->m_error
= GSOCK_MEMERR
;
487 err
= _GAddress_translate_from(connection
->m_peer
, &from
, fromlen
);
488 if (err
!= GSOCK_NOERROR
)
490 GAddress_destroy(connection
->m_peer
);
491 GSocket_destroy(connection
);
492 socket
->m_error
= err
;
496 ioctl(connection
->m_fd
, FIONBIO
, &arg
);
497 _GSocket_Enable_Events(connection
);
502 /* Client specific parts */
505 * For stream (connection oriented) sockets, GSocket_Connect() tries
506 * to establish a client connection to a server using the peer address
507 * as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the
508 * connection has been succesfully established, or one of the error
509 * codes listed below. Note that for nonblocking sockets, a return
510 * value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
511 * request can be completed later; you should use GSocket_Select()
512 * to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the
513 * corresponding asynchronous events.
515 * For datagram (non connection oriented) sockets, GSocket_Connect()
516 * just sets the peer address established with GSocket_SetPeer() as
517 * default destination.
520 * GSOCK_INVSOCK - the socket is in use or not valid.
521 * GSOCK_INVADDR - the peer address has not been established.
522 * GSOCK_TIMEDOUT - timeout, the connection failed.
523 * GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
524 * GSOCK_MEMERR - couldn't allocate memory.
525 * GSOCK_IOERR - low-level error.
527 GSocketError
GSocket_Connect(GSocket
*sck
, GSocketStream stream
)
534 /* Enable CONNECTION events (needed for nonblocking connections) */
535 _GSocket_Enable(sck
, GSOCK_CONNECTION
);
537 if (sck
->m_fd
!= INVALID_SOCKET
)
539 sck
->m_error
= GSOCK_INVSOCK
;
540 return GSOCK_INVSOCK
;
545 sck
->m_error
= GSOCK_INVADDR
;
546 return GSOCK_INVADDR
;
549 /* Streamed or dgram socket? */
550 sck
->m_stream
= (stream
== GSOCK_STREAMED
);
551 sck
->m_oriented
= TRUE
;
552 sck
->m_server
= FALSE
;
553 sck
->m_establishing
= FALSE
;
555 /* Create the socket */
556 sck
->m_fd
= socket(sck
->m_peer
->m_realfamily
,
557 sck
->m_stream
? SOCK_STREAM
: SOCK_DGRAM
, 0);
559 if (sck
->m_fd
== INVALID_SOCKET
)
561 sck
->m_error
= GSOCK_IOERR
;
565 ioctl(sck
->m_fd
, FIONBIO
, &arg
);
566 _GSocket_Enable_Events(sck
);
568 /* Connect it to the peer address, with a timeout (see below) */
569 ret
= connect(sck
->m_fd
, sck
->m_peer
->m_addr
, sck
->m_peer
->m_len
);
575 /* If connect failed with EINPROGRESS and the GSocket object
576 * is in blocking mode, we select() for the specified timeout
577 * checking for writability to see if the connection request
580 if ((err
== EINPROGRESS
) && (!sck
->m_non_blocking
))
582 if (_GSocket_Output_Timeout(sck
) == GSOCK_TIMEDOUT
)
585 /* sck->m_error is set in _GSocket_Output_Timeout */
586 return GSOCK_TIMEDOUT
;
591 SOCKLEN_T len
= sizeof(error
);
593 getsockopt(sck
->m_fd
, SOL_SOCKET
, SO_ERROR
, (void*) &error
, &len
);
596 return GSOCK_NOERROR
;
600 /* If connect failed with EINPROGRESS and the GSocket object
601 * is set to nonblocking, we set m_error to GSOCK_WOULDBLOCK
602 * (and return GSOCK_WOULDBLOCK) but we don't close the socket;
603 * this way if the connection completes, a GSOCK_CONNECTION
604 * event will be generated, if enabled.
606 if ((err
== EINPROGRESS
) && (sck
->m_non_blocking
))
608 sck
->m_establishing
= TRUE
;
609 sck
->m_error
= GSOCK_WOULDBLOCK
;
610 return GSOCK_WOULDBLOCK
;
613 /* If connect failed with an error other than EINPROGRESS,
614 * then the call to GSocket_Connect has failed.
617 sck
->m_error
= GSOCK_IOERR
;
621 return GSOCK_NOERROR
;
624 /* Datagram sockets */
626 /* GSocket_SetNonOriented:
627 * Sets up this socket as a non-connection oriented (datagram) socket.
628 * Before using this function, the local address must have been set
629 * with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR
630 * on success, or one of the following otherwise.
633 * GSOCK_INVSOCK - the socket is in use.
634 * GSOCK_INVADDR - the local address has not been set.
635 * GSOCK_IOERR - low-level error.
637 GSocketError
GSocket_SetNonOriented(GSocket
*sck
)
643 if (sck
->m_fd
!= INVALID_SOCKET
)
645 sck
->m_error
= GSOCK_INVSOCK
;
646 return GSOCK_INVSOCK
;
651 sck
->m_error
= GSOCK_INVADDR
;
652 return GSOCK_INVADDR
;
655 /* Initialize all fields */
656 sck
->m_stream
= FALSE
;
657 sck
->m_server
= FALSE
;
658 sck
->m_oriented
= FALSE
;
660 /* Create the socket */
661 sck
->m_fd
= socket(sck
->m_local
->m_realfamily
, SOCK_DGRAM
, 0);
663 if (sck
->m_fd
== INVALID_SOCKET
)
665 sck
->m_error
= GSOCK_IOERR
;
669 ioctl(sck
->m_fd
, FIONBIO
, &arg
);
670 _GSocket_Enable_Events(sck
);
672 /* Bind to the local address,
673 * and retrieve the actual address bound.
675 if ((bind(sck
->m_fd
, sck
->m_local
->m_addr
, sck
->m_local
->m_len
) != 0) ||
676 (getsockname(sck
->m_fd
,
677 sck
->m_local
->m_addr
,
678 (SOCKLEN_T
*) &sck
->m_local
->m_len
) != 0))
681 sck
->m_error
= GSOCK_IOERR
;
685 return GSOCK_NOERROR
;
690 /* Like recv(), send(), ... */
691 int GSocket_Read(GSocket
*socket
, char *buffer
, int size
)
695 assert(socket
!= NULL
);
697 /* Reenable INPUT events */
698 _GSocket_Enable(socket
, GSOCK_INPUT
);
700 if (socket
->m_fd
== INVALID_SOCKET
|| socket
->m_server
)
702 socket
->m_error
= GSOCK_INVSOCK
;
706 /* If the socket is blocking, wait for data (with a timeout) */
707 if (_GSocket_Input_Timeout(socket
) == GSOCK_TIMEDOUT
)
711 if (socket
->m_stream
)
712 ret
= _GSocket_Recv_Stream(socket
, buffer
, size
);
714 ret
= _GSocket_Recv_Dgram(socket
, buffer
, size
);
718 if (errno
== EWOULDBLOCK
)
719 socket
->m_error
= GSOCK_WOULDBLOCK
;
721 socket
->m_error
= GSOCK_IOERR
;
727 int GSocket_Write(GSocket
*socket
, const char *buffer
, int size
)
731 assert(socket
!= NULL
);
733 GSocket_Debug(( "GSocket_Write #1, size %d\n", size
));
735 if (socket
->m_fd
== INVALID_SOCKET
|| socket
->m_server
)
737 socket
->m_error
= GSOCK_INVSOCK
;
741 GSocket_Debug(( "GSocket_Write #2, size %d\n", size
));
743 /* If the socket is blocking, wait for writability (with a timeout) */
744 if (_GSocket_Output_Timeout(socket
) == GSOCK_TIMEDOUT
)
747 GSocket_Debug(( "GSocket_Write #3, size %d\n", size
));
750 if (socket
->m_stream
)
751 ret
= _GSocket_Send_Stream(socket
, buffer
, size
);
753 ret
= _GSocket_Send_Dgram(socket
, buffer
, size
);
755 GSocket_Debug(( "GSocket_Write #4, size %d\n", size
));
759 if (errno
== EWOULDBLOCK
)
761 socket
->m_error
= GSOCK_WOULDBLOCK
;
762 GSocket_Debug(( "GSocket_Write error WOULDBLOCK\n" ));
766 socket
->m_error
= GSOCK_IOERR
;
767 GSocket_Debug(( "GSocket_Write error IOERR\n" ));
770 /* Only reenable OUTPUT events after an error (just like WSAAsyncSelect
771 * in MSW). Once the first OUTPUT event is received, users can assume
772 * that the socket is writable until a read operation fails. Only then
773 * will further OUTPUT events be posted.
775 _GSocket_Enable(socket
, GSOCK_OUTPUT
);
779 GSocket_Debug(( "GSocket_Write #5, size %d ret %d\n", size
, ret
));
785 * Polls the socket to determine its status. This function will
786 * check for the events specified in the 'flags' parameter, and
787 * it will return a mask indicating which operations can be
788 * performed. This function won't block, regardless of the
789 * mode (blocking | nonblocking) of the socket.
791 GSocketEventFlags
GSocket_Select(GSocket
*socket
, GSocketEventFlags flags
)
793 #if defined(wxUSE_GUI) && !wxUSE_GUI
795 GSocketEventFlags result
= 0;
801 /* Do not use a static struct, Linux can garble it */
805 assert(socket
!= NULL
);
810 FD_SET(socket
->m_fd
, &readfds
);
811 FD_SET(socket
->m_fd
, &writefds
);
812 FD_SET(socket
->m_fd
, &exceptfds
);
814 /* Check known state first */
815 result
|= (GSOCK_CONNECTION_FLAG
& socket
->m_detected
& flags
);
816 result
|= (GSOCK_LOST_FLAG
& socket
->m_detected
& flags
);
819 if (select(socket
->m_fd
+ 1, &readfds
, &writefds
, &exceptfds
, &tv
) <= 0)
822 /* Check for readability */
823 if (FD_ISSET(socket
->m_fd
, &readfds
))
827 if (recv(socket
->m_fd
, &c
, 1, MSG_PEEK
) > 0)
829 result
|= (GSOCK_INPUT_FLAG
& flags
);
833 if (socket
->m_server
&& socket
->m_stream
)
835 result
|= (GSOCK_CONNECTION_FLAG
& flags
);
836 socket
->m_detected
|= GSOCK_CONNECTION_FLAG
;
840 result
|= (GSOCK_LOST_FLAG
& flags
);
841 socket
->m_detected
= GSOCK_LOST_FLAG
;
846 /* Check for writability */
847 if (FD_ISSET(socket
->m_fd
, &writefds
))
849 if (socket
->m_establishing
&& !socket
->m_server
)
852 SOCKLEN_T len
= sizeof(error
);
854 socket
->m_establishing
= FALSE
;
856 getsockopt(socket
->m_fd
, SOL_SOCKET
, SO_ERROR
, (void*)&error
, &len
);
860 result
|= (GSOCK_LOST_FLAG
& flags
);
861 socket
->m_detected
= GSOCK_LOST_FLAG
;
865 result
|= (GSOCK_CONNECTION_FLAG
& flags
);
866 socket
->m_detected
|= GSOCK_CONNECTION_FLAG
;
871 result
|= (GSOCK_OUTPUT_FLAG
& flags
);
875 /* Check for exceptions and errors (is this useful in Unices?) */
876 if (FD_ISSET(socket
->m_fd
, &exceptfds
))
878 result
|= (GSOCK_LOST_FLAG
& flags
);
879 socket
->m_establishing
= FALSE
;
880 socket
->m_detected
= GSOCK_LOST_FLAG
;
887 assert(socket
!= NULL
);
888 return flags
& socket
->m_detected
;
890 #endif /* !wxUSE_GUI */
895 /* GSocket_SetNonBlocking:
896 * Sets the socket to non-blocking mode. All IO calls will return
899 void GSocket_SetNonBlocking(GSocket
*socket
, int non_block
)
901 assert(socket
!= NULL
);
903 GSocket_Debug( ("GSocket_SetNonBlocking: %d\n", (int)non_block
) );
905 socket
->m_non_blocking
= non_block
;
908 /* GSocket_SetTimeout:
909 * Sets the timeout for blocking calls. Time is expressed in
912 void GSocket_SetTimeout(GSocket
*socket
, unsigned long millisec
)
914 assert(socket
!= NULL
);
916 socket
->m_timeout
= millisec
;
920 * Returns the last error occured for this socket. Note that successful
921 * operations do not clear this back to GSOCK_NOERROR, so use it only
924 GSocketError
GSocket_GetError(GSocket
*socket
)
926 assert(socket
!= NULL
);
928 return socket
->m_error
;
934 * There is data to be read in the input buffer. If, after a read
935 * operation, there is still data available, the callback function will
938 * The socket is available for writing. That is, the next write call
939 * won't block. This event is generated only once, when the connection is
940 * first established, and then only if a call failed with GSOCK_WOULDBLOCK,
941 * when the output buffer empties again. This means that the app should
942 * assume that it can write since the first OUTPUT event, and no more
943 * OUTPUT events will be generated unless an error occurs.
945 * Connection succesfully established, for client sockets, or incoming
946 * client connection, for server sockets. Wait for this event (also watch
947 * out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
949 * The connection is lost (or a connection request failed); this could
950 * be due to a failure, or due to the peer closing it gracefully.
953 /* GSocket_SetCallback:
954 * Enables the callbacks specified by 'flags'. Note that 'flags'
955 * may be a combination of flags OR'ed toghether, so the same
956 * callback function can be made to accept different events.
957 * The callback function must have the following prototype:
959 * void function(GSocket *socket, GSocketEvent event, char *cdata)
961 void GSocket_SetCallback(GSocket
*socket
, GSocketEventFlags flags
,
962 GSocketCallback callback
, char *cdata
)
966 assert(socket
!= NULL
);
968 for (count
= 0; count
< GSOCK_MAX_EVENT
; count
++)
970 if ((flags
& (1 << count
)) != 0)
972 socket
->m_cbacks
[count
] = callback
;
973 socket
->m_data
[count
] = cdata
;
978 /* GSocket_UnsetCallback:
979 * Disables all callbacks specified by 'flags', which may be a
980 * combination of flags OR'ed toghether.
982 void GSocket_UnsetCallback(GSocket
*socket
, GSocketEventFlags flags
)
986 assert(socket
!= NULL
);
988 for (count
= 0; count
< GSOCK_MAX_EVENT
; count
++)
990 if ((flags
& (1 << count
)) != 0)
992 socket
->m_cbacks
[count
] = NULL
;
993 socket
->m_data
[count
] = NULL
;
999 #define CALL_CALLBACK(socket, event) { \
1000 _GSocket_Disable(socket, event); \
1001 if (socket->m_cbacks[event]) \
1002 socket->m_cbacks[event](socket, event, socket->m_data[event]); \
1006 void _GSocket_Enable(GSocket
*socket
, GSocketEvent event
)
1008 socket
->m_detected
&= ~(1 << event
);
1009 _GSocket_Install_Callback(socket
, event
);
1012 void _GSocket_Disable(GSocket
*socket
, GSocketEvent event
)
1014 socket
->m_detected
|= (1 << event
);
1015 _GSocket_Uninstall_Callback(socket
, event
);
1018 /* _GSocket_Input_Timeout:
1019 * For blocking sockets, wait until data is available or
1020 * until timeout ellapses.
1022 GSocketError
_GSocket_Input_Timeout(GSocket
*socket
)
1028 /* Linux select() will overwrite the struct on return */
1029 tv
.tv_sec
= (socket
->m_timeout
/ 1000);
1030 tv
.tv_usec
= (socket
->m_timeout
% 1000) * 1000;
1032 if (!socket
->m_non_blocking
)
1035 FD_SET(socket
->m_fd
, &readfds
);
1036 ret
= select(socket
->m_fd
+ 1, &readfds
, NULL
, NULL
, &tv
);
1039 GSocket_Debug(( "GSocket_Input_Timeout, select returned 0\n" ));
1040 socket
->m_error
= GSOCK_TIMEDOUT
;
1041 return GSOCK_TIMEDOUT
;
1045 GSocket_Debug(( "GSocket_Input_Timeout, select returned -1\n" ));
1046 if (errno
== EBADF
) { GSocket_Debug(( "Invalid file descriptor\n" )); }
1047 if (errno
== EINTR
) { GSocket_Debug(( "A non blocked signal was caught\n" )); }
1048 if (errno
== EINVAL
) { GSocket_Debug(( "The highest number descriptor is negative\n" )); }
1049 if (errno
== ENOMEM
) { GSocket_Debug(( "Not enough memory\n" )); }
1050 socket
->m_error
= GSOCK_TIMEDOUT
;
1051 return GSOCK_TIMEDOUT
;
1054 return GSOCK_NOERROR
;
1057 /* _GSocket_Output_Timeout:
1058 * For blocking sockets, wait until data can be sent without
1059 * blocking or until timeout ellapses.
1061 GSocketError
_GSocket_Output_Timeout(GSocket
*socket
)
1067 /* Linux select() will overwrite the struct on return */
1068 tv
.tv_sec
= (socket
->m_timeout
/ 1000);
1069 tv
.tv_usec
= (socket
->m_timeout
% 1000) * 1000;
1071 GSocket_Debug( ("m_non_blocking has: %d\n", (int)socket
->m_non_blocking
) );
1073 if (!socket
->m_non_blocking
)
1076 FD_SET(socket
->m_fd
, &writefds
);
1077 ret
= select(socket
->m_fd
+ 1, NULL
, &writefds
, NULL
, &tv
);
1080 GSocket_Debug(( "GSocket_Output_Timeout, select returned 0\n" ));
1081 socket
->m_error
= GSOCK_TIMEDOUT
;
1082 return GSOCK_TIMEDOUT
;
1086 GSocket_Debug(( "GSocket_Output_Timeout, select returned -1\n" ));
1087 if (errno
== EBADF
) { GSocket_Debug(( "Invalid file descriptor\n" )); }
1088 if (errno
== EINTR
) { GSocket_Debug(( "A non blocked signal was caught\n" )); }
1089 if (errno
== EINVAL
) { GSocket_Debug(( "The highest number descriptor is negative\n" )); }
1090 if (errno
== ENOMEM
) { GSocket_Debug(( "Not enough memory\n" )); }
1091 socket
->m_error
= GSOCK_TIMEDOUT
;
1092 return GSOCK_TIMEDOUT
;
1094 if ( ! FD_ISSET(socket
->m_fd
, &writefds
) ) {
1095 GSocket_Debug(( "GSocket_Output_Timeout is buggy!\n" ));
1098 GSocket_Debug(( "GSocket_Output_Timeout seems correct\n" ));
1103 GSocket_Debug(( "GSocket_Output_Timeout, didn't try select!\n" ));
1106 return GSOCK_NOERROR
;
1109 int _GSocket_Recv_Stream(GSocket
*socket
, char *buffer
, int size
)
1111 return recv(socket
->m_fd
, buffer
, size
, 0);
1114 int _GSocket_Recv_Dgram(GSocket
*socket
, char *buffer
, int size
)
1116 struct sockaddr from
;
1117 SOCKLEN_T fromlen
= sizeof(from
);
1121 fromlen
= sizeof(from
);
1123 ret
= recvfrom(socket
->m_fd
, buffer
, size
, 0, &from
, (SOCKLEN_T
*) &fromlen
);
1128 /* Translate a system address into a GSocket address */
1129 if (!socket
->m_peer
)
1131 socket
->m_peer
= GAddress_new();
1132 if (!socket
->m_peer
)
1134 socket
->m_error
= GSOCK_MEMERR
;
1138 err
= _GAddress_translate_from(socket
->m_peer
, &from
, fromlen
);
1139 if (err
!= GSOCK_NOERROR
)
1141 GAddress_destroy(socket
->m_peer
);
1142 socket
->m_peer
= NULL
;
1143 socket
->m_error
= err
;
1150 int _GSocket_Send_Stream(GSocket
*socket
, const char *buffer
, int size
)
1155 ret
= send(socket
->m_fd
, buffer
, size
, 0);
1161 int _GSocket_Send_Dgram(GSocket
*socket
, const char *buffer
, int size
)
1163 struct sockaddr
*addr
;
1167 if (!socket
->m_peer
)
1169 socket
->m_error
= GSOCK_INVADDR
;
1173 err
= _GAddress_translate_to(socket
->m_peer
, &addr
, &len
);
1174 if (err
!= GSOCK_NOERROR
)
1176 socket
->m_error
= err
;
1181 ret
= sendto(socket
->m_fd
, buffer
, size
, 0, addr
, len
);
1184 /* Frees memory allocated from _GAddress_translate_to */
1190 void _GSocket_Detected_Read(GSocket
*socket
)
1194 if (recv(socket
->m_fd
, &c
, 1, MSG_PEEK
) > 0)
1196 CALL_CALLBACK(socket
, GSOCK_INPUT
);
1200 if (socket
->m_server
&& socket
->m_stream
)
1202 CALL_CALLBACK(socket
, GSOCK_CONNECTION
);
1206 CALL_CALLBACK(socket
, GSOCK_LOST
);
1211 void _GSocket_Detected_Write(GSocket
*socket
)
1213 if (socket
->m_establishing
&& !socket
->m_server
)
1216 SOCKLEN_T len
= sizeof(error
);
1218 socket
->m_establishing
= FALSE
;
1220 getsockopt(socket
->m_fd
, SOL_SOCKET
, SO_ERROR
, (void*)&error
, &len
);
1224 CALL_CALLBACK(socket
, GSOCK_LOST
);
1228 CALL_CALLBACK(socket
, GSOCK_CONNECTION
);
1229 /* We have to fire this event by hand because CONNECTION (for clients)
1230 * and OUTPUT are internally the same and we just disabled CONNECTION
1231 * events with the above macro.
1233 CALL_CALLBACK(socket
, GSOCK_OUTPUT
);
1238 CALL_CALLBACK(socket
, GSOCK_OUTPUT
);
1243 * -------------------------------------------------------------------------
1245 * -------------------------------------------------------------------------
1248 /* CHECK_ADDRESS verifies that the current address family is either
1249 * GSOCK_NOFAMILY or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it
1250 * initalizes it to be a GSOCK_*family*. In other cases, it returns
1251 * an appropiate error code.
1253 * CHECK_ADDRESS_RETVAL does the same but returning 'retval' on error.
1255 #define CHECK_ADDRESS(address, family) \
1257 if (address->m_family == GSOCK_NOFAMILY) \
1258 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1259 return address->m_error; \
1260 if (address->m_family != GSOCK_##family) \
1262 address->m_error = GSOCK_INVADDR; \
1263 return GSOCK_INVADDR; \
1267 #define CHECK_ADDRESS_RETVAL(address, family, retval) \
1269 if (address->m_family == GSOCK_NOFAMILY) \
1270 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1272 if (address->m_family != GSOCK_##family) \
1274 address->m_error = GSOCK_INVADDR; \
1280 GAddress
*GAddress_new(void)
1284 if ((address
= (GAddress
*) malloc(sizeof(GAddress
))) == NULL
)
1287 address
->m_family
= GSOCK_NOFAMILY
;
1288 address
->m_addr
= NULL
;
1294 GAddress
*GAddress_copy(GAddress
*address
)
1298 assert(address
!= NULL
);
1300 if ((addr2
= (GAddress
*) malloc(sizeof(GAddress
))) == NULL
)
1303 memcpy(addr2
, address
, sizeof(GAddress
));
1305 if (address
->m_addr
&& address
->m_len
> 0)
1307 addr2
->m_addr
= (struct sockaddr
*)malloc(addr2
->m_len
);
1308 if (addr2
->m_addr
== NULL
)
1313 memcpy(addr2
->m_addr
, address
->m_addr
, addr2
->m_len
);
1319 void GAddress_destroy(GAddress
*address
)
1321 assert(address
!= NULL
);
1323 if (address
->m_addr
)
1324 free(address
->m_addr
);
1329 void GAddress_SetFamily(GAddress
*address
, GAddressType type
)
1331 assert(address
!= NULL
);
1333 address
->m_family
= type
;
1336 GAddressType
GAddress_GetFamily(GAddress
*address
)
1338 assert(address
!= NULL
);
1340 return address
->m_family
;
1343 GSocketError
_GAddress_translate_from(GAddress
*address
,
1344 struct sockaddr
*addr
, int len
)
1346 address
->m_realfamily
= addr
->sa_family
;
1347 switch (addr
->sa_family
)
1350 address
->m_family
= GSOCK_INET
;
1353 address
->m_family
= GSOCK_UNIX
;
1357 address
->m_family
= GSOCK_INET6
;
1362 address
->m_error
= GSOCK_INVOP
;
1367 if (address
->m_addr
)
1368 free(address
->m_addr
);
1370 address
->m_len
= len
;
1371 address
->m_addr
= (struct sockaddr
*)malloc(len
);
1373 if (address
->m_addr
== NULL
)
1375 address
->m_error
= GSOCK_MEMERR
;
1376 return GSOCK_MEMERR
;
1378 memcpy(address
->m_addr
, addr
, len
);
1380 return GSOCK_NOERROR
;
1383 GSocketError
_GAddress_translate_to(GAddress
*address
,
1384 struct sockaddr
**addr
, int *len
)
1386 if (!address
->m_addr
)
1388 address
->m_error
= GSOCK_INVADDR
;
1389 return GSOCK_INVADDR
;
1392 *len
= address
->m_len
;
1393 *addr
= (struct sockaddr
*)malloc(address
->m_len
);
1396 address
->m_error
= GSOCK_MEMERR
;
1397 return GSOCK_MEMERR
;
1400 memcpy(*addr
, address
->m_addr
, address
->m_len
);
1401 return GSOCK_NOERROR
;
1405 * -------------------------------------------------------------------------
1406 * Internet address family
1407 * -------------------------------------------------------------------------
1410 GSocketError
_GAddress_Init_INET(GAddress
*address
)
1412 address
->m_len
= sizeof(struct sockaddr_in
);
1413 address
->m_addr
= (struct sockaddr
*) malloc(address
->m_len
);
1414 if (address
->m_addr
== NULL
)
1416 address
->m_error
= GSOCK_MEMERR
;
1417 return GSOCK_MEMERR
;
1420 address
->m_family
= GSOCK_INET
;
1421 address
->m_realfamily
= PF_INET
;
1422 ((struct sockaddr_in
*)address
->m_addr
)->sin_family
= AF_INET
;
1423 ((struct sockaddr_in
*)address
->m_addr
)->sin_addr
.s_addr
= INADDR_ANY
;
1425 return GSOCK_NOERROR
;
1428 GSocketError
GAddress_INET_SetHostName(GAddress
*address
, const char *hostname
)
1431 struct in_addr
*addr
;
1433 assert(address
!= NULL
);
1435 CHECK_ADDRESS(address
, INET
);
1437 addr
= &(((struct sockaddr_in
*)address
->m_addr
)->sin_addr
);
1439 /* If it is a numeric host name, convert it now */
1440 #if defined(HAVE_INET_ATON)
1441 if (inet_aton(hostname
, addr
) == 0)
1443 #elif defined(HAVE_INET_ADDR)
1444 if ( (addr
->s_addr
= inet_addr(hostname
)) == -1 )
1447 /* Use gethostbyname by default */
1451 struct in_addr
*array_addr
;
1453 /* It is a real name, we solve it */
1454 if ((he
= gethostbyname(hostname
)) == NULL
)
1456 /* Reset to invalid address */
1457 addr
->s_addr
= INADDR_NONE
;
1458 address
->m_error
= GSOCK_NOHOST
;
1459 return GSOCK_NOHOST
;
1461 array_addr
= (struct in_addr
*) *(he
->h_addr_list
);
1462 addr
->s_addr
= array_addr
[0].s_addr
;
1464 return GSOCK_NOERROR
;
1467 GSocketError
GAddress_INET_SetAnyAddress(GAddress
*address
)
1469 return GAddress_INET_SetHostAddress(address
, INADDR_ANY
);
1472 GSocketError
GAddress_INET_SetHostAddress(GAddress
*address
,
1473 unsigned long hostaddr
)
1475 struct in_addr
*addr
;
1477 assert(address
!= NULL
);
1479 CHECK_ADDRESS(address
, INET
);
1481 addr
= &(((struct sockaddr_in
*)address
->m_addr
)->sin_addr
);
1482 addr
->s_addr
= hostaddr
;
1484 return GSOCK_NOERROR
;
1487 GSocketError
GAddress_INET_SetPortName(GAddress
*address
, const char *port
,
1488 const char *protocol
)
1491 struct sockaddr_in
*addr
;
1493 assert(address
!= NULL
);
1494 CHECK_ADDRESS(address
, INET
);
1498 address
->m_error
= GSOCK_INVPORT
;
1499 return GSOCK_INVPORT
;
1502 se
= getservbyname(port
, protocol
);
1505 /* the cast to int suppresses compiler warnings about subscript having the
1507 if (isdigit((int)port
[0]))
1511 port_int
= atoi(port
);
1512 addr
= (struct sockaddr_in
*)address
->m_addr
;
1513 addr
->sin_port
= htons(port_int
);
1514 return GSOCK_NOERROR
;
1517 address
->m_error
= GSOCK_INVPORT
;
1518 return GSOCK_INVPORT
;
1521 addr
= (struct sockaddr_in
*)address
->m_addr
;
1522 addr
->sin_port
= se
->s_port
;
1524 return GSOCK_NOERROR
;
1527 GSocketError
GAddress_INET_SetPort(GAddress
*address
, unsigned short port
)
1529 struct sockaddr_in
*addr
;
1531 assert(address
!= NULL
);
1532 CHECK_ADDRESS(address
, INET
);
1534 addr
= (struct sockaddr_in
*)address
->m_addr
;
1535 addr
->sin_port
= htons(port
);
1537 return GSOCK_NOERROR
;
1540 GSocketError
GAddress_INET_GetHostName(GAddress
*address
, char *hostname
, size_t sbuf
)
1544 struct sockaddr_in
*addr
;
1546 assert(address
!= NULL
);
1547 CHECK_ADDRESS(address
, INET
);
1549 addr
= (struct sockaddr_in
*)address
->m_addr
;
1550 addr_buf
= (char *)&(addr
->sin_addr
);
1552 he
= gethostbyaddr(addr_buf
, sizeof(addr
->sin_addr
), AF_INET
);
1555 address
->m_error
= GSOCK_NOHOST
;
1556 return GSOCK_NOHOST
;
1559 strncpy(hostname
, he
->h_name
, sbuf
);
1561 return GSOCK_NOERROR
;
1564 unsigned long GAddress_INET_GetHostAddress(GAddress
*address
)
1566 struct sockaddr_in
*addr
;
1568 assert(address
!= NULL
);
1569 CHECK_ADDRESS_RETVAL(address
, INET
, 0);
1571 addr
= (struct sockaddr_in
*)address
->m_addr
;
1573 return addr
->sin_addr
.s_addr
;
1576 unsigned short GAddress_INET_GetPort(GAddress
*address
)
1578 struct sockaddr_in
*addr
;
1580 assert(address
!= NULL
);
1581 CHECK_ADDRESS_RETVAL(address
, INET
, 0);
1583 addr
= (struct sockaddr_in
*)address
->m_addr
;
1584 return ntohs(addr
->sin_port
);
1588 * -------------------------------------------------------------------------
1589 * Unix address family
1590 * -------------------------------------------------------------------------
1593 GSocketError
_GAddress_Init_UNIX(GAddress
*address
)
1595 address
->m_len
= sizeof(struct sockaddr_un
);
1596 address
->m_addr
= (struct sockaddr
*)malloc(address
->m_len
);
1597 if (address
->m_addr
== NULL
)
1599 address
->m_error
= GSOCK_MEMERR
;
1600 return GSOCK_MEMERR
;
1603 address
->m_family
= GSOCK_UNIX
;
1604 address
->m_realfamily
= PF_UNIX
;
1605 ((struct sockaddr_un
*)address
->m_addr
)->sun_family
= AF_UNIX
;
1606 ((struct sockaddr_un
*)address
->m_addr
)->sun_path
[0] = 0;
1608 return GSOCK_NOERROR
;
1611 #define UNIX_SOCK_PATHLEN (sizeof(addr->sun_path)/sizeof(addr->sun_path[0]))
1613 GSocketError
GAddress_UNIX_SetPath(GAddress
*address
, const char *path
)
1615 struct sockaddr_un
*addr
;
1617 assert(address
!= NULL
);
1619 CHECK_ADDRESS(address
, UNIX
);
1621 addr
= ((struct sockaddr_un
*)address
->m_addr
);
1622 strncpy(addr
->sun_path
, path
, UNIX_SOCK_PATHLEN
);
1623 addr
->sun_path
[UNIX_SOCK_PATHLEN
- 1] = '\0';
1625 return GSOCK_NOERROR
;
1628 GSocketError
GAddress_UNIX_GetPath(GAddress
*address
, char *path
, size_t sbuf
)
1630 struct sockaddr_un
*addr
;
1632 assert(address
!= NULL
);
1633 CHECK_ADDRESS(address
, UNIX
);
1635 addr
= (struct sockaddr_un
*)address
->m_addr
;
1637 strncpy(path
, addr
->sun_path
, sbuf
);
1639 return GSOCK_NOERROR
;
1642 #endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
1644 /* vi:sts=4:sw=4:et */