X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9bbd7ba3ea5befa691bcbab81c25cfaceac079cd..d4aa3a4b860a70c27421411fbc778fc5914f1815:/src/msw/gsocket.c?ds=inline diff --git a/src/msw/gsocket.c b/src/msw/gsocket.c index a4f45084d8..fca515b420 100644 --- a/src/msw/gsocket.c +++ b/src/msw/gsocket.c @@ -1,19 +1,28 @@ /* ------------------------------------------------------------------------- - * Project: GSocket (Generic Socket) for WX + * Project: GSocket (Generic Socket) * Name: gsocket.c + * Author: Guillermo Rodriguez Garcia * Purpose: GSocket main MSW file * CVSID: $Id$ * ------------------------------------------------------------------------- */ +/* + * PLEASE don't put C++ comments here - this is a C source file. + */ -#ifdef __WXMSW__ - +#ifndef __GSOCKET_STANDALONE__ #include "wx/setup.h" +#endif + +#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) + +#ifndef __GSOCKET_STANDALONE__ + #include "wx/msw/gsockmsw.h" #include "wx/gsocket.h" -#define INSTANCE wxhInstance +#define INSTANCE wxGetInstance() #else @@ -24,13 +33,11 @@ * be available and it must containt the app's instance * handle. */ -#define INSTANCE hInst +#define INSTANCE hInst -#endif /* __WXMSW__ */ +#endif /* __GSOCKET_STANDALONE__ */ -#if !defined(__WXMSW__) || (defined(__WXMSW__) && wxUSE_SOCKETS) - #include #include #include @@ -99,7 +106,6 @@ bool GSocket_Init() } firstAvailable = 0; - /* Initialize WinSocket */ return (WSAStartup((1 << 8) | 1, &wsaData) == 0); } @@ -107,7 +113,7 @@ bool GSocket_Init() void GSocket_Cleanup() { /* Destroy internal window */ - DestroyWindow(WINDOWNAME); + DestroyWindow(hWin); UnregisterClass(CLASSNAME, INSTANCE); /* Delete critical section */ @@ -117,7 +123,7 @@ void GSocket_Cleanup() WSACleanup(); } -/* Constructors / Destructors */ +/* Constructors / Destructors for GSocket */ GSocket *GSocket_new() { @@ -132,14 +138,15 @@ GSocket *GSocket_new() { socket->m_cbacks[i] = NULL; } - socket->m_local = NULL; - socket->m_peer = NULL; + socket->m_local = NULL; + socket->m_peer = NULL; socket->m_error = GSOCK_NOERROR; - socket->m_server = FALSE; + socket->m_server = FALSE; socket->m_stream = TRUE; socket->m_non_blocking = FALSE; socket->m_timeout.tv_sec = 10 * 60; /* 10 minutes */ - socket->m_timeout.tv_usec = 0; + socket->m_timeout.tv_usec = 0; + socket->m_detected = 0; /* Allocate a new message number for this socket */ EnterCriticalSection(&critical); @@ -169,65 +176,80 @@ void GSocket_destroy(GSocket *socket) { assert(socket != NULL); - /* We don't want more event notifications; so first of all we - * remove the socket from the list (NOTE: we won't get a CLOSE - * event for this socket if it wasn't closed before). - */ + /* Remove the socket from the list */ EnterCriticalSection(&critical); socketList[(socket->m_msgnumber - WM_USER)] = NULL; LeaveCriticalSection(&critical); - /* We check that the socket is really shutdowned */ + /* Check that the socket is really shutdowned */ if (socket->m_fd != INVALID_SOCKET) GSocket_Shutdown(socket); - /* We destroy private addresses */ + /* Destroy private addresses */ if (socket->m_local) GAddress_destroy(socket->m_local); if (socket->m_peer) GAddress_destroy(socket->m_peer); - /* We destroy socket itself */ + /* Destroy the socket itself */ free(socket); } +/* GSocket_Shutdown: + * Disallow further read/write operations on this socket, close + * the fd and disable all callbacks. + */ void GSocket_Shutdown(GSocket *socket) { int evt; assert(socket != NULL); - /* If socket has been created, we shutdown it */ + /* If socket has been created, shutdown it */ if (socket->m_fd != INVALID_SOCKET) { - /* TODO: Guilhem only does this for connection oriented sockets (?) */ shutdown(socket->m_fd, 2); closesocket(socket->m_fd); socket->m_fd = INVALID_SOCKET; } - /* We disable GUI callbacks */ + /* Disable GUI callbacks */ for (evt = 0; evt < GSOCK_MAX_EVENT; evt++) - { socket->m_cbacks[evt] = NULL; - } - _GSocket_Configure_Callbacks(socket); + socket->m_detected = 0; + _GSocket_Disable_Events(socket); } /* Address handling */ +/* GSocket_SetLocal: + * GSocket_GetLocal: + * GSocket_SetPeer: + * GSocket_GetPeer: + * Set or get the local or peer address for this socket. The 'set' + * functions return GSOCK_NOERROR on success, an error code otherwise. + * The 'get' functions return a pointer to a GAddress object on success, + * or NULL otherwise, in which case they set the error code of the + * corresponding GSocket. + * + * Error codes: + * GSOCK_INVSOCK - the socket is not valid. + * GSOCK_INVADDR - the address is not valid. + */ GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address) { assert(socket != NULL); + /* the socket must be initialized, or it must be a server */ if (socket->m_fd != INVALID_SOCKET && !socket->m_server) { socket->m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } + /* check address */ if (address == NULL || address->m_family == GSOCK_NOFAMILY) { socket->m_error = GSOCK_INVADDR; @@ -246,6 +268,7 @@ GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address) { assert(socket != NULL); + /* check address */ if (address == NULL || address->m_family == GSOCK_NOFAMILY) { socket->m_error = GSOCK_INVADDR; @@ -264,37 +287,39 @@ GAddress *GSocket_GetLocal(GSocket *socket) { GAddress *address; struct sockaddr addr; - SOCKLEN_T size; + SOCKLEN_T size = sizeof(addr); + GSocketError err; assert(socket != NULL); + /* try to get it from the m_local var first */ if (socket->m_local) return GAddress_copy(socket->m_local); + /* else, if the socket is initialized, try getsockname */ if (socket->m_fd == INVALID_SOCKET) { socket->m_error = GSOCK_INVSOCK; return NULL; } - size = sizeof(addr); - if (getsockname(socket->m_fd, &addr, &size) == SOCKET_ERROR) { socket->m_error = GSOCK_IOERR; return NULL; } - address = GAddress_new(); - if (address == NULL) + /* got a valid address from getsockname, create a GAddress object */ + if ((address = GAddress_new()) == NULL) { socket->m_error = GSOCK_MEMERR; return NULL; } - if (_GAddress_translate_from(address, &addr, size) != GSOCK_NOERROR) + + if ((err = _GAddress_translate_from(address, &addr, size)) != GSOCK_NOERROR) { - socket->m_error = GSOCK_MEMERR; GAddress_destroy(address); + socket->m_error = err; return NULL; } @@ -305,6 +330,7 @@ GAddress *GSocket_GetPeer(GSocket *socket) { assert(socket != NULL); + /* try to get it from the m_peer var */ if (socket->m_peer) return GAddress_copy(socket->m_peer); @@ -314,11 +340,14 @@ GAddress *GSocket_GetPeer(GSocket *socket) /* Server specific parts */ /* GSocket_SetServer: - * Sets up the socket as a server. It uses the "Local" field of GSocket. - * "Local" must be set by GSocket_SetLocal() before GSocket_SetServer() - * is called. Possible error codes are: GSOCK_INVSOCK if socket has not - * been initialized, GSOCK_INVADDR if the local address has not been - * defined and GSOCK_IOERR for other internal errors. + * Sets up this socket as a server. The local address must have been + * set with GSocket_SetLocal() before GSocket_SetServer() is called. + * Returns GSOCK_NOERROR on success, one of the following otherwise: + * + * Error codes: + * GSOCK_INVSOCK - the socket is in use. + * GSOCK_INVADDR - the local address has not been set. + * GSOCK_IOERR - low-level error. */ GSocketError GSocket_SetServer(GSocket *sck) { @@ -326,12 +355,14 @@ GSocketError GSocket_SetServer(GSocket *sck) assert(sck != NULL); + /* must not be in use */ if (sck->m_fd != INVALID_SOCKET) { sck->m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } + /* the local addr must have been set */ if (!sck->m_local) { sck->m_error = GSOCK_INVADDR; @@ -345,7 +376,6 @@ GSocketError GSocket_SetServer(GSocket *sck) /* Create the socket */ sck->m_fd = socket(sck->m_local->m_realfamily, SOCK_STREAM, 0); - ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg); if (sck->m_fd == INVALID_SOCKET) { @@ -353,17 +383,18 @@ GSocketError GSocket_SetServer(GSocket *sck) return GSOCK_IOERR; } - /* Bind the socket to the LOCAL address */ - if (bind(sck->m_fd, sck->m_local->m_addr, sck->m_local->m_len) != 0) - { - closesocket(sck->m_fd); - sck->m_fd = INVALID_SOCKET; - sck->m_error = GSOCK_IOERR; - return GSOCK_IOERR; - } + ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg); + _GSocket_Enable_Events(sck); - /* Enable listening up to 5 connections */ - if (listen(sck->m_fd, 5) != 0) + /* Bind to the local address, + * retrieve the actual address bound, + * and listen up to 5 connections. + */ + if ((bind(sck->m_fd, sck->m_local->m_addr, sck->m_local->m_len) != 0) || + (getsockname(sck->m_fd, + sck->m_local->m_addr, + &sck->m_local->m_len) != 0) || + (listen(sck->m_fd, 5) != 0)) { closesocket(sck->m_fd); sck->m_fd = INVALID_SOCKET; @@ -372,18 +403,33 @@ GSocketError GSocket_SetServer(GSocket *sck) } return GSOCK_NOERROR; -} +} /* GSocket_WaitConnection: - * Waits for an incoming client connection. + * Waits for an incoming client connection. Returns a pointer to + * a GSocket object, or NULL if there was an error, in which case + * the last error field will be updated for the calling GSocket. + * + * Error codes (set in the calling GSocket) + * GSOCK_INVSOCK - the socket is not valid or not a server. + * GSOCK_TIMEDOUT - timeout, no incoming connections. + * GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking. + * GSOCK_MEMERR - couldn't allocate memory. + * GSOCK_IOERR - low-level error. */ GSocket *GSocket_WaitConnection(GSocket *sck) { GSocket *connection; + struct sockaddr from; + SOCKLEN_T fromlen = sizeof(from); + GSocketError err; u_long arg = 1; assert(sck != NULL); + /* Reenable CONNECTION events */ + sck->m_detected &= ~GSOCK_CONNECTION_FLAG; + /* If the socket has already been created, we exit immediately */ if (sck->m_fd == INVALID_SOCKET || !sck->m_server) { @@ -408,13 +454,16 @@ GSocket *GSocket_WaitConnection(GSocket *sck) return NULL; } - connection->m_fd = accept(sck->m_fd, NULL, NULL); - ioctlsocket(connection->m_fd, FIONBIO, (u_long FAR *) &arg); + connection->m_fd = accept(sck->m_fd, &from, &fromlen); if (connection->m_fd == INVALID_SOCKET) { + if (WSAGetLastError() == WSAEWOULDBLOCK) + sck->m_error = GSOCK_WOULDBLOCK; + else + sck->m_error = GSOCK_IOERR; + GSocket_destroy(connection); - sck->m_error = GSOCK_IOERR; return NULL; } @@ -423,37 +472,84 @@ GSocket *GSocket_WaitConnection(GSocket *sck) connection->m_stream = TRUE; connection->m_oriented = TRUE; + /* Setup the peer address field */ + connection->m_peer = GAddress_new(); + if (!connection->m_peer) + { + GSocket_destroy(connection); + sck->m_error = GSOCK_MEMERR; + return NULL; + } + err = _GAddress_translate_from(connection->m_peer, &from, fromlen); + if (err != GSOCK_NOERROR) + { + GAddress_destroy(connection->m_peer); + GSocket_destroy(connection); + sck->m_error = err; + return NULL; + } + + ioctlsocket(connection->m_fd, FIONBIO, (u_long FAR *) &arg); + _GSocket_Enable_Events(connection); + return connection; } -/* Non oriented connections */ +/* Client specific parts */ -GSocketError GSocket_SetNonOriented(GSocket *sck) +/* GSocket_Connect: + * For stream (connection oriented) sockets, GSocket_Connect() tries + * to establish a client connection to a server using the peer address + * as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the + * connection has been succesfully established, or one of the error + * codes listed below. Note that for nonblocking sockets, a return + * value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection + * request can be completed later; you should use GSocket_Select() + * to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the + * corresponding asynchronous events. + * + * For datagram (non connection oriented) sockets, GSocket_Connect() + * just sets the peer address established with GSocket_SetPeer() as + * default destination. + * + * Error codes: + * GSOCK_INVSOCK - the socket is in use or not valid. + * GSOCK_INVADDR - the peer address has not been established. + * GSOCK_TIMEDOUT - timeout, the connection failed. + * GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only) + * GSOCK_MEMERR - couldn't allocate memory. + * GSOCK_IOERR - low-level error. + */ +GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream) { + int ret, err; u_long arg = 1; assert(sck != NULL); + /* Enable CONNECTION events (needed for nonblocking connections) */ + sck->m_detected &= ~GSOCK_CONNECTION_FLAG; + if (sck->m_fd != INVALID_SOCKET) { sck->m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } - if (!sck->m_local) + if (!sck->m_peer) { sck->m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } - /* Initialize all fields */ - sck->m_stream = FALSE; + /* Streamed or dgram socket? */ + sck->m_stream = (stream == GSOCK_STREAMED); + sck->m_oriented = TRUE; sck->m_server = FALSE; - sck->m_oriented = FALSE; /* Create the socket */ - sck->m_fd = socket(sck->m_local->m_realfamily, SOCK_DGRAM, 0); - ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg); + sck->m_fd = socket(sck->m_peer->m_realfamily, + sck->m_stream? SOCK_STREAM : SOCK_DGRAM, 0); if (sck->m_fd == INVALID_SOCKET) { @@ -461,46 +557,75 @@ GSocketError GSocket_SetNonOriented(GSocket *sck) return GSOCK_IOERR; } - /* Bind it to the LOCAL address */ - if (bind(sck->m_fd, sck->m_local->m_addr, sck->m_local->m_len) != 0) + ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg); + _GSocket_Enable_Events(sck); + + /* Connect it to the peer address, with a timeout (see below) */ + ret = connect(sck->m_fd, sck->m_peer->m_addr, sck->m_peer->m_len); + + if (ret == SOCKET_ERROR) { - closesocket(sck->m_fd); - sck->m_fd = INVALID_SOCKET; - sck->m_error = GSOCK_IOERR; - return GSOCK_IOERR; - } + err = WSAGetLastError(); - return GSOCK_NOERROR; -} + /* If connect failed with EWOULDBLOCK and the GSocket object + * is in blocking mode, we select() for the specified timeout + * checking for writability to see if the connection request + * completes. + */ + if ((err == WSAEWOULDBLOCK) && (!sck->m_non_blocking)) + { + err = _GSocket_Connect_Timeout(sck); -GSocketError GSocket_SetBroadcast(GSocket *sck) -{ - BOOL b; + if (err != GSOCK_NOERROR) + { + closesocket(sck->m_fd); + sck->m_fd = INVALID_SOCKET; + /* sck->m_error is set in _GSocket_Connect_Timeout */ + } - assert(sck != NULL); + return err; + } - if (GSocket_SetNonOriented(sck) != GSOCK_NOERROR) - return sck->m_error; + /* If connect failed with EWOULDBLOCK and the GSocket object + * is set to nonblocking, we set m_error to GSOCK_WOULDBLOCK + * (and return GSOCK_WOULDBLOCK) but we don't close the socket; + * this way if the connection completes, a GSOCK_CONNECTION + * event will be generated, if enabled. + */ + if ((err == WSAEWOULDBLOCK) && (sck->m_non_blocking)) + { + sck->m_error = GSOCK_WOULDBLOCK; + return GSOCK_WOULDBLOCK; + } - b = TRUE; - setsockopt(sck->m_fd, SOL_SOCKET, SO_BROADCAST, (const char FAR *) &b, sizeof(b)); + /* If connect failed with an error other than EWOULDBLOCK, + * then the call to GSocket_Connect() has failed. + */ + closesocket(sck->m_fd); + sck->m_fd = INVALID_SOCKET; + sck->m_error = GSOCK_IOERR; + return GSOCK_IOERR; + } return GSOCK_NOERROR; } -/* Client specific parts */ +/* Datagram sockets */ -/* GSocket_Connect: - * Establishes a client connection to a server using the "Peer" - * field of GSocket. "Peer" must be set by GSocket_SetPeer() before - * GSocket_Connect() is called. Possible error codes are GSOCK_INVSOCK - * if the socket is alredy in use, GSOCK_INVADDR if the peer address - * has not been set, or GSOCK_IOERR for other internal errors. +/* GSocket_SetNonOriented: + * Sets up this socket as a non-connection oriented (datagram) socket. + * Before using this function, the local address must have been set + * with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR + * on success, or one of the following otherwise. + * + * Error codes: + * GSOCK_INVSOCK - the socket is in use. + * GSOCK_INVADDR - the local address has not been set. + * GSOCK_IOERR - low-level error. */ -GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream) +GSocketError GSocket_SetNonOriented(GSocket *sck) { u_long arg = 1; - int type, ret; assert(sck != NULL); @@ -510,25 +635,19 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream) return GSOCK_INVSOCK; } - if (!sck->m_peer) + if (!sck->m_local) { sck->m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } - /* Test whether we want the socket to be a stream (e.g. TCP) */ - sck->m_stream = (stream == GSOCK_STREAMED); - sck->m_oriented = TRUE; + /* Initialize all fields */ + sck->m_stream = FALSE; sck->m_server = FALSE; - - if (sck->m_stream) - type = SOCK_STREAM; - else - type = SOCK_DGRAM; + sck->m_oriented = FALSE; /* Create the socket */ - sck->m_fd = socket(sck->m_peer->m_realfamily, type, 0); - ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg); + sck->m_fd = socket(sck->m_local->m_realfamily, SOCK_DGRAM, 0); if (sck->m_fd == INVALID_SOCKET) { @@ -536,64 +655,71 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream) return GSOCK_IOERR; } - /* Connect it to the PEER address, with a timeout */ - ret = connect(sck->m_fd, sck->m_peer->m_addr, sck->m_peer->m_len); + ioctlsocket(sck->m_fd, FIONBIO, (u_long FAR *) &arg); + _GSocket_Enable_Events(sck); - if (ret == SOCKET_ERROR) + /* Bind to the local address, + * and retrieve the actual address bound. + */ + if ((bind(sck->m_fd, sck->m_local->m_addr, sck->m_local->m_len) != 0) || + (getsockname(sck->m_fd, + sck->m_local->m_addr, + &sck->m_local->m_len) != 0)) { - /* For blocking GSockets, if connect fails with an EWOULDBLOCK - * error, then we can select() the socket for the specified - * timeout and check for writability to see if the connection - * request completes. If the error is different than EWOULDBLOCK, - * or if the socket is nonblocking, the call to GSocket_Connect() - * has failed. - */ - if ((!sck->m_non_blocking) && (WSAGetLastError() == WSAEWOULDBLOCK)) - { - if (_GSocket_Output_Timeout(sck) == GSOCK_TIMEDOUT) - { - closesocket(sck->m_fd); - sck->m_fd = INVALID_SOCKET; - /* sck->m_error is set in _GSocket_Input_Timeout */ - return GSOCK_TIMEDOUT; - } - } - else /* error */ - { - closesocket(sck->m_fd); - sck->m_fd = INVALID_SOCKET; - sck->m_error = GSOCK_IOERR; - return GSOCK_IOERR; - } + closesocket(sck->m_fd); + sck->m_fd = INVALID_SOCKET; + sck->m_error = GSOCK_IOERR; + return GSOCK_IOERR; } return GSOCK_NOERROR; } + /* Generic IO */ /* Like recv(), send(), ... */ int GSocket_Read(GSocket *socket, char *buffer, int size) { + int ret; + assert(socket != NULL); + /* Reenable INPUT events */ + socket->m_detected &= ~GSOCK_INPUT_FLAG; + if (socket->m_fd == INVALID_SOCKET || socket->m_server) { socket->m_error = GSOCK_INVSOCK; return -1; } + /* If the socket is blocking, wait for data (with a timeout) */ if (_GSocket_Input_Timeout(socket) == GSOCK_TIMEDOUT) return -1; + /* Read the data */ if (socket->m_stream) - return _GSocket_Recv_Stream(socket, buffer, size); + ret = _GSocket_Recv_Stream(socket, buffer, size); else - return _GSocket_Recv_Dgram(socket, buffer, size); + ret = _GSocket_Recv_Dgram(socket, buffer, size); + + if (ret == SOCKET_ERROR) + { + if (WSAGetLastError() != WSAEWOULDBLOCK) + socket->m_error = GSOCK_IOERR; + else + socket->m_error = GSOCK_WOULDBLOCK; + return -1; + } + + return ret; } int GSocket_Write(GSocket *socket, const char *buffer, int size) { + int ret; + assert(socket != NULL); if (socket->m_fd == INVALID_SOCKET || socket->m_server) @@ -602,44 +728,54 @@ int GSocket_Write(GSocket *socket, const char *buffer, int size) return -1; } + /* If the socket is blocking, wait for writability (with a timeout) */ if (_GSocket_Output_Timeout(socket) == GSOCK_TIMEDOUT) return -1; + /* Write the data */ if (socket->m_stream) - return _GSocket_Send_Stream(socket, buffer, size); + ret = _GSocket_Send_Stream(socket, buffer, size); else - return _GSocket_Send_Dgram(socket, buffer, size); -} - -bool GSocket_DataAvailable(GSocket *socket) -{ - fd_set read_set; - struct timeval tv; - - assert(socket != NULL); + ret = _GSocket_Send_Dgram(socket, buffer, size); - if (socket->m_fd == INVALID_SOCKET || socket->m_server) + if (ret == SOCKET_ERROR) { - socket->m_error = GSOCK_INVSOCK; - return FALSE; - } + if (WSAGetLastError() != WSAEWOULDBLOCK) + socket->m_error = GSOCK_IOERR; + else + socket->m_error = GSOCK_WOULDBLOCK; - FD_ZERO(&read_set); - FD_SET(socket->m_fd, &read_set); + /* Only reenable OUTPUT events after an error (just like WSAAsyncSelect + * does). Once the first OUTPUT event is received, users can assume + * that the socket is writable until a read operation fails. Only then + * will further OUTPUT events be posted. + */ + socket->m_detected &= ~GSOCK_OUTPUT_FLAG; + return -1; + } - tv.tv_sec = 0; - tv.tv_usec = 0; + return ret; +} - select(socket->m_fd + 1, &read_set, NULL, NULL, &tv); +/* GSocket_Select: + * Polls the socket to determine its status. This function will + * check for the events specified in the 'flags' parameter, and + * it will return a mask indicating which operations can be + * performed. This function won't block, regardless of the + * mode (blocking | nonblocking) of the socket. + */ +GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags) +{ + assert(socket != NULL); - return FD_ISSET(socket->m_fd, &read_set); + return (flags & socket->m_detected); } -/* Flags */ +/* Attributes */ /* GSocket_SetNonBlocking: - * Sets the socket in non-blocking mode. This is useful if - * we don't want to wait. + * Sets the socket to non-blocking mode. All IO calls will return + * immediately. */ void GSocket_SetNonBlocking(GSocket *socket, bool non_block) { @@ -649,17 +785,21 @@ void GSocket_SetNonBlocking(GSocket *socket, bool non_block) } /* GSocket_SetTimeout: + * Sets the timeout for blocking calls. Time is expressed in + * milliseconds. */ -void GSocket_SetTimeout(GSocket *socket, unsigned long millisecs) +void GSocket_SetTimeout(GSocket *socket, unsigned long millis) { assert(socket != NULL); - socket->m_timeout.tv_sec = (millisecs / 1000); - socket->m_timeout.tv_usec = (millisecs % 1000) * 1000; + socket->m_timeout.tv_sec = (millis / 1000); + socket->m_timeout.tv_usec = (millis % 1000) * 1000; } /* GSocket_GetError: - * Returns the last error occured for this socket. + * Returns the last error occured for this socket. Note that successful + * operations do not clear this back to GSOCK_NOERROR, so use it only + * after an error. */ GSocketError GSocket_GetError(GSocket *socket) { @@ -668,99 +808,107 @@ GSocketError GSocket_GetError(GSocket *socket) return socket->m_error; } + /* Callbacks */ -/* Only one callback is possible for each event (INPUT, OUTPUT, CONNECTION - * and LOST). The callbacks are called in the following situations: - * - * INPUT: There is at least one byte in the input buffer - * OUTPUT: The system is sure that the next write call will not block - * CONNECTION: Two cases are possible: - * Client socket -> the connection is established - * Server socket -> a client requests a connection - * LOST: The connection is lost - * - * An event is generated only once and its state is reseted when the - * relative IO call is requested. - * For example: INPUT -> GSocket_Read() - * CONNECTION -> GSocket_Accept() +/* GSOCK_INPUT: + * There is data to be read in the input buffer. If, after a read + * operation, there is still data available, the callback function will + * be called again. + * GSOCK_OUTPUT: + * The socket is available for writing. That is, the next write call + * won't block. This event is generated only once, when the connection is + * first established, and then only if a call failed with GSOCK_WOULDBLOCK, + * when the output buffer empties again. This means that the app should + * assume that it can write since the first OUTPUT event, and no more + * OUTPUT events will be generated unless an error occurs. + * GSOCK_CONNECTION: + * Connection succesfully established, for client sockets, or incoming + * client connection, for server sockets. Wait for this event (also watch + * out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call. + * GSOCK_LOST: + * The connection is lost (or a connection request failed); this could + * be due to a failure, or due to the peer closing it gracefully. */ /* GSocket_SetCallback: - * Enables the callbacks specified by 'event'. Note that 'event' + * Enables the callbacks specified by 'flags'. Note that 'flags' * may be a combination of flags OR'ed toghether, so the same * callback function can be made to accept different events. * The callback function must have the following prototype: * * void function(GSocket *socket, GSocketEvent event, char *cdata) */ -void GSocket_SetCallback(GSocket *socket, GSocketEventFlags event, +void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags, GSocketCallback callback, char *cdata) { int count; - assert (socket != NULL); + assert(socket != NULL); for (count = 0; count < GSOCK_MAX_EVENT; count++) { - /* We test each flag and enable the corresponding events */ - if ((event & (1 << count)) != 0) + if ((flags & (1 << count)) != 0) { socket->m_cbacks[count] = callback; socket->m_data[count] = cdata; } } - - _GSocket_Configure_Callbacks(socket); } /* GSocket_UnsetCallback: - * Disables all callbacks specified by 'event', which may be a + * Disables all callbacks specified by 'flags', which may be a * combination of flags OR'ed toghether. */ -void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags event) +void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags) { - int count = 0; + int count; assert(socket != NULL); for (count = 0; count < GSOCK_MAX_EVENT; count++) { - /* We test each flag and disable the corresponding events */ - if ((event & (1 << count)) != 0) + if ((flags & (1 << count)) != 0) { socket->m_cbacks[count] = NULL; + socket->m_data[count] = NULL; } } - - _GSocket_Configure_Callbacks(socket); } /* Internals */ -void _GSocket_Configure_Callbacks(GSocket *socket) +/* _GSocket_Enable_Events: + * Enable all event notifications; we need to be notified of all + * events for internal processing, but we will only notify users + * when an appropiate callback function has been installed. + */ +void _GSocket_Enable_Events(GSocket *socket) { - long mask = 0; - int count; + assert (socket != NULL); - for (count = 0; count < GSOCK_MAX_EVENT; count++) + if (socket->m_fd != INVALID_SOCKET) { - if (socket->m_cbacks[count] != NULL) - { - switch (count) - { - case GSOCK_INPUT: mask |= FD_READ; break; - case GSOCK_OUTPUT: mask |= FD_WRITE; break; - case GSOCK_CONNECTION: mask |= (FD_ACCEPT | FD_CONNECT); break; - case GSOCK_LOST: mask |= FD_CLOSE; break; - } - } + WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, + FD_READ | FD_WRITE | FD_ACCEPT | FD_CONNECT | FD_CLOSE); } +} - WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, mask); +/* _GSocket_Disable_Events: + * Disable event notifications (when shutdowning the socket) + */ +void _GSocket_Disable_Events(GSocket *socket) +{ + assert (socket != NULL); + + if (socket->m_fd != INVALID_SOCKET) + { + WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0); + } } + LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd, UINT uMsg, WPARAM wParam, @@ -769,6 +917,7 @@ LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd, GSocket *socket; GSocketEvent event; GSocketCallback cback; + char *data; if (uMsg >= WM_USER && uMsg <= (WM_USER + MAXSOCKETS - 1)) { @@ -776,6 +925,7 @@ LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd, socket = socketList[(uMsg - WM_USER)]; event = -1; cback = NULL; + data = NULL; /* Check that the socket still exists (it has not been * destroyed) and for safety, check that the m_fd field @@ -788,22 +938,39 @@ LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd, case FD_READ: event = GSOCK_INPUT; break; case FD_WRITE: event = GSOCK_OUTPUT; break; case FD_ACCEPT: event = GSOCK_CONNECTION; break; - case FD_CONNECT: event = GSOCK_CONNECTION; break; + case FD_CONNECT: + { + if (WSAGETSELECTERROR(lParam) != 0) + event = GSOCK_LOST; + else + event = GSOCK_CONNECTION; + break; + } case FD_CLOSE: event = GSOCK_LOST; break; } if (event != -1) + { cback = socket->m_cbacks[event]; + data = socket->m_data[event]; + + if (event == GSOCK_LOST) + socket->m_detected = GSOCK_LOST_FLAG; + else + socket->m_detected |= (1 << event); + } } /* OK, we can now leave the critical section because we have * already obtained the callback address (we make no further - * accesses to socket->whatever) + * accesses to socket->whatever). However, the app should + * be prepared to handle events from a socket that has just + * been closed! */ LeaveCriticalSection(&critical); if (cback != NULL) - (cback)(socket, event, socket->m_data[event]); + (cback)(socket, event, data); return (LRESULT) 0; } @@ -820,7 +987,7 @@ GSocketError _GSocket_Input_Timeout(GSocket *socket) { fd_set readfds; - if (socket->m_non_blocking == FALSE) + if (!socket->m_non_blocking) { FD_ZERO(&readfds); FD_SET(socket->m_fd, &readfds); @@ -841,7 +1008,7 @@ GSocketError _GSocket_Output_Timeout(GSocket *socket) { fd_set writefds; - if (socket->m_non_blocking == FALSE) + if (!socket->m_non_blocking) { FD_ZERO(&writefds); FD_SET(socket->m_fd, &writefds); @@ -854,44 +1021,52 @@ GSocketError _GSocket_Output_Timeout(GSocket *socket) return GSOCK_NOERROR; } -int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size) +/* _GSocket_Connect_Timeout: + * For blocking sockets, wait until the connection is + * established or fails, or until timeout ellapses. + */ +GSocketError _GSocket_Connect_Timeout(GSocket *socket) { - int ret; - - ret = recv(socket->m_fd, buffer, size, 0); + fd_set writefds; + fd_set exceptfds; - if (ret == SOCKET_ERROR) + if (!socket->m_non_blocking) { - if (WSAGetLastError() != WSAEWOULDBLOCK) - socket->m_error = GSOCK_IOERR; - else - socket->m_error = GSOCK_WOULDBLOCK; - - return -1; + FD_ZERO(&writefds); + FD_ZERO(&exceptfds); + FD_SET(socket->m_fd, &writefds); + FD_SET(socket->m_fd, &exceptfds); + if (select(0, NULL, &writefds, &exceptfds, &socket->m_timeout) == 0) + { + socket->m_error = GSOCK_TIMEDOUT; + return GSOCK_TIMEDOUT; + } + } + if (!FD_ISSET(socket->m_fd, &writefds)) + { + socket->m_error = GSOCK_IOERR; + return GSOCK_IOERR; } - return ret; + return GSOCK_NOERROR; +} + +int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size) +{ + return recv(socket->m_fd, buffer, size, 0); } int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size) { struct sockaddr from; - SOCKLEN_T fromlen; + SOCKLEN_T fromlen = sizeof(from); int ret; - - fromlen = sizeof(from); + GSocketError err; ret = recvfrom(socket->m_fd, buffer, size, 0, &from, &fromlen); if (ret == SOCKET_ERROR) - { - if (WSAGetLastError() != WSAEWOULDBLOCK) - socket->m_error = GSOCK_IOERR; - else - socket->m_error = GSOCK_WOULDBLOCK; - - return -1; - } + return SOCKET_ERROR; /* Translate a system address into a GSocket address */ if (!socket->m_peer) @@ -903,10 +1078,12 @@ int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size) return -1; } } - if (_GAddress_translate_from(socket->m_peer, &from, fromlen) != GSOCK_NOERROR) + err = _GAddress_translate_from(socket->m_peer, &from, fromlen); + if (err != GSOCK_NOERROR) { - socket->m_error = GSOCK_MEMERR; /* TODO: bug in Unix GSocket! */ - GAddress_destroy(socket->m_peer); /* TODO: bug in Unix GSocket! */ + GAddress_destroy(socket->m_peer); + socket->m_peer = NULL; + socket->m_error = err; return -1; } @@ -915,26 +1092,14 @@ int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size) int _GSocket_Send_Stream(GSocket *socket, const char *buffer, int size) { - int ret; - - ret = send(socket->m_fd, buffer, size, 0); - - if (ret == SOCKET_ERROR) - { - if (WSAGetLastError() != WSAEWOULDBLOCK) - socket->m_error = GSOCK_IOERR; - else - socket->m_error = GSOCK_WOULDBLOCK; - - return -1; - } - return ret; + return send(socket->m_fd, buffer, size, 0); } int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size) { struct sockaddr *addr; int len, ret; + GSocketError err; if (!socket->m_peer) { @@ -942,9 +1107,10 @@ int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size) return -1; } - if (!_GAddress_translate_to(socket->m_peer, &addr, &len)) + err = _GAddress_translate_to(socket->m_peer, &addr, &len); + if (err != GSOCK_NOERROR) { - socket->m_error = GSOCK_MEMERR; + socket->m_error = err; return -1; } @@ -953,15 +1119,6 @@ int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size) /* Frees memory allocated by _GAddress_translate_to */ free(addr); - if (ret == SOCKET_ERROR) - { - if (WSAGetLastError() != WSAEWOULDBLOCK) - socket->m_error = GSOCK_IOERR; - else - socket->m_error = GSOCK_WOULDBLOCK; - - return -1; - } return ret; } @@ -1117,6 +1274,7 @@ GSocketError _GAddress_translate_to(GAddress *address, GSocketError _GAddress_Init_INET(GAddress *address) { + address->m_len = sizeof(struct sockaddr_in); address->m_addr = (struct sockaddr *) malloc(address->m_len); if (address->m_addr == NULL) { @@ -1124,7 +1282,6 @@ GSocketError _GAddress_Init_INET(GAddress *address) return GSOCK_MEMERR; } - address->m_len = sizeof(struct sockaddr_in); address->m_family = GSOCK_INET; address->m_realfamily = PF_INET; ((struct sockaddr_in *)address->m_addr)->sin_family = AF_INET; @@ -1145,7 +1302,7 @@ GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname) addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr); addr->s_addr = inet_addr(hostname); - + /* If it is a numeric host name, convert it now */ if (addr->s_addr == INADDR_NONE) { @@ -1154,6 +1311,7 @@ GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname) /* It is a real name, we solve it */ if ((he = gethostbyname(hostname)) == NULL) { + /* addr->s_addr = INADDR_NONE just done by inet_addr() above */ address->m_error = GSOCK_NOHOST; return GSOCK_NOHOST; } @@ -1163,6 +1321,11 @@ GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname) return GSOCK_NOERROR; } +GSocketError GAddress_INET_SetAnyAddress(GAddress *address) +{ + return GAddress_INET_SetHostAddress(address, INADDR_ANY); +} + GSocketError GAddress_INET_SetHostAddress(GAddress *address, unsigned long hostaddr) { @@ -1190,9 +1353,9 @@ GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port, if (!port) { address->m_error = GSOCK_INVPORT; - return GSOCK_INVOP; + return GSOCK_INVPORT; } - + se = getservbyname(port, protocol); if (!se) { @@ -1202,7 +1365,7 @@ GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port, port_int = atoi(port); addr = (struct sockaddr_in *)address->m_addr; - addr->sin_port = htons(port_int); + addr->sin_port = htons((u_short) port_int); return GSOCK_NOERROR; } @@ -1222,7 +1385,7 @@ GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port) assert(address != NULL); CHECK_ADDRESS(address, INET, GSOCK_INVADDR); - + addr = (struct sockaddr_in *)address->m_addr; addr->sin_port = htons(port); @@ -1235,7 +1398,7 @@ GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname, size_t char *addr_buf; struct sockaddr_in *addr; - assert(address != NULL); + assert(address != NULL); CHECK_ADDRESS(address, INET, GSOCK_INVADDR); addr = (struct sockaddr_in *)address->m_addr; @@ -1257,8 +1420,8 @@ unsigned long GAddress_INET_GetHostAddress(GAddress *address) { struct sockaddr_in *addr; - assert(address != NULL); - CHECK_ADDRESS(address, INET, 0); + assert(address != NULL); + CHECK_ADDRESS(address, INET, 0); addr = (struct sockaddr_in *)address->m_addr; @@ -1269,8 +1432,8 @@ unsigned short GAddress_INET_GetPort(GAddress *address) { struct sockaddr_in *addr; - assert(address != NULL); - CHECK_ADDRESS(address, INET, 0); + assert(address != NULL); + CHECK_ADDRESS(address, INET, 0); addr = (struct sockaddr_in *)address->m_addr; return ntohs(addr->sin_port); @@ -1303,22 +1466,12 @@ GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf) return GSOCK_INVADDR; } +#else /* !wxUSE_SOCKETS */ -#endif /* !defined(__WXMSW__) || (defined(__WXMSW__) && wxUSE_SOCKETS) */ - - - -/* Diferencias con la version Unix: - * - El descriptor es SOCKET y no int - * - Constantes -1 pasan a INVALID_SOCKET - * - Errores en muchas funciones pasan de -1 o <0 a SOCKET_ERROR - * - ioctl y close pasan a ioctlsocket y closesocket - * - inet_addr en lugar de inet_aton - * - Codigo de inicializacion y terminacion para inicializar y - * terminar WinSocket y para la ventana interna. - * - SetTimeout en la version MSW simplemente guarda el valor en - * socket.m_timeout, por tanto no hay necesidad de llamar a - * SetTimeout cada vez que se crea realmente un socket (no - * un gsocket). - * - Lo mismo para SetNonBlocking. +/* + * Translation unit shouldn't be empty, so include this typedef to make the + * compiler (VC++ 6.0, for example) happy */ +typedef (*wxDummy)(); + +#endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */