]>
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_destroy(GSocket
*socket
)
177 assert(socket
!= NULL
);
179 /* Check that the socket is really shutdowned */
180 if (socket
->m_fd
!= INVALID_SOCKET
)
181 GSocket_Shutdown(socket
);
183 /* Per-socket GUI-specific cleanup */
184 _GSocket_GUI_Destroy(socket
);
186 /* Destroy private addresses */
188 GAddress_destroy(socket
->m_local
);
191 GAddress_destroy(socket
->m_peer
);
193 /* Destroy the socket itself */
198 * Disallow further read/write operations on this socket, close
199 * the fd and disable all callbacks.
201 void GSocket_Shutdown(GSocket
*socket
)
205 assert(socket
!= NULL
);
207 /* If socket has been created, shutdown it */
208 if (socket
->m_fd
!= INVALID_SOCKET
)
210 shutdown(socket
->m_fd
, 2);
212 socket
->m_fd
= INVALID_SOCKET
;
215 /* Disable GUI callbacks */
216 for (evt
= 0; evt
< GSOCK_MAX_EVENT
; evt
++)
217 socket
->m_cbacks
[evt
] = NULL
;
219 socket
->m_detected
= GSOCK_LOST_FLAG
;
220 _GSocket_Disable_Events(socket
);
223 /* Address handling */
229 * Set or get the local or peer address for this socket. The 'set'
230 * functions return GSOCK_NOERROR on success, an error code otherwise.
231 * The 'get' functions return a pointer to a GAddress object on success,
232 * or NULL otherwise, in which case they set the error code of the
233 * corresponding GSocket.
236 * GSOCK_INVSOCK - the socket is not valid.
237 * GSOCK_INVADDR - the address is not valid.
239 GSocketError
GSocket_SetLocal(GSocket
*socket
, GAddress
*address
)
241 assert(socket
!= NULL
);
243 /* the socket must be initialized, or it must be a server */
244 if ((socket
->m_fd
!= INVALID_SOCKET
&& !socket
->m_server
))
246 socket
->m_error
= GSOCK_INVSOCK
;
247 return GSOCK_INVSOCK
;
251 if (address
== NULL
|| address
->m_family
== GSOCK_NOFAMILY
)
253 socket
->m_error
= GSOCK_INVADDR
;
254 return GSOCK_INVADDR
;
258 GAddress_destroy(socket
->m_local
);
260 socket
->m_local
= GAddress_copy(address
);
262 return GSOCK_NOERROR
;
265 GSocketError
GSocket_SetPeer(GSocket
*socket
, GAddress
*address
)
267 assert(socket
!= NULL
);
270 if (address
== NULL
|| address
->m_family
== GSOCK_NOFAMILY
)
272 socket
->m_error
= GSOCK_INVADDR
;
273 return GSOCK_INVADDR
;
277 GAddress_destroy(socket
->m_peer
);
279 socket
->m_peer
= GAddress_copy(address
);
281 return GSOCK_NOERROR
;
284 GAddress
*GSocket_GetLocal(GSocket
*socket
)
287 struct sockaddr addr
;
288 SOCKLEN_T size
= sizeof(addr
);
291 assert(socket
!= NULL
);
293 /* try to get it from the m_local var first */
295 return GAddress_copy(socket
->m_local
);
297 /* else, if the socket is initialized, try getsockname */
298 if (socket
->m_fd
== INVALID_SOCKET
)
300 socket
->m_error
= GSOCK_INVSOCK
;
304 if (getsockname(socket
->m_fd
, &addr
, (SOCKLEN_T
*) &size
) < 0)
306 socket
->m_error
= GSOCK_IOERR
;
310 /* got a valid address from getsockname, create a GAddress object */
311 address
= GAddress_new();
314 socket
->m_error
= GSOCK_MEMERR
;
318 err
= _GAddress_translate_from(address
, &addr
, size
);
319 if (err
!= GSOCK_NOERROR
)
321 GAddress_destroy(address
);
322 socket
->m_error
= err
;
329 GAddress
*GSocket_GetPeer(GSocket
*socket
)
331 assert(socket
!= NULL
);
333 /* try to get it from the m_peer var */
335 return GAddress_copy(socket
->m_peer
);
340 /* Server specific parts */
342 /* GSocket_SetServer:
343 * Sets up this socket as a server. The local address must have been
344 * set with GSocket_SetLocal() before GSocket_SetServer() is called.
345 * Returns GSOCK_NOERROR on success, one of the following otherwise:
348 * GSOCK_INVSOCK - the socket is in use.
349 * GSOCK_INVADDR - the local address has not been set.
350 * GSOCK_IOERR - low-level error.
352 GSocketError
GSocket_SetServer(GSocket
*sck
)
358 /* must not be in use */
359 if (sck
->m_fd
!= INVALID_SOCKET
)
361 sck
->m_error
= GSOCK_INVSOCK
;
362 return GSOCK_INVSOCK
;
365 /* the local addr must have been set */
368 sck
->m_error
= GSOCK_INVADDR
;
369 return GSOCK_INVADDR
;
372 /* Initialize all fields */
373 sck
->m_stream
= TRUE
;
374 sck
->m_server
= TRUE
;
375 sck
->m_oriented
= TRUE
;
377 /* Create the socket */
378 sck
->m_fd
= socket(sck
->m_local
->m_realfamily
, SOCK_STREAM
, 0);
380 if (sck
->m_fd
== INVALID_SOCKET
)
382 sck
->m_error
= GSOCK_IOERR
;
386 ioctl(sck
->m_fd
, FIONBIO
, &arg
);
387 _GSocket_Enable_Events(sck
);
389 /* Bind to the local address,
390 * retrieve the actual address bound,
391 * and listen up to 5 connections.
393 if ((bind(sck
->m_fd
, sck
->m_local
->m_addr
, sck
->m_local
->m_len
) != 0) ||
394 (getsockname(sck
->m_fd
,
395 sck
->m_local
->m_addr
,
396 (SOCKLEN_T
*) &sck
->m_local
->m_len
) != 0) ||
397 (listen(sck
->m_fd
, 5) != 0))
400 sck
->m_fd
= INVALID_SOCKET
;
401 sck
->m_error
= GSOCK_IOERR
;
405 return GSOCK_NOERROR
;
408 /* GSocket_WaitConnection:
409 * Waits for an incoming client connection. Returns a pointer to
410 * a GSocket object, or NULL if there was an error, in which case
411 * the last error field will be updated for the calling GSocket.
413 * Error codes (set in the calling GSocket)
414 * GSOCK_INVSOCK - the socket is not valid or not a server.
415 * GSOCK_TIMEDOUT - timeout, no incoming connections.
416 * GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
417 * GSOCK_MEMERR - couldn't allocate memory.
418 * GSOCK_IOERR - low-level error.
420 GSocket
*GSocket_WaitConnection(GSocket
*socket
)
422 struct sockaddr from
;
423 SOCKLEN_T fromlen
= sizeof(from
);
428 assert(socket
!= NULL
);
430 /* Reenable CONNECTION events */
431 _GSocket_Enable(socket
, GSOCK_CONNECTION
);
433 /* If the socket has already been created, we exit immediately */
434 if (socket
->m_fd
== INVALID_SOCKET
|| !socket
->m_server
)
436 socket
->m_error
= GSOCK_INVSOCK
;
440 /* Create a GSocket object for the new connection */
441 connection
= GSocket_new();
445 socket
->m_error
= GSOCK_MEMERR
;
449 /* Wait for a connection (with timeout) */
450 if (_GSocket_Input_Timeout(socket
) == GSOCK_TIMEDOUT
)
452 GSocket_destroy(connection
);
453 /* socket->m_error set by _GSocket_Input_Timeout */
457 connection
->m_fd
= accept(socket
->m_fd
, &from
, (SOCKLEN_T
*) &fromlen
);
459 if (connection
->m_fd
== INVALID_SOCKET
)
461 if (errno
== EWOULDBLOCK
)
462 socket
->m_error
= GSOCK_WOULDBLOCK
;
464 socket
->m_error
= GSOCK_IOERR
;
466 GSocket_destroy(connection
);
470 /* Initialize all fields */
471 connection
->m_server
= FALSE
;
472 connection
->m_stream
= TRUE
;
473 connection
->m_oriented
= TRUE
;
475 /* Setup the peer address field */
476 connection
->m_peer
= GAddress_new();
477 if (!connection
->m_peer
)
479 GSocket_destroy(connection
);
480 socket
->m_error
= GSOCK_MEMERR
;
483 err
= _GAddress_translate_from(connection
->m_peer
, &from
, fromlen
);
484 if (err
!= GSOCK_NOERROR
)
486 GAddress_destroy(connection
->m_peer
);
487 GSocket_destroy(connection
);
488 socket
->m_error
= err
;
492 ioctl(connection
->m_fd
, FIONBIO
, &arg
);
493 _GSocket_Enable_Events(connection
);
498 /* Client specific parts */
501 * For stream (connection oriented) sockets, GSocket_Connect() tries
502 * to establish a client connection to a server using the peer address
503 * as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the
504 * connection has been succesfully established, or one of the error
505 * codes listed below. Note that for nonblocking sockets, a return
506 * value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
507 * request can be completed later; you should use GSocket_Select()
508 * to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the
509 * corresponding asynchronous events.
511 * For datagram (non connection oriented) sockets, GSocket_Connect()
512 * just sets the peer address established with GSocket_SetPeer() as
513 * default destination.
516 * GSOCK_INVSOCK - the socket is in use or not valid.
517 * GSOCK_INVADDR - the peer address has not been established.
518 * GSOCK_TIMEDOUT - timeout, the connection failed.
519 * GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
520 * GSOCK_MEMERR - couldn't allocate memory.
521 * GSOCK_IOERR - low-level error.
523 GSocketError
GSocket_Connect(GSocket
*sck
, GSocketStream stream
)
530 /* Enable CONNECTION events (needed for nonblocking connections) */
531 _GSocket_Enable(sck
, GSOCK_CONNECTION
);
533 if (sck
->m_fd
!= INVALID_SOCKET
)
535 sck
->m_error
= GSOCK_INVSOCK
;
536 return GSOCK_INVSOCK
;
541 sck
->m_error
= GSOCK_INVADDR
;
542 return GSOCK_INVADDR
;
545 /* Streamed or dgram socket? */
546 sck
->m_stream
= (stream
== GSOCK_STREAMED
);
547 sck
->m_oriented
= TRUE
;
548 sck
->m_server
= FALSE
;
549 sck
->m_establishing
= FALSE
;
551 /* Create the socket */
552 sck
->m_fd
= socket(sck
->m_peer
->m_realfamily
,
553 sck
->m_stream
? SOCK_STREAM
: SOCK_DGRAM
, 0);
555 if (sck
->m_fd
== INVALID_SOCKET
)
557 sck
->m_error
= GSOCK_IOERR
;
561 ioctl(sck
->m_fd
, FIONBIO
, &arg
);
562 _GSocket_Enable_Events(sck
);
564 /* Connect it to the peer address, with a timeout (see below) */
565 ret
= connect(sck
->m_fd
, sck
->m_peer
->m_addr
, sck
->m_peer
->m_len
);
571 /* If connect failed with EINPROGRESS and the GSocket object
572 * is in blocking mode, we select() for the specified timeout
573 * checking for writability to see if the connection request
576 if ((err
== EINPROGRESS
) && (!sck
->m_non_blocking
))
578 if (_GSocket_Output_Timeout(sck
) == GSOCK_TIMEDOUT
)
581 sck
->m_fd
= INVALID_SOCKET
;
582 /* sck->m_error is set in _GSocket_Output_Timeout */
583 return GSOCK_TIMEDOUT
;
588 SOCKLEN_T len
= sizeof(error
);
590 getsockopt(sck
->m_fd
, SOL_SOCKET
, SO_ERROR
, (void*) &error
, &len
);
593 return GSOCK_NOERROR
;
597 /* If connect failed with EINPROGRESS and the GSocket object
598 * is set to nonblocking, we set m_error to GSOCK_WOULDBLOCK
599 * (and return GSOCK_WOULDBLOCK) but we don't close the socket;
600 * this way if the connection completes, a GSOCK_CONNECTION
601 * event will be generated, if enabled.
603 if ((err
== EINPROGRESS
) && (sck
->m_non_blocking
))
605 sck
->m_establishing
= TRUE
;
606 sck
->m_error
= GSOCK_WOULDBLOCK
;
607 return GSOCK_WOULDBLOCK
;
610 /* If connect failed with an error other than EINPROGRESS,
611 * then the call to GSocket_Connect has failed.
614 sck
->m_fd
= INVALID_SOCKET
;
615 sck
->m_error
= GSOCK_IOERR
;
619 return GSOCK_NOERROR
;
622 /* Datagram sockets */
624 /* GSocket_SetNonOriented:
625 * Sets up this socket as a non-connection oriented (datagram) socket.
626 * Before using this function, the local address must have been set
627 * with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR
628 * on success, or one of the following otherwise.
631 * GSOCK_INVSOCK - the socket is in use.
632 * GSOCK_INVADDR - the local address has not been set.
633 * GSOCK_IOERR - low-level error.
635 GSocketError
GSocket_SetNonOriented(GSocket
*sck
)
641 if (sck
->m_fd
!= INVALID_SOCKET
)
643 sck
->m_error
= GSOCK_INVSOCK
;
644 return GSOCK_INVSOCK
;
649 sck
->m_error
= GSOCK_INVADDR
;
650 return GSOCK_INVADDR
;
653 /* Initialize all fields */
654 sck
->m_stream
= FALSE
;
655 sck
->m_server
= FALSE
;
656 sck
->m_oriented
= FALSE
;
658 /* Create the socket */
659 sck
->m_fd
= socket(sck
->m_local
->m_realfamily
, SOCK_DGRAM
, 0);
661 if (sck
->m_fd
== INVALID_SOCKET
)
663 sck
->m_error
= GSOCK_IOERR
;
667 ioctl(sck
->m_fd
, FIONBIO
, &arg
);
668 _GSocket_Enable_Events(sck
);
670 /* Bind to the local address,
671 * and retrieve the actual address bound.
673 if ((bind(sck
->m_fd
, sck
->m_local
->m_addr
, sck
->m_local
->m_len
) != 0) ||
674 (getsockname(sck
->m_fd
,
675 sck
->m_local
->m_addr
,
676 (SOCKLEN_T
*) &sck
->m_local
->m_len
) != 0))
679 sck
->m_fd
= INVALID_SOCKET
;
680 sck
->m_error
= GSOCK_IOERR
;
684 return GSOCK_NOERROR
;
689 /* Like recv(), send(), ... */
690 int GSocket_Read(GSocket
*socket
, char *buffer
, int size
)
694 assert(socket
!= NULL
);
696 /* Reenable INPUT events */
697 _GSocket_Enable(socket
, GSOCK_INPUT
);
699 if (socket
->m_fd
== INVALID_SOCKET
|| socket
->m_server
)
701 socket
->m_error
= GSOCK_INVSOCK
;
705 /* If the socket is blocking, wait for data (with a timeout) */
706 if (_GSocket_Input_Timeout(socket
) == GSOCK_TIMEDOUT
)
710 if (socket
->m_stream
)
711 ret
= _GSocket_Recv_Stream(socket
, buffer
, size
);
713 ret
= _GSocket_Recv_Dgram(socket
, buffer
, size
);
717 if (errno
== EWOULDBLOCK
)
718 socket
->m_error
= GSOCK_WOULDBLOCK
;
720 socket
->m_error
= GSOCK_IOERR
;
726 int GSocket_Write(GSocket
*socket
, const char *buffer
, int size
)
730 assert(socket
!= NULL
);
732 GSocket_Debug(( "GSocket_Write #1, size %d\n", size
));
734 if (socket
->m_fd
== INVALID_SOCKET
|| socket
->m_server
)
736 socket
->m_error
= GSOCK_INVSOCK
;
740 GSocket_Debug(( "GSocket_Write #2, size %d\n", size
));
742 /* If the socket is blocking, wait for writability (with a timeout) */
743 if (_GSocket_Output_Timeout(socket
) == GSOCK_TIMEDOUT
)
746 GSocket_Debug(( "GSocket_Write #3, size %d\n", size
));
749 if (socket
->m_stream
)
750 ret
= _GSocket_Send_Stream(socket
, buffer
, size
);
752 ret
= _GSocket_Send_Dgram(socket
, buffer
, size
);
754 GSocket_Debug(( "GSocket_Write #4, size %d\n", size
));
758 if (errno
== EWOULDBLOCK
)
760 socket
->m_error
= GSOCK_WOULDBLOCK
;
761 GSocket_Debug(( "GSocket_Write error WOULDBLOCK\n" ));
765 socket
->m_error
= GSOCK_IOERR
;
766 GSocket_Debug(( "GSocket_Write error IOERR\n" ));
769 /* Only reenable OUTPUT events after an error (just like WSAAsyncSelect
770 * in MSW). Once the first OUTPUT event is received, users can assume
771 * that the socket is writable until a read operation fails. Only then
772 * will further OUTPUT events be posted.
774 _GSocket_Enable(socket
, GSOCK_OUTPUT
);
778 GSocket_Debug(( "GSocket_Write #5, size %d ret %d\n", size
, ret
));
784 * Polls the socket to determine its status. This function will
785 * check for the events specified in the 'flags' parameter, and
786 * it will return a mask indicating which operations can be
787 * performed. This function won't block, regardless of the
788 * mode (blocking | nonblocking) of the socket.
790 GSocketEventFlags
GSocket_Select(GSocket
*socket
, GSocketEventFlags flags
)
792 #if defined(wxUSE_GUI) && !wxUSE_GUI
794 GSocketEventFlags result
= 0;
800 /* Do not use a static struct, Linux can garble it */
804 assert(socket
!= NULL
);
809 FD_SET(socket
->m_fd
, &readfds
);
810 FD_SET(socket
->m_fd
, &writefds
);
811 FD_SET(socket
->m_fd
, &exceptfds
);
813 /* Check known state first */
814 result
|= (GSOCK_CONNECTION_FLAG
& socket
->m_detected
& flags
);
815 result
|= (GSOCK_LOST_FLAG
& socket
->m_detected
& flags
);
818 if (select(socket
->m_fd
+ 1, &readfds
, &writefds
, &exceptfds
, &tv
) <= 0)
821 /* Check for readability */
822 if (FD_ISSET(socket
->m_fd
, &readfds
))
826 if (recv(socket
->m_fd
, &c
, 1, MSG_PEEK
) > 0)
828 result
|= (GSOCK_INPUT_FLAG
& flags
);
832 if (socket
->m_server
&& socket
->m_stream
)
834 result
|= (GSOCK_CONNECTION_FLAG
& flags
);
835 socket
->m_detected
|= GSOCK_CONNECTION_FLAG
;
839 result
|= (GSOCK_LOST_FLAG
& flags
);
840 socket
->m_detected
= GSOCK_LOST_FLAG
;
845 /* Check for writability */
846 if (FD_ISSET(socket
->m_fd
, &writefds
))
848 if (socket
->m_establishing
&& !socket
->m_server
)
851 SOCKLEN_T len
= sizeof(error
);
853 socket
->m_establishing
= FALSE
;
855 getsockopt(socket
->m_fd
, SOL_SOCKET
, SO_ERROR
, (void*)&error
, &len
);
859 result
|= (GSOCK_LOST_FLAG
& flags
);
860 socket
->m_detected
= GSOCK_LOST_FLAG
;
864 result
|= (GSOCK_CONNECTION_FLAG
& flags
);
865 socket
->m_detected
|= GSOCK_CONNECTION_FLAG
;
870 result
|= (GSOCK_OUTPUT_FLAG
& flags
);
874 /* Check for exceptions and errors (is this useful in Unices?) */
875 if (FD_ISSET(socket
->m_fd
, &exceptfds
))
877 result
|= (GSOCK_LOST_FLAG
& flags
);
878 socket
->m_establishing
= FALSE
;
879 socket
->m_detected
= GSOCK_LOST_FLAG
;
886 assert(socket
!= NULL
);
887 return flags
& socket
->m_detected
;
889 #endif /* !wxUSE_GUI */
894 /* GSocket_SetNonBlocking:
895 * Sets the socket to non-blocking mode. All IO calls will return
898 void GSocket_SetNonBlocking(GSocket
*socket
, int non_block
)
900 assert(socket
!= NULL
);
902 GSocket_Debug( ("GSocket_SetNonBlocking: %d\n", (int)non_block
) );
904 socket
->m_non_blocking
= non_block
;
907 /* GSocket_SetTimeout:
908 * Sets the timeout for blocking calls. Time is expressed in
911 void GSocket_SetTimeout(GSocket
*socket
, unsigned long millisec
)
913 assert(socket
!= NULL
);
915 socket
->m_timeout
= millisec
;
919 * Returns the last error occured for this socket. Note that successful
920 * operations do not clear this back to GSOCK_NOERROR, so use it only
923 GSocketError
GSocket_GetError(GSocket
*socket
)
925 assert(socket
!= NULL
);
927 return socket
->m_error
;
933 * There is data to be read in the input buffer. If, after a read
934 * operation, there is still data available, the callback function will
937 * The socket is available for writing. That is, the next write call
938 * won't block. This event is generated only once, when the connection is
939 * first established, and then only if a call failed with GSOCK_WOULDBLOCK,
940 * when the output buffer empties again. This means that the app should
941 * assume that it can write since the first OUTPUT event, and no more
942 * OUTPUT events will be generated unless an error occurs.
944 * Connection succesfully established, for client sockets, or incoming
945 * client connection, for server sockets. Wait for this event (also watch
946 * out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
948 * The connection is lost (or a connection request failed); this could
949 * be due to a failure, or due to the peer closing it gracefully.
952 /* GSocket_SetCallback:
953 * Enables the callbacks specified by 'flags'. Note that 'flags'
954 * may be a combination of flags OR'ed toghether, so the same
955 * callback function can be made to accept different events.
956 * The callback function must have the following prototype:
958 * void function(GSocket *socket, GSocketEvent event, char *cdata)
960 void GSocket_SetCallback(GSocket
*socket
, GSocketEventFlags flags
,
961 GSocketCallback callback
, char *cdata
)
965 assert(socket
!= NULL
);
967 for (count
= 0; count
< GSOCK_MAX_EVENT
; count
++)
969 if ((flags
& (1 << count
)) != 0)
971 socket
->m_cbacks
[count
] = callback
;
972 socket
->m_data
[count
] = cdata
;
977 /* GSocket_UnsetCallback:
978 * Disables all callbacks specified by 'flags', which may be a
979 * combination of flags OR'ed toghether.
981 void GSocket_UnsetCallback(GSocket
*socket
, GSocketEventFlags flags
)
985 assert(socket
!= NULL
);
987 for (count
= 0; count
< GSOCK_MAX_EVENT
; count
++)
989 if ((flags
& (1 << count
)) != 0)
991 socket
->m_cbacks
[count
] = NULL
;
992 socket
->m_data
[count
] = NULL
;
998 #define CALL_CALLBACK(socket, event) { \
999 _GSocket_Disable(socket, event); \
1000 if (socket->m_cbacks[event]) \
1001 socket->m_cbacks[event](socket, event, socket->m_data[event]); \
1005 void _GSocket_Enable(GSocket
*socket
, GSocketEvent event
)
1007 socket
->m_detected
&= ~(1 << event
);
1008 _GSocket_Install_Callback(socket
, event
);
1011 void _GSocket_Disable(GSocket
*socket
, GSocketEvent event
)
1013 socket
->m_detected
|= (1 << event
);
1014 _GSocket_Uninstall_Callback(socket
, event
);
1017 /* _GSocket_Input_Timeout:
1018 * For blocking sockets, wait until data is available or
1019 * until timeout ellapses.
1021 GSocketError
_GSocket_Input_Timeout(GSocket
*socket
)
1027 /* Linux select() will overwrite the struct on return */
1028 tv
.tv_sec
= (socket
->m_timeout
/ 1000);
1029 tv
.tv_usec
= (socket
->m_timeout
% 1000) * 1000;
1031 if (!socket
->m_non_blocking
)
1034 FD_SET(socket
->m_fd
, &readfds
);
1035 ret
= select(socket
->m_fd
+ 1, &readfds
, NULL
, NULL
, &tv
);
1038 GSocket_Debug(( "GSocket_Input_Timeout, select returned 0\n" ));
1039 socket
->m_error
= GSOCK_TIMEDOUT
;
1040 return GSOCK_TIMEDOUT
;
1044 GSocket_Debug(( "GSocket_Input_Timeout, select returned -1\n" ));
1045 if (errno
== EBADF
) { GSocket_Debug(( "Invalid file descriptor\n" )); }
1046 if (errno
== EINTR
) { GSocket_Debug(( "A non blocked signal was caught\n" )); }
1047 if (errno
== EINVAL
) { GSocket_Debug(( "The highest number descriptor is negative\n" )); }
1048 if (errno
== ENOMEM
) { GSocket_Debug(( "Not enough memory\n" )); }
1049 socket
->m_error
= GSOCK_TIMEDOUT
;
1050 return GSOCK_TIMEDOUT
;
1053 return GSOCK_NOERROR
;
1056 /* _GSocket_Output_Timeout:
1057 * For blocking sockets, wait until data can be sent without
1058 * blocking or until timeout ellapses.
1060 GSocketError
_GSocket_Output_Timeout(GSocket
*socket
)
1066 /* Linux select() will overwrite the struct on return */
1067 tv
.tv_sec
= (socket
->m_timeout
/ 1000);
1068 tv
.tv_usec
= (socket
->m_timeout
% 1000) * 1000;
1070 GSocket_Debug( ("m_non_blocking has: %d\n", (int)socket
->m_non_blocking
) );
1072 if (!socket
->m_non_blocking
)
1075 FD_SET(socket
->m_fd
, &writefds
);
1076 ret
= select(socket
->m_fd
+ 1, NULL
, &writefds
, NULL
, &tv
);
1079 GSocket_Debug(( "GSocket_Output_Timeout, select returned 0\n" ));
1080 socket
->m_error
= GSOCK_TIMEDOUT
;
1081 return GSOCK_TIMEDOUT
;
1085 GSocket_Debug(( "GSocket_Output_Timeout, select returned -1\n" ));
1086 if (errno
== EBADF
) { GSocket_Debug(( "Invalid file descriptor\n" )); }
1087 if (errno
== EINTR
) { GSocket_Debug(( "A non blocked signal was caught\n" )); }
1088 if (errno
== EINVAL
) { GSocket_Debug(( "The highest number descriptor is negative\n" )); }
1089 if (errno
== ENOMEM
) { GSocket_Debug(( "Not enough memory\n" )); }
1090 socket
->m_error
= GSOCK_TIMEDOUT
;
1091 return GSOCK_TIMEDOUT
;
1093 if ( ! FD_ISSET(socket
->m_fd
, &writefds
) ) {
1094 GSocket_Debug(( "GSocket_Output_Timeout is buggy!\n" ));
1097 GSocket_Debug(( "GSocket_Output_Timeout seems correct\n" ));
1102 GSocket_Debug(( "GSocket_Output_Timeout, didn't try select!\n" ));
1105 return GSOCK_NOERROR
;
1108 int _GSocket_Recv_Stream(GSocket
*socket
, char *buffer
, int size
)
1110 return recv(socket
->m_fd
, buffer
, size
, 0);
1113 int _GSocket_Recv_Dgram(GSocket
*socket
, char *buffer
, int size
)
1115 struct sockaddr from
;
1116 SOCKLEN_T fromlen
= sizeof(from
);
1120 fromlen
= sizeof(from
);
1122 ret
= recvfrom(socket
->m_fd
, buffer
, size
, 0, &from
, (SOCKLEN_T
*) &fromlen
);
1127 /* Translate a system address into a GSocket address */
1128 if (!socket
->m_peer
)
1130 socket
->m_peer
= GAddress_new();
1131 if (!socket
->m_peer
)
1133 socket
->m_error
= GSOCK_MEMERR
;
1137 err
= _GAddress_translate_from(socket
->m_peer
, &from
, fromlen
);
1138 if (err
!= GSOCK_NOERROR
)
1140 GAddress_destroy(socket
->m_peer
);
1141 socket
->m_peer
= NULL
;
1142 socket
->m_error
= err
;
1149 int _GSocket_Send_Stream(GSocket
*socket
, const char *buffer
, int size
)
1154 ret
= send(socket
->m_fd
, buffer
, size
, 0);
1160 int _GSocket_Send_Dgram(GSocket
*socket
, const char *buffer
, int size
)
1162 struct sockaddr
*addr
;
1166 if (!socket
->m_peer
)
1168 socket
->m_error
= GSOCK_INVADDR
;
1172 err
= _GAddress_translate_to(socket
->m_peer
, &addr
, &len
);
1173 if (err
!= GSOCK_NOERROR
)
1175 socket
->m_error
= err
;
1180 ret
= sendto(socket
->m_fd
, buffer
, size
, 0, addr
, len
);
1183 /* Frees memory allocated from _GAddress_translate_to */
1189 void _GSocket_Detected_Read(GSocket
*socket
)
1193 if (recv(socket
->m_fd
, &c
, 1, MSG_PEEK
) > 0)
1195 CALL_CALLBACK(socket
, GSOCK_INPUT
);
1199 if (socket
->m_server
&& socket
->m_stream
)
1201 CALL_CALLBACK(socket
, GSOCK_CONNECTION
);
1205 CALL_CALLBACK(socket
, GSOCK_LOST
);
1210 void _GSocket_Detected_Write(GSocket
*socket
)
1212 if (socket
->m_establishing
&& !socket
->m_server
)
1215 SOCKLEN_T len
= sizeof(error
);
1217 socket
->m_establishing
= FALSE
;
1219 getsockopt(socket
->m_fd
, SOL_SOCKET
, SO_ERROR
, (void*)&error
, &len
);
1223 CALL_CALLBACK(socket
, GSOCK_LOST
);
1227 CALL_CALLBACK(socket
, GSOCK_CONNECTION
);
1228 /* We have to fire this event by hand because CONNECTION (for clients)
1229 * and OUTPUT are internally the same and we just disabled CONNECTION
1230 * events with the above macro.
1232 CALL_CALLBACK(socket
, GSOCK_OUTPUT
);
1237 CALL_CALLBACK(socket
, GSOCK_OUTPUT
);
1242 * -------------------------------------------------------------------------
1244 * -------------------------------------------------------------------------
1247 /* CHECK_ADDRESS verifies that the current address family is either
1248 * GSOCK_NOFAMILY or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it
1249 * initalizes it to be a GSOCK_*family*. In other cases, it returns
1250 * an appropiate error code.
1252 * CHECK_ADDRESS_RETVAL does the same but returning 'retval' on error.
1254 #define CHECK_ADDRESS(address, family) \
1256 if (address->m_family == GSOCK_NOFAMILY) \
1257 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1258 return address->m_error; \
1259 if (address->m_family != GSOCK_##family) \
1261 address->m_error = GSOCK_INVADDR; \
1262 return GSOCK_INVADDR; \
1266 #define CHECK_ADDRESS_RETVAL(address, family, retval) \
1268 if (address->m_family == GSOCK_NOFAMILY) \
1269 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1271 if (address->m_family != GSOCK_##family) \
1273 address->m_error = GSOCK_INVADDR; \
1279 GAddress
*GAddress_new(void)
1283 if ((address
= (GAddress
*) malloc(sizeof(GAddress
))) == NULL
)
1286 address
->m_family
= GSOCK_NOFAMILY
;
1287 address
->m_addr
= NULL
;
1293 GAddress
*GAddress_copy(GAddress
*address
)
1297 assert(address
!= NULL
);
1299 if ((addr2
= (GAddress
*) malloc(sizeof(GAddress
))) == NULL
)
1302 memcpy(addr2
, address
, sizeof(GAddress
));
1304 if (address
->m_addr
)
1306 addr2
->m_addr
= (struct sockaddr
*)malloc(addr2
->m_len
);
1307 if (addr2
->m_addr
== NULL
)
1312 memcpy(addr2
->m_addr
, address
->m_addr
, addr2
->m_len
);
1318 void GAddress_destroy(GAddress
*address
)
1320 assert(address
!= NULL
);
1322 if (address
->m_addr
)
1323 free(address
->m_addr
);
1328 void GAddress_SetFamily(GAddress
*address
, GAddressType type
)
1330 assert(address
!= NULL
);
1332 address
->m_family
= type
;
1335 GAddressType
GAddress_GetFamily(GAddress
*address
)
1337 assert(address
!= NULL
);
1339 return address
->m_family
;
1342 GSocketError
_GAddress_translate_from(GAddress
*address
,
1343 struct sockaddr
*addr
, int len
)
1345 address
->m_realfamily
= addr
->sa_family
;
1346 switch (addr
->sa_family
)
1349 address
->m_family
= GSOCK_INET
;
1352 address
->m_family
= GSOCK_UNIX
;
1356 address
->m_family
= GSOCK_INET6
;
1361 address
->m_error
= GSOCK_INVOP
;
1366 if (address
->m_addr
)
1367 free(address
->m_addr
);
1369 address
->m_len
= len
;
1370 address
->m_addr
= (struct sockaddr
*)malloc(len
);
1372 if (address
->m_addr
== NULL
)
1374 address
->m_error
= GSOCK_MEMERR
;
1375 return GSOCK_MEMERR
;
1377 memcpy(address
->m_addr
, addr
, len
);
1379 return GSOCK_NOERROR
;
1382 GSocketError
_GAddress_translate_to(GAddress
*address
,
1383 struct sockaddr
**addr
, int *len
)
1385 if (!address
->m_addr
)
1387 address
->m_error
= GSOCK_INVADDR
;
1388 return GSOCK_INVADDR
;
1391 *len
= address
->m_len
;
1392 *addr
= (struct sockaddr
*)malloc(address
->m_len
);
1395 address
->m_error
= GSOCK_MEMERR
;
1396 return GSOCK_MEMERR
;
1399 memcpy(*addr
, address
->m_addr
, address
->m_len
);
1400 return GSOCK_NOERROR
;
1404 * -------------------------------------------------------------------------
1405 * Internet address family
1406 * -------------------------------------------------------------------------
1409 GSocketError
_GAddress_Init_INET(GAddress
*address
)
1411 address
->m_len
= sizeof(struct sockaddr_in
);
1412 address
->m_addr
= (struct sockaddr
*) malloc(address
->m_len
);
1413 if (address
->m_addr
== NULL
)
1415 address
->m_error
= GSOCK_MEMERR
;
1416 return GSOCK_MEMERR
;
1419 address
->m_family
= GSOCK_INET
;
1420 address
->m_realfamily
= PF_INET
;
1421 ((struct sockaddr_in
*)address
->m_addr
)->sin_family
= AF_INET
;
1422 ((struct sockaddr_in
*)address
->m_addr
)->sin_addr
.s_addr
= INADDR_ANY
;
1424 return GSOCK_NOERROR
;
1427 GSocketError
GAddress_INET_SetHostName(GAddress
*address
, const char *hostname
)
1430 struct in_addr
*addr
;
1432 assert(address
!= NULL
);
1434 CHECK_ADDRESS(address
, INET
);
1436 addr
= &(((struct sockaddr_in
*)address
->m_addr
)->sin_addr
);
1438 /* If it is a numeric host name, convert it now */
1439 #if defined(HAVE_INET_ATON)
1440 if (inet_aton(hostname
, addr
) == 0)
1442 #elif defined(HAVE_INET_ADDR)
1443 if ( (addr
->s_addr
= inet_addr(hostname
)) == -1 )
1446 /* Use gethostbyname by default */
1450 struct in_addr
*array_addr
;
1452 /* It is a real name, we solve it */
1453 if ((he
= gethostbyname(hostname
)) == NULL
)
1455 /* Reset to invalid address */
1456 addr
->s_addr
= INADDR_NONE
;
1457 address
->m_error
= GSOCK_NOHOST
;
1458 return GSOCK_NOHOST
;
1460 array_addr
= (struct in_addr
*) *(he
->h_addr_list
);
1461 addr
->s_addr
= array_addr
[0].s_addr
;
1463 return GSOCK_NOERROR
;
1466 GSocketError
GAddress_INET_SetAnyAddress(GAddress
*address
)
1468 return GAddress_INET_SetHostAddress(address
, INADDR_ANY
);
1471 GSocketError
GAddress_INET_SetHostAddress(GAddress
*address
,
1472 unsigned long hostaddr
)
1474 struct in_addr
*addr
;
1476 assert(address
!= NULL
);
1478 CHECK_ADDRESS(address
, INET
);
1480 addr
= &(((struct sockaddr_in
*)address
->m_addr
)->sin_addr
);
1481 addr
->s_addr
= hostaddr
;
1483 return GSOCK_NOERROR
;
1486 GSocketError
GAddress_INET_SetPortName(GAddress
*address
, const char *port
,
1487 const char *protocol
)
1490 struct sockaddr_in
*addr
;
1492 assert(address
!= NULL
);
1493 CHECK_ADDRESS(address
, INET
);
1497 address
->m_error
= GSOCK_INVPORT
;
1498 return GSOCK_INVPORT
;
1501 se
= getservbyname(port
, protocol
);
1504 /* the cast to int suppresses compiler warnings about subscript having the
1506 if (isdigit((int)port
[0]))
1510 port_int
= atoi(port
);
1511 addr
= (struct sockaddr_in
*)address
->m_addr
;
1512 addr
->sin_port
= htons(port_int
);
1513 return GSOCK_NOERROR
;
1516 address
->m_error
= GSOCK_INVPORT
;
1517 return GSOCK_INVPORT
;
1520 addr
= (struct sockaddr_in
*)address
->m_addr
;
1521 addr
->sin_port
= se
->s_port
;
1523 return GSOCK_NOERROR
;
1526 GSocketError
GAddress_INET_SetPort(GAddress
*address
, unsigned short port
)
1528 struct sockaddr_in
*addr
;
1530 assert(address
!= NULL
);
1531 CHECK_ADDRESS(address
, INET
);
1533 addr
= (struct sockaddr_in
*)address
->m_addr
;
1534 addr
->sin_port
= htons(port
);
1536 return GSOCK_NOERROR
;
1539 GSocketError
GAddress_INET_GetHostName(GAddress
*address
, char *hostname
, size_t sbuf
)
1543 struct sockaddr_in
*addr
;
1545 assert(address
!= NULL
);
1546 CHECK_ADDRESS(address
, INET
);
1548 addr
= (struct sockaddr_in
*)address
->m_addr
;
1549 addr_buf
= (char *)&(addr
->sin_addr
);
1551 he
= gethostbyaddr(addr_buf
, sizeof(addr
->sin_addr
), AF_INET
);
1554 address
->m_error
= GSOCK_NOHOST
;
1555 return GSOCK_NOHOST
;
1558 strncpy(hostname
, he
->h_name
, sbuf
);
1560 return GSOCK_NOERROR
;
1563 unsigned long GAddress_INET_GetHostAddress(GAddress
*address
)
1565 struct sockaddr_in
*addr
;
1567 assert(address
!= NULL
);
1568 CHECK_ADDRESS_RETVAL(address
, INET
, 0);
1570 addr
= (struct sockaddr_in
*)address
->m_addr
;
1572 return addr
->sin_addr
.s_addr
;
1575 unsigned short GAddress_INET_GetPort(GAddress
*address
)
1577 struct sockaddr_in
*addr
;
1579 assert(address
!= NULL
);
1580 CHECK_ADDRESS_RETVAL(address
, INET
, 0);
1582 addr
= (struct sockaddr_in
*)address
->m_addr
;
1583 return ntohs(addr
->sin_port
);
1587 * -------------------------------------------------------------------------
1588 * Unix address family
1589 * -------------------------------------------------------------------------
1592 GSocketError
_GAddress_Init_UNIX(GAddress
*address
)
1594 address
->m_len
= sizeof(struct sockaddr_un
);
1595 address
->m_addr
= (struct sockaddr
*)malloc(address
->m_len
);
1596 if (address
->m_addr
== NULL
)
1598 address
->m_error
= GSOCK_MEMERR
;
1599 return GSOCK_MEMERR
;
1602 address
->m_family
= GSOCK_UNIX
;
1603 address
->m_realfamily
= PF_UNIX
;
1604 ((struct sockaddr_un
*)address
->m_addr
)->sun_family
= AF_UNIX
;
1605 ((struct sockaddr_un
*)address
->m_addr
)->sun_path
[0] = 0;
1607 return GSOCK_NOERROR
;
1610 #define UNIX_SOCK_PATHLEN (sizeof(addr->sun_path)/sizeof(addr->sun_path[0]))
1612 GSocketError
GAddress_UNIX_SetPath(GAddress
*address
, const char *path
)
1614 struct sockaddr_un
*addr
;
1616 assert(address
!= NULL
);
1618 CHECK_ADDRESS(address
, UNIX
);
1620 addr
= ((struct sockaddr_un
*)address
->m_addr
);
1621 strncpy(addr
->sun_path
, path
, UNIX_SOCK_PATHLEN
);
1622 addr
->sun_path
[UNIX_SOCK_PATHLEN
- 1] = '\0';
1624 return GSOCK_NOERROR
;
1627 GSocketError
GAddress_UNIX_GetPath(GAddress
*address
, char *path
, size_t sbuf
)
1629 struct sockaddr_un
*addr
;
1631 assert(address
!= NULL
);
1632 CHECK_ADDRESS(address
, UNIX
);
1634 addr
= (struct sockaddr_un
*)address
->m_addr
;
1636 strncpy(path
, addr
->sun_path
, sbuf
);
1638 return GSOCK_NOERROR
;
1641 #endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */