]> git.saurik.com Git - wxWidgets.git/blob - src/msw/gsocket.c
GSocket:
[wxWidgets.git] / src / msw / gsocket.c
1 /* -------------------------------------------------------------------------
2 * Project: GSocket (Generic Socket)
3 * Name: gsocket.c
4 * Author: Guillermo Rodriguez Garcia <guille@iies.es>
5 * Purpose: GSocket main MSW file
6 * CVSID: $Id$
7 * -------------------------------------------------------------------------
8 */
9
10 /*
11 * PLEASE don't put C++ comments here - this is a C source file.
12 */
13
14 #ifndef __GSOCKET_STANDALONE__
15 #include "wx/setup.h"
16 #endif
17
18 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
19
20 #ifndef __GSOCKET_STANDALONE__
21
22 #include "wx/msw/gsockmsw.h"
23 #include "wx/gsocket.h"
24
25 #define INSTANCE wxGetInstance()
26
27 #else
28
29 #include "gsockmsw.h"
30 #include "gsocket.h"
31
32 /* If not using wxWindows, a global var called hInst must
33 * be available and it must containt the app's instance
34 * handle.
35 */
36 #define INSTANCE hInst
37
38 #endif /* __GSOCKET_STANDALONE__ */
39
40
41 #include <assert.h>
42 #include <string.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <stddef.h>
46 #include <ctype.h>
47 #include <winsock.h>
48
49 #define SOCKLEN_T int
50 #define CLASSNAME "_GSocket_Internal_Window_Class"
51 #define WINDOWNAME "_GSocket_Internal_Window_Name"
52
53 /* Maximum number of different GSocket objects at a given time.
54 * This value can be modified at will, but it CANNOT be greater
55 * than (0x7FFF - WM_USER + 1)
56 */
57 #define MAXSOCKETS 1024
58
59 #if (MAXSOCKETS > (0x7FFF - WM_USER + 1))
60 #error "MAXSOCKETS is too big!"
61 #endif
62
63
64 /* Global variables */
65
66 extern HINSTANCE INSTANCE;
67 static HWND hWin;
68 static CRITICAL_SECTION critical;
69 static GSocket* socketList[MAXSOCKETS];
70 static int firstAvailable;
71
72 /* Global initializers */
73
74 bool GSocket_Init()
75 {
76 WSADATA wsaData;
77 WNDCLASS winClass;
78 int i;
79
80 /* Create internal window for event notifications */
81 winClass.style = 0;
82 winClass.lpfnWndProc = _GSocket_Internal_WinProc;
83 winClass.cbClsExtra = 0;
84 winClass.cbWndExtra = 0;
85 winClass.hInstance = INSTANCE;
86 winClass.hIcon = (HICON) NULL;
87 winClass.hCursor = (HCURSOR) NULL;
88 winClass.hbrBackground = (HBRUSH) NULL;
89 winClass.lpszMenuName = (LPCTSTR) NULL;
90 winClass.lpszClassName = CLASSNAME;
91
92 RegisterClass(&winClass);
93 hWin = CreateWindow(CLASSNAME,
94 WINDOWNAME,
95 0, 0, 0, 0, 0,
96 (HWND) NULL, (HMENU) NULL, INSTANCE, (LPVOID) NULL);
97
98 if (!hWin) return FALSE;
99
100 /* Initialize socket list */
101 InitializeCriticalSection(&critical);
102
103 for (i = 0; i < MAXSOCKETS; i++)
104 {
105 socketList[i] = NULL;
106 }
107 firstAvailable = 0;
108
109 /* Initialize WinSocket */
110 return (WSAStartup((1 << 8) | 1, &wsaData) == 0);
111 }
112
113 void GSocket_Cleanup()
114 {
115 /* Destroy internal window */
116 DestroyWindow(hWin);
117 UnregisterClass(CLASSNAME, INSTANCE);
118
119 /* Delete critical section */
120 DeleteCriticalSection(&critical);
121
122 /* Cleanup WinSocket */
123 WSACleanup();
124 }
125
126 /* Constructors / Destructors for GSocket */
127
128 GSocket *GSocket_new()
129 {
130 int i;
131 GSocket *socket;
132
133 if ((socket = (GSocket *) malloc(sizeof(GSocket))) == NULL)
134 return NULL;
135
136 socket->m_fd = INVALID_SOCKET;
137 for (i = 0; i < GSOCK_MAX_EVENT; i++)
138 {
139 socket->m_cbacks[i] = NULL;
140 }
141 socket->m_local = NULL;
142 socket->m_peer = NULL;
143 socket->m_error = GSOCK_NOERROR;
144 socket->m_server = FALSE;
145 socket->m_stream = TRUE;
146 socket->m_non_blocking = FALSE;
147 socket->m_timeout.tv_sec = 10 * 60; /* 10 minutes */
148 socket->m_timeout.tv_usec = 0;
149 socket->m_detected = 0;
150
151 /* Allocate a new message number for this socket */
152 EnterCriticalSection(&critical);
153
154 i = firstAvailable;
155 while (socketList[i] != NULL)
156 {
157 i = (i + 1) % MAXSOCKETS;
158
159 if (i == firstAvailable) /* abort! */
160 {
161 free(socket);
162 LeaveCriticalSection(&critical);
163 return NULL;
164 }
165 }
166 socketList[i] = socket;
167 firstAvailable = (i + 1) % MAXSOCKETS;
168 socket->m_msgnumber = (i + WM_USER);
169
170 LeaveCriticalSection(&critical);
171
172 return socket;
173 }
174
175 void GSocket_destroy(GSocket *socket)
176 {
177 assert(socket != NULL);
178
179 /* Remove the socket from the list */
180 EnterCriticalSection(&critical);
181 socketList[(socket->m_msgnumber - WM_USER)] = NULL;
182 LeaveCriticalSection(&critical);
183
184 /* Check that the socket is really shutdowned */
185 if (socket->m_fd != INVALID_SOCKET)
186 GSocket_Shutdown(socket);
187
188 /* Destroy private addresses */
189 if (socket->m_local)
190 GAddress_destroy(socket->m_local);
191
192 if (socket->m_peer)
193 GAddress_destroy(socket->m_peer);
194
195 /* Destroy the socket itself */
196 free(socket);
197 }
198
199 /* GSocket_Shutdown:
200 * Disallow further read/write operations on this socket, close
201 * the fd and disable all callbacks.
202 */
203 void GSocket_Shutdown(GSocket *socket)
204 {
205 int evt;
206
207 assert(socket != NULL);
208
209 /* If socket has been created, shutdown it */
210 if (socket->m_fd != INVALID_SOCKET)
211 {
212 shutdown(socket->m_fd, 2);
213 closesocket(socket->m_fd);
214 socket->m_fd = INVALID_SOCKET;
215 }
216
217 /* Disable GUI callbacks */
218 for (evt = 0; evt < GSOCK_MAX_EVENT; evt++)
219 socket->m_cbacks[evt] = NULL;
220
221 socket->m_detected = 0;
222 _GSocket_Disable_Events(socket);
223 }
224
225 /* Address handling */
226
227 /* GSocket_SetLocal:
228 * GSocket_GetLocal:
229 * GSocket_SetPeer:
230 * GSocket_GetPeer:
231 * Set or get the local or peer address for this socket. The 'set'
232 * functions return GSOCK_NOERROR on success, an error code otherwise.
233 * The 'get' functions return a pointer to a GAddress object on success,
234 * or NULL otherwise, in which case they set the error code of the
235 * corresponding GSocket.
236 *
237 * Error codes:
238 * GSOCK_INVSOCK - the socket is not valid.
239 * GSOCK_INVADDR - the address is not valid.
240 */
241 GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address)
242 {
243 assert(socket != NULL);
244
245 /* the socket must be initialized, or it must be a server */
246 if (socket->m_fd != INVALID_SOCKET && !socket->m_server)
247 {
248 socket->m_error = GSOCK_INVSOCK;
249 return GSOCK_INVSOCK;
250 }
251
252 /* check address */
253 if (address == NULL || address->m_family == GSOCK_NOFAMILY)
254 {
255 socket->m_error = GSOCK_INVADDR;
256 return GSOCK_INVADDR;
257 }
258
259 if (socket->m_local)
260 GAddress_destroy(socket->m_local);
261
262 socket->m_local = GAddress_copy(address);
263
264 return GSOCK_NOERROR;
265 }
266
267 GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address)
268 {
269 assert(socket != NULL);
270
271 /* check address */
272 if (address == NULL || address->m_family == GSOCK_NOFAMILY)
273 {
274 socket->m_error = GSOCK_INVADDR;
275 return GSOCK_INVADDR;
276 }
277
278 if (socket->m_peer)
279 GAddress_destroy(socket->m_peer);
280
281 socket->m_peer = GAddress_copy(address);
282
283 return GSOCK_NOERROR;
284 }
285
286 GAddress *GSocket_GetLocal(GSocket *socket)
287 {
288 GAddress *address;
289 struct sockaddr addr;
290 SOCKLEN_T size = sizeof(addr);
291 GSocketError err;
292
293 assert(socket != NULL);
294
295 /* try to get it from the m_local var first */
296 if (socket->m_local)
297 return GAddress_copy(socket->m_local);
298
299 /* else, if the socket is initialized, try getsockname */
300 if (socket->m_fd == INVALID_SOCKET)
301 {
302 socket->m_error = GSOCK_INVSOCK;
303 return NULL;
304 }
305
306 if (getsockname(socket->m_fd, &addr, &size) == SOCKET_ERROR)
307 {
308 socket->m_error = GSOCK_IOERR;
309 return NULL;
310 }
311
312 /* got a valid address from getsockname, create a GAddress object */
313 if ((address = GAddress_new()) == NULL)
314 {
315 socket->m_error = GSOCK_MEMERR;
316 return NULL;
317 }
318
319 if ((err = _GAddress_translate_from(address, &addr, size)) != GSOCK_NOERROR)
320 {
321 GAddress_destroy(address);
322 socket->m_error = err;
323 return NULL;
324 }
325
326 return address;
327 }
328
329 GAddress *GSocket_GetPeer(GSocket *socket)
330 {
331 assert(socket != NULL);
332
333 /* try to get it from the m_peer var */
334 if (socket->m_peer)
335 return GAddress_copy(socket->m_peer);
336
337 return NULL;
338 }
339
340 /* Server specific parts */
341
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:
346 *
347 * Error codes:
348 * GSOCK_INVSOCK - the socket is in use.
349 * GSOCK_INVADDR - the local address has not been set.
350 * GSOCK_IOERR - low-level error.
351 */
352 GSocketError GSocket_SetServer(GSocket *sck)
353 {
354 u_long arg = 1;
355
356 assert(sck != NULL);
357
358 /* must not be in use */
359 if (sck->m_fd != INVALID_SOCKET)
360 {
361 sck->m_error = GSOCK_INVSOCK;
362 return GSOCK_INVSOCK;
363 }
364
365 /* the local addr must have been set */
366 if (!sck->m_local)
367 {
368 sck->m_error = GSOCK_INVADDR;
369 return GSOCK_INVADDR;
370 }
371
372 /* Initialize all fields */
373 sck->m_server = TRUE;
374 sck->m_stream = TRUE;
375 sck->m_oriented = TRUE;
376
377 /* Create the socket */
378 sck->m_fd = socket(sck->m_local->m_realfamily, SOCK_STREAM, 0);
379
380 if (sck->m_fd == INVALID_SOCKET)
381 {
382 sck->m_error = GSOCK_IOERR;
383 return GSOCK_IOERR;
384 }
385
386 ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg);
387 _GSocket_Enable_Events(sck);
388
389 /* Bind to the local address,
390 * retrieve the actual address bound,
391 * and listen up to 5 connections.
392 */
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 &sck->m_local->m_len) != 0) ||
397 (listen(sck->m_fd, 5) != 0))
398 {
399 closesocket(sck->m_fd);
400 sck->m_fd = INVALID_SOCKET;
401 sck->m_error = GSOCK_IOERR;
402 return GSOCK_IOERR;
403 }
404
405 return GSOCK_NOERROR;
406 }
407
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.
412 *
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.
419 */
420 GSocket *GSocket_WaitConnection(GSocket *sck)
421 {
422 GSocket *connection;
423 struct sockaddr from;
424 SOCKLEN_T fromlen = sizeof(from);
425 GSocketError err;
426 u_long arg = 1;
427
428 assert(sck != NULL);
429
430 /* Reenable CONNECTION events */
431 sck->m_detected &= ~GSOCK_CONNECTION_FLAG;
432
433 /* If the socket has already been created, we exit immediately */
434 if (sck->m_fd == INVALID_SOCKET || !sck->m_server)
435 {
436 sck->m_error = GSOCK_INVSOCK;
437 return NULL;
438 }
439
440 /* Create a GSocket object for the new connection */
441 connection = GSocket_new();
442
443 if (!connection)
444 {
445 sck->m_error = GSOCK_MEMERR;
446 return NULL;
447 }
448
449 /* Wait for a connection (with timeout) */
450 if (_GSocket_Input_Timeout(sck) == GSOCK_TIMEDOUT)
451 {
452 GSocket_destroy(connection);
453 /* sck->m_error set by _GSocket_Input_Timeout */
454 return NULL;
455 }
456
457 connection->m_fd = accept(sck->m_fd, &from, &fromlen);
458
459 if (connection->m_fd == INVALID_SOCKET)
460 {
461 if (WSAGetLastError() == WSAEWOULDBLOCK)
462 sck->m_error = GSOCK_WOULDBLOCK;
463 else
464 sck->m_error = GSOCK_IOERR;
465
466 GSocket_destroy(connection);
467 return NULL;
468 }
469
470 /* Initialize all fields */
471 connection->m_server = FALSE;
472 connection->m_stream = TRUE;
473 connection->m_oriented = TRUE;
474
475 /* Setup the peer address field */
476 connection->m_peer = GAddress_new();
477 if (!connection->m_peer)
478 {
479 GSocket_destroy(connection);
480 sck->m_error = GSOCK_MEMERR;
481 return NULL;
482 }
483 err = _GAddress_translate_from(connection->m_peer, &from, fromlen);
484 if (err != GSOCK_NOERROR)
485 {
486 GAddress_destroy(connection->m_peer);
487 GSocket_destroy(connection);
488 sck->m_error = err;
489 return NULL;
490 }
491
492 ioctlsocket(connection->m_fd, FIONBIO, (u_long FAR *) &arg);
493 _GSocket_Enable_Events(connection);
494
495 return connection;
496 }
497
498 /* Client specific parts */
499
500 /* GSocket_Connect:
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.
510 *
511 * For datagram (non connection oriented) sockets, GSocket_Connect()
512 * just sets the peer address established with GSocket_SetPeer() as
513 * default destination.
514 *
515 * Error codes:
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.
522 */
523 GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream)
524 {
525 int ret, err;
526 u_long arg = 1;
527
528 assert(sck != NULL);
529
530 /* Enable CONNECTION events (needed for nonblocking connections) */
531 sck->m_detected &= ~GSOCK_CONNECTION_FLAG;
532
533 if (sck->m_fd != INVALID_SOCKET)
534 {
535 sck->m_error = GSOCK_INVSOCK;
536 return GSOCK_INVSOCK;
537 }
538
539 if (!sck->m_peer)
540 {
541 sck->m_error = GSOCK_INVADDR;
542 return GSOCK_INVADDR;
543 }
544
545 /* Streamed or dgram socket? */
546 sck->m_stream = (stream == GSOCK_STREAMED);
547 sck->m_oriented = TRUE;
548 sck->m_server = FALSE;
549
550 /* Create the socket */
551 sck->m_fd = socket(sck->m_peer->m_realfamily,
552 sck->m_stream? SOCK_STREAM : SOCK_DGRAM, 0);
553
554 if (sck->m_fd == INVALID_SOCKET)
555 {
556 sck->m_error = GSOCK_IOERR;
557 return GSOCK_IOERR;
558 }
559
560 ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg);
561 _GSocket_Enable_Events(sck);
562
563 /* Connect it to the peer address, with a timeout (see below) */
564 ret = connect(sck->m_fd, sck->m_peer->m_addr, sck->m_peer->m_len);
565
566 if (ret == SOCKET_ERROR)
567 {
568 err = WSAGetLastError();
569
570 /* If connect failed with EWOULDBLOCK and the GSocket object
571 * is in blocking mode, we select() for the specified timeout
572 * checking for writability to see if the connection request
573 * completes.
574 */
575 if ((err == WSAEWOULDBLOCK) && (!sck->m_non_blocking))
576 {
577 err = _GSocket_Connect_Timeout(sck);
578
579 if (err != GSOCK_NOERROR)
580 {
581 closesocket(sck->m_fd);
582 sck->m_fd = INVALID_SOCKET;
583 /* sck->m_error is set in _GSocket_Connect_Timeout */
584 }
585
586 return err;
587 }
588
589 /* If connect failed with EWOULDBLOCK and the GSocket object
590 * is set to nonblocking, we set m_error to GSOCK_WOULDBLOCK
591 * (and return GSOCK_WOULDBLOCK) but we don't close the socket;
592 * this way if the connection completes, a GSOCK_CONNECTION
593 * event will be generated, if enabled.
594 */
595 if ((err == WSAEWOULDBLOCK) && (sck->m_non_blocking))
596 {
597 sck->m_error = GSOCK_WOULDBLOCK;
598 return GSOCK_WOULDBLOCK;
599 }
600
601 /* If connect failed with an error other than EWOULDBLOCK,
602 * then the call to GSocket_Connect() has failed.
603 */
604 closesocket(sck->m_fd);
605 sck->m_fd = INVALID_SOCKET;
606 sck->m_error = GSOCK_IOERR;
607 return GSOCK_IOERR;
608 }
609
610 return GSOCK_NOERROR;
611 }
612
613 /* Datagram sockets */
614
615 /* GSocket_SetNonOriented:
616 * Sets up this socket as a non-connection oriented (datagram) socket.
617 * Before using this function, the local address must have been set
618 * with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR
619 * on success, or one of the following otherwise.
620 *
621 * Error codes:
622 * GSOCK_INVSOCK - the socket is in use.
623 * GSOCK_INVADDR - the local address has not been set.
624 * GSOCK_IOERR - low-level error.
625 */
626 GSocketError GSocket_SetNonOriented(GSocket *sck)
627 {
628 u_long arg = 1;
629
630 assert(sck != NULL);
631
632 if (sck->m_fd != INVALID_SOCKET)
633 {
634 sck->m_error = GSOCK_INVSOCK;
635 return GSOCK_INVSOCK;
636 }
637
638 if (!sck->m_local)
639 {
640 sck->m_error = GSOCK_INVADDR;
641 return GSOCK_INVADDR;
642 }
643
644 /* Initialize all fields */
645 sck->m_stream = FALSE;
646 sck->m_server = FALSE;
647 sck->m_oriented = FALSE;
648
649 /* Create the socket */
650 sck->m_fd = socket(sck->m_local->m_realfamily, SOCK_DGRAM, 0);
651
652 if (sck->m_fd == INVALID_SOCKET)
653 {
654 sck->m_error = GSOCK_IOERR;
655 return GSOCK_IOERR;
656 }
657
658 ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg);
659 _GSocket_Enable_Events(sck);
660
661 /* Bind to the local address,
662 * and retrieve the actual address bound.
663 */
664 if ((bind(sck->m_fd, sck->m_local->m_addr, sck->m_local->m_len) != 0) ||
665 (getsockname(sck->m_fd,
666 sck->m_local->m_addr,
667 &sck->m_local->m_len) != 0))
668 {
669 closesocket(sck->m_fd);
670 sck->m_fd = INVALID_SOCKET;
671 sck->m_error = GSOCK_IOERR;
672 return GSOCK_IOERR;
673 }
674
675 return GSOCK_NOERROR;
676 }
677
678
679 /* Generic IO */
680
681 /* Like recv(), send(), ... */
682 int GSocket_Read(GSocket *socket, char *buffer, int size)
683 {
684 int ret;
685
686 assert(socket != NULL);
687
688 /* Reenable INPUT events */
689 socket->m_detected &= ~GSOCK_INPUT_FLAG;
690
691 if (socket->m_fd == INVALID_SOCKET || socket->m_server)
692 {
693 socket->m_error = GSOCK_INVSOCK;
694 return -1;
695 }
696
697 /* If the socket is blocking, wait for data (with a timeout) */
698 if (_GSocket_Input_Timeout(socket) == GSOCK_TIMEDOUT)
699 return -1;
700
701 /* Read the data */
702 if (socket->m_stream)
703 ret = _GSocket_Recv_Stream(socket, buffer, size);
704 else
705 ret = _GSocket_Recv_Dgram(socket, buffer, size);
706
707 if (ret == SOCKET_ERROR)
708 {
709 if (WSAGetLastError() != WSAEWOULDBLOCK)
710 socket->m_error = GSOCK_IOERR;
711 else
712 socket->m_error = GSOCK_WOULDBLOCK;
713 return -1;
714 }
715
716 return ret;
717 }
718
719 int GSocket_Write(GSocket *socket, const char *buffer, int size)
720 {
721 int ret;
722
723 assert(socket != NULL);
724
725 if (socket->m_fd == INVALID_SOCKET || socket->m_server)
726 {
727 socket->m_error = GSOCK_INVSOCK;
728 return -1;
729 }
730
731 /* If the socket is blocking, wait for writability (with a timeout) */
732 if (_GSocket_Output_Timeout(socket) == GSOCK_TIMEDOUT)
733 return -1;
734
735 /* Write the data */
736 if (socket->m_stream)
737 ret = _GSocket_Send_Stream(socket, buffer, size);
738 else
739 ret = _GSocket_Send_Dgram(socket, buffer, size);
740
741 if (ret == SOCKET_ERROR)
742 {
743 if (WSAGetLastError() != WSAEWOULDBLOCK)
744 socket->m_error = GSOCK_IOERR;
745 else
746 socket->m_error = GSOCK_WOULDBLOCK;
747
748 /* Only reenable OUTPUT events after an error (just like WSAAsyncSelect
749 * does). Once the first OUTPUT event is received, users can assume
750 * that the socket is writable until a read operation fails. Only then
751 * will further OUTPUT events be posted.
752 */
753 socket->m_detected &= ~GSOCK_OUTPUT_FLAG;
754 return -1;
755 }
756
757 return ret;
758 }
759
760 /* GSocket_Select:
761 * Polls the socket to determine its status. This function will
762 * check for the events specified in the 'flags' parameter, and
763 * it will return a mask indicating which operations can be
764 * performed. This function won't block, regardless of the
765 * mode (blocking | nonblocking) of the socket.
766 */
767 GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags)
768 {
769 assert(socket != NULL);
770
771 return (flags & socket->m_detected);
772 }
773
774 /* Attributes */
775
776 /* GSocket_SetNonBlocking:
777 * Sets the socket to non-blocking mode. All IO calls will return
778 * immediately.
779 */
780 void GSocket_SetNonBlocking(GSocket *socket, bool non_block)
781 {
782 assert(socket != NULL);
783
784 socket->m_non_blocking = non_block;
785 }
786
787 /* GSocket_SetTimeout:
788 * Sets the timeout for blocking calls. Time is expressed in
789 * milliseconds.
790 */
791 void GSocket_SetTimeout(GSocket *socket, unsigned long millis)
792 {
793 assert(socket != NULL);
794
795 socket->m_timeout.tv_sec = (millis / 1000);
796 socket->m_timeout.tv_usec = (millis % 1000) * 1000;
797 }
798
799 /* GSocket_GetError:
800 * Returns the last error occured for this socket. Note that successful
801 * operations do not clear this back to GSOCK_NOERROR, so use it only
802 * after an error.
803 */
804 GSocketError GSocket_GetError(GSocket *socket)
805 {
806 assert(socket != NULL);
807
808 return socket->m_error;
809 }
810
811
812 /* Callbacks */
813
814 /* GSOCK_INPUT:
815 * There is data to be read in the input buffer. If, after a read
816 * operation, there is still data available, the callback function will
817 * be called again.
818 * GSOCK_OUTPUT:
819 * The socket is available for writing. That is, the next write call
820 * won't block. This event is generated only once, when the connection is
821 * first established, and then only if a call failed with GSOCK_WOULDBLOCK,
822 * when the output buffer empties again. This means that the app should
823 * assume that it can write since the first OUTPUT event, and no more
824 * OUTPUT events will be generated unless an error occurs.
825 * GSOCK_CONNECTION:
826 * Connection succesfully established, for client sockets, or incoming
827 * client connection, for server sockets. Wait for this event (also watch
828 * out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
829 * GSOCK_LOST:
830 * The connection is lost (or a connection request failed); this could
831 * be due to a failure, or due to the peer closing it gracefully.
832 */
833
834 /* GSocket_SetCallback:
835 * Enables the callbacks specified by 'flags'. Note that 'flags'
836 * may be a combination of flags OR'ed toghether, so the same
837 * callback function can be made to accept different events.
838 * The callback function must have the following prototype:
839 *
840 * void function(GSocket *socket, GSocketEvent event, char *cdata)
841 */
842 void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
843 GSocketCallback callback, char *cdata)
844 {
845 int count;
846
847 assert(socket != NULL);
848
849 for (count = 0; count < GSOCK_MAX_EVENT; count++)
850 {
851 if ((flags & (1 << count)) != 0)
852 {
853 socket->m_cbacks[count] = callback;
854 socket->m_data[count] = cdata;
855 }
856 }
857 }
858
859 /* GSocket_UnsetCallback:
860 * Disables all callbacks specified by 'flags', which may be a
861 * combination of flags OR'ed toghether.
862 */
863 void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags)
864 {
865 int count;
866
867 assert(socket != NULL);
868
869 for (count = 0; count < GSOCK_MAX_EVENT; count++)
870 {
871 if ((flags & (1 << count)) != 0)
872 {
873 socket->m_cbacks[count] = NULL;
874 socket->m_data[count] = NULL;
875 }
876 }
877 }
878
879
880 /* Internals */
881
882 /* _GSocket_Enable_Events:
883 * Enable all event notifications; we need to be notified of all
884 * events for internal processing, but we will only notify users
885 * when an appropiate callback function has been installed.
886 */
887 void _GSocket_Enable_Events(GSocket *socket)
888 {
889 assert (socket != NULL);
890
891 if (socket->m_fd != INVALID_SOCKET)
892 {
893 WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber,
894 FD_READ | FD_WRITE | FD_ACCEPT | FD_CONNECT | FD_CLOSE);
895 }
896 }
897
898 /* _GSocket_Disable_Events:
899 * Disable event notifications (when shutdowning the socket)
900 */
901 void _GSocket_Disable_Events(GSocket *socket)
902 {
903 assert (socket != NULL);
904
905 if (socket->m_fd != INVALID_SOCKET)
906 {
907 WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0);
908 }
909 }
910
911
912 LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd,
913 UINT uMsg,
914 WPARAM wParam,
915 LPARAM lParam)
916 {
917 GSocket *socket;
918 GSocketEvent event;
919 GSocketCallback cback;
920 char *data;
921
922 if (uMsg >= WM_USER && uMsg <= (WM_USER + MAXSOCKETS - 1))
923 {
924 EnterCriticalSection(&critical);
925 socket = socketList[(uMsg - WM_USER)];
926 event = -1;
927 cback = NULL;
928 data = NULL;
929
930 /* Check that the socket still exists (it has not been
931 * destroyed) and for safety, check that the m_fd field
932 * is what we expect it to be.
933 */
934 if ((socket != NULL) && (socket->m_fd == wParam))
935 {
936 switch WSAGETSELECTEVENT(lParam)
937 {
938 case FD_READ: event = GSOCK_INPUT; break;
939 case FD_WRITE: event = GSOCK_OUTPUT; break;
940 case FD_ACCEPT: event = GSOCK_CONNECTION; break;
941 case FD_CONNECT:
942 {
943 if (WSAGETSELECTERROR(lParam) != 0)
944 event = GSOCK_LOST;
945 else
946 event = GSOCK_CONNECTION;
947 break;
948 }
949 case FD_CLOSE: event = GSOCK_LOST; break;
950 }
951
952 if (event != -1)
953 {
954 cback = socket->m_cbacks[event];
955 data = socket->m_data[event];
956
957 if (event == GSOCK_LOST)
958 socket->m_detected = GSOCK_LOST_FLAG;
959 else
960 socket->m_detected |= (1 << event);
961 }
962 }
963
964 /* OK, we can now leave the critical section because we have
965 * already obtained the callback address (we make no further
966 * accesses to socket->whatever). However, the app should
967 * be prepared to handle events from a socket that has just
968 * been closed!
969 */
970 LeaveCriticalSection(&critical);
971
972 if (cback != NULL)
973 (cback)(socket, event, data);
974
975 return (LRESULT) 0;
976 }
977 else
978 return DefWindowProc(hWnd, uMsg, wParam, lParam);
979 }
980
981
982 /* _GSocket_Input_Timeout:
983 * For blocking sockets, wait until data is available or
984 * until timeout ellapses.
985 */
986 GSocketError _GSocket_Input_Timeout(GSocket *socket)
987 {
988 fd_set readfds;
989
990 if (!socket->m_non_blocking)
991 {
992 FD_ZERO(&readfds);
993 FD_SET(socket->m_fd, &readfds);
994 if (select(0, &readfds, NULL, NULL, &socket->m_timeout) == 0)
995 {
996 socket->m_error = GSOCK_TIMEDOUT;
997 return GSOCK_TIMEDOUT;
998 }
999 }
1000 return GSOCK_NOERROR;
1001 }
1002
1003 /* _GSocket_Output_Timeout:
1004 * For blocking sockets, wait until data can be sent without
1005 * blocking or until timeout ellapses.
1006 */
1007 GSocketError _GSocket_Output_Timeout(GSocket *socket)
1008 {
1009 fd_set writefds;
1010
1011 if (!socket->m_non_blocking)
1012 {
1013 FD_ZERO(&writefds);
1014 FD_SET(socket->m_fd, &writefds);
1015 if (select(0, NULL, &writefds, NULL, &socket->m_timeout) == 0)
1016 {
1017 socket->m_error = GSOCK_TIMEDOUT;
1018 return GSOCK_TIMEDOUT;
1019 }
1020 }
1021 return GSOCK_NOERROR;
1022 }
1023
1024 /* _GSocket_Connect_Timeout:
1025 * For blocking sockets, wait until the connection is
1026 * established or fails, or until timeout ellapses.
1027 */
1028 GSocketError _GSocket_Connect_Timeout(GSocket *socket)
1029 {
1030 fd_set writefds;
1031 fd_set exceptfds;
1032
1033 if (!socket->m_non_blocking)
1034 {
1035 FD_ZERO(&writefds);
1036 FD_ZERO(&exceptfds);
1037 FD_SET(socket->m_fd, &writefds);
1038 FD_SET(socket->m_fd, &exceptfds);
1039 if (select(0, NULL, &writefds, &exceptfds, &socket->m_timeout) == 0)
1040 {
1041 socket->m_error = GSOCK_TIMEDOUT;
1042 return GSOCK_TIMEDOUT;
1043 }
1044 }
1045 if (!FD_ISSET(socket->m_fd, &writefds))
1046 {
1047 socket->m_error = GSOCK_IOERR;
1048 return GSOCK_IOERR;
1049 }
1050
1051 return GSOCK_NOERROR;
1052 }
1053
1054 int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size)
1055 {
1056 return recv(socket->m_fd, buffer, size, 0);
1057 }
1058
1059 int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size)
1060 {
1061 struct sockaddr from;
1062 SOCKLEN_T fromlen = sizeof(from);
1063 int ret;
1064 GSocketError err;
1065
1066 ret = recvfrom(socket->m_fd, buffer, size, 0, &from, &fromlen);
1067
1068 if (ret == SOCKET_ERROR)
1069 return SOCKET_ERROR;
1070
1071 /* Translate a system address into a GSocket address */
1072 if (!socket->m_peer)
1073 {
1074 socket->m_peer = GAddress_new();
1075 if (!socket->m_peer)
1076 {
1077 socket->m_error = GSOCK_MEMERR;
1078 return -1;
1079 }
1080 }
1081 err = _GAddress_translate_from(socket->m_peer, &from, fromlen);
1082 if (err != GSOCK_NOERROR)
1083 {
1084 GAddress_destroy(socket->m_peer);
1085 socket->m_peer = NULL;
1086 socket->m_error = err;
1087 return -1;
1088 }
1089
1090 return ret;
1091 }
1092
1093 int _GSocket_Send_Stream(GSocket *socket, const char *buffer, int size)
1094 {
1095 return send(socket->m_fd, buffer, size, 0);
1096 }
1097
1098 int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size)
1099 {
1100 struct sockaddr *addr;
1101 int len, ret;
1102 GSocketError err;
1103
1104 if (!socket->m_peer)
1105 {
1106 socket->m_error = GSOCK_INVADDR;
1107 return -1;
1108 }
1109
1110 err = _GAddress_translate_to(socket->m_peer, &addr, &len);
1111 if (err != GSOCK_NOERROR)
1112 {
1113 socket->m_error = err;
1114 return -1;
1115 }
1116
1117 ret = sendto(socket->m_fd, buffer, size, 0, addr, len);
1118
1119 /* Frees memory allocated by _GAddress_translate_to */
1120 free(addr);
1121
1122 return ret;
1123 }
1124
1125
1126 /*
1127 * -------------------------------------------------------------------------
1128 * GAddress
1129 * -------------------------------------------------------------------------
1130 */
1131
1132 /* CHECK_ADDRESS verifies that the current family is either GSOCK_NOFAMILY
1133 * or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it initalizes address
1134 * to be a GSOCK_*family*. In other cases, it returns GSOCK_INVADDR.
1135 */
1136 #define CHECK_ADDRESS(address, family, retval) \
1137 { \
1138 if (address->m_family == GSOCK_NOFAMILY) \
1139 if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \
1140 return address->m_error; \
1141 if (address->m_family != GSOCK_##family) \
1142 { \
1143 address->m_error = GSOCK_INVADDR; \
1144 return retval; \
1145 } \
1146 }
1147
1148 GAddress *GAddress_new()
1149 {
1150 GAddress *address;
1151
1152 if ((address = (GAddress *) malloc(sizeof(GAddress))) == NULL)
1153 return NULL;
1154
1155 address->m_family = GSOCK_NOFAMILY;
1156 address->m_addr = NULL;
1157 address->m_len = 0;
1158
1159 return address;
1160 }
1161
1162 GAddress *GAddress_copy(GAddress *address)
1163 {
1164 GAddress *addr2;
1165
1166 assert(address != NULL);
1167
1168 if ((addr2 = (GAddress *) malloc(sizeof(GAddress))) == NULL)
1169 return NULL;
1170
1171 memcpy(addr2, address, sizeof(GAddress));
1172
1173 if (address->m_addr)
1174 {
1175 addr2->m_addr = (struct sockaddr *) malloc(addr2->m_len);
1176 if (addr2->m_addr == NULL)
1177 {
1178 free(addr2);
1179 return NULL;
1180 }
1181 memcpy(addr2->m_addr, address->m_addr, addr2->m_len);
1182 }
1183
1184 return addr2;
1185 }
1186
1187 void GAddress_destroy(GAddress *address)
1188 {
1189 assert(address != NULL);
1190
1191 free(address);
1192 }
1193
1194 void GAddress_SetFamily(GAddress *address, GAddressType type)
1195 {
1196 assert(address != NULL);
1197
1198 address->m_family = type;
1199 }
1200
1201 GAddressType GAddress_GetFamily(GAddress *address)
1202 {
1203 assert(address != NULL);
1204
1205 return address->m_family;
1206 }
1207
1208 GSocketError _GAddress_translate_from(GAddress *address,
1209 struct sockaddr *addr, int len)
1210 {
1211 address->m_realfamily = addr->sa_family;
1212 switch (addr->sa_family)
1213 {
1214 case AF_INET:
1215 address->m_family = GSOCK_INET;
1216 break;
1217 case AF_UNIX:
1218 address->m_family = GSOCK_UNIX;
1219 break;
1220 #ifdef AF_INET6
1221 case AF_INET6:
1222 address->m_family = GSOCK_INET6;
1223 break;
1224 #endif
1225 default:
1226 {
1227 address->m_error = GSOCK_INVOP;
1228 return GSOCK_INVOP;
1229 }
1230 }
1231
1232 if (address->m_addr)
1233 free(address->m_addr);
1234
1235 address->m_len = len;
1236 address->m_addr = (struct sockaddr *) malloc(len);
1237
1238 if (address->m_addr == NULL)
1239 {
1240 address->m_error = GSOCK_MEMERR;
1241 return GSOCK_MEMERR;
1242 }
1243 memcpy(address->m_addr, addr, len);
1244
1245 return GSOCK_NOERROR;
1246 }
1247
1248 GSocketError _GAddress_translate_to(GAddress *address,
1249 struct sockaddr **addr, int *len)
1250 {
1251 if (!address->m_addr)
1252 {
1253 address->m_error = GSOCK_INVADDR;
1254 return GSOCK_INVADDR;
1255 }
1256
1257 *len = address->m_len;
1258 *addr = (struct sockaddr *) malloc(address->m_len);
1259 if (*addr == NULL)
1260 {
1261 address->m_error = GSOCK_MEMERR;
1262 return GSOCK_MEMERR;
1263 }
1264
1265 memcpy(*addr, address->m_addr, address->m_len);
1266 return GSOCK_NOERROR;
1267 }
1268
1269 /*
1270 * -------------------------------------------------------------------------
1271 * Internet address family
1272 * -------------------------------------------------------------------------
1273 */
1274
1275 GSocketError _GAddress_Init_INET(GAddress *address)
1276 {
1277 address->m_len = sizeof(struct sockaddr_in);
1278 address->m_addr = (struct sockaddr *) malloc(address->m_len);
1279 if (address->m_addr == NULL)
1280 {
1281 address->m_error = GSOCK_MEMERR;
1282 return GSOCK_MEMERR;
1283 }
1284
1285 address->m_family = GSOCK_INET;
1286 address->m_realfamily = PF_INET;
1287 ((struct sockaddr_in *)address->m_addr)->sin_family = AF_INET;
1288 ((struct sockaddr_in *)address->m_addr)->sin_addr.s_addr = INADDR_ANY;
1289
1290 return GSOCK_NOERROR;
1291 }
1292
1293 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname)
1294 {
1295 struct hostent *he;
1296 struct in_addr *addr;
1297
1298 assert(address != NULL);
1299
1300 CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
1301
1302 addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr);
1303
1304 addr->s_addr = inet_addr(hostname);
1305
1306 /* If it is a numeric host name, convert it now */
1307 if (addr->s_addr == INADDR_NONE)
1308 {
1309 struct in_addr *array_addr;
1310
1311 /* It is a real name, we solve it */
1312 if ((he = gethostbyname(hostname)) == NULL)
1313 {
1314 /* addr->s_addr = INADDR_NONE just done by inet_addr() above */
1315 address->m_error = GSOCK_NOHOST;
1316 return GSOCK_NOHOST;
1317 }
1318 array_addr = (struct in_addr *) *(he->h_addr_list);
1319 addr->s_addr = array_addr[0].s_addr;
1320 }
1321 return GSOCK_NOERROR;
1322 }
1323
1324 GSocketError GAddress_INET_SetAnyAddress(GAddress *address)
1325 {
1326 return GAddress_INET_SetHostAddress(address, INADDR_ANY);
1327 }
1328
1329 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
1330 unsigned long hostaddr)
1331 {
1332 struct in_addr *addr;
1333
1334 assert(address != NULL);
1335
1336 CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
1337
1338 addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr);
1339 addr->s_addr = hostaddr;
1340
1341 return GSOCK_NOERROR;
1342 }
1343
1344 GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
1345 const char *protocol)
1346 {
1347 struct servent *se;
1348 struct sockaddr_in *addr;
1349
1350 assert(address != NULL);
1351 CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
1352
1353 if (!port)
1354 {
1355 address->m_error = GSOCK_INVPORT;
1356 return GSOCK_INVPORT;
1357 }
1358
1359 se = getservbyname(port, protocol);
1360 if (!se)
1361 {
1362 if (isdigit(port[0]))
1363 {
1364 int port_int;
1365
1366 port_int = atoi(port);
1367 addr = (struct sockaddr_in *)address->m_addr;
1368 addr->sin_port = htons((u_short) port_int);
1369 return GSOCK_NOERROR;
1370 }
1371
1372 address->m_error = GSOCK_INVPORT;
1373 return GSOCK_INVPORT;
1374 }
1375
1376 addr = (struct sockaddr_in *)address->m_addr;
1377 addr->sin_port = se->s_port;
1378
1379 return GSOCK_NOERROR;
1380 }
1381
1382 GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port)
1383 {
1384 struct sockaddr_in *addr;
1385
1386 assert(address != NULL);
1387 CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
1388
1389 addr = (struct sockaddr_in *)address->m_addr;
1390 addr->sin_port = htons(port);
1391
1392 return GSOCK_NOERROR;
1393 }
1394
1395 GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname, size_t sbuf)
1396 {
1397 struct hostent *he;
1398 char *addr_buf;
1399 struct sockaddr_in *addr;
1400
1401 assert(address != NULL);
1402 CHECK_ADDRESS(address, INET, GSOCK_INVADDR);
1403
1404 addr = (struct sockaddr_in *)address->m_addr;
1405 addr_buf = (char *)&(addr->sin_addr);
1406
1407 he = gethostbyaddr(addr_buf, sizeof(addr->sin_addr), AF_INET);
1408 if (he == NULL)
1409 {
1410 address->m_error = GSOCK_NOHOST;
1411 return GSOCK_NOHOST;
1412 }
1413
1414 strncpy(hostname, he->h_name, sbuf);
1415
1416 return GSOCK_NOERROR;
1417 }
1418
1419 unsigned long GAddress_INET_GetHostAddress(GAddress *address)
1420 {
1421 struct sockaddr_in *addr;
1422
1423 assert(address != NULL);
1424 CHECK_ADDRESS(address, INET, 0);
1425
1426 addr = (struct sockaddr_in *)address->m_addr;
1427
1428 return addr->sin_addr.s_addr;
1429 }
1430
1431 unsigned short GAddress_INET_GetPort(GAddress *address)
1432 {
1433 struct sockaddr_in *addr;
1434
1435 assert(address != NULL);
1436 CHECK_ADDRESS(address, INET, 0);
1437
1438 addr = (struct sockaddr_in *)address->m_addr;
1439 return ntohs(addr->sin_port);
1440 }
1441
1442 /*
1443 * -------------------------------------------------------------------------
1444 * Unix address family
1445 * -------------------------------------------------------------------------
1446 */
1447
1448 GSocketError _GAddress_Init_UNIX(GAddress *address)
1449 {
1450 assert (address != NULL);
1451 address->m_error = GSOCK_INVADDR;
1452 return GSOCK_INVADDR;
1453 }
1454
1455 GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path)
1456 {
1457 assert (address != NULL);
1458 address->m_error = GSOCK_INVADDR;
1459 return GSOCK_INVADDR;
1460 }
1461
1462 GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf)
1463 {
1464 assert (address != NULL);
1465 address->m_error = GSOCK_INVADDR;
1466 return GSOCK_INVADDR;
1467 }
1468
1469 #else /* !wxUSE_SOCKETS */
1470
1471 /*
1472 * Translation unit shouldn't be empty, so include this typedef to make the
1473 * compiler (VC++ 6.0, for example) happy
1474 */
1475 typedef (*wxDummy)();
1476
1477 #endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */