X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/533c7161fc06f3e78f977a5b0692150213fa2f7e..866592d872daa1f4e3d44948d7d3a6c90b0af9d0:/src/unix/gsocket.c diff --git a/src/unix/gsocket.c b/src/unix/gsocket.c index 3174b57a7a..55a198c16a 100644 --- a/src/unix/gsocket.c +++ b/src/unix/gsocket.c @@ -117,12 +117,12 @@ GSocket *GSocket_new() socket->m_local = NULL; socket->m_peer = NULL; socket->m_error = GSOCK_NOERROR; - socket->m_server = FALSE; - socket->m_stream = TRUE; - socket->m_gui_dependent = NULL; - socket->m_non_blocking = FALSE; + socket->m_server = FALSE; + socket->m_stream = TRUE; + socket->m_gui_dependent = NULL; + socket->m_non_blocking = FALSE; socket->m_timeout = 10*60*1000; - /* 10 minutes * 60 sec * 1000 millisec */ + /* 10 minutes * 60 sec * 1000 millisec */ socket->m_establishing = FALSE; /* We initialize the GUI specific entries here */ @@ -262,13 +262,13 @@ GAddress *GSocket_GetPeer(GSocket *socket) /* Server specific parts */ -/* - GSocket_SetServer() setup the socket as a server. It uses the "Local" field - of GSocket. "Local" must be set by GSocket_SetLocal() before - GSocket_SetServer() is called. GSOCK_INVSOCK if socket has been initialized. - In case, you haven't yet defined the local address, it returns GSOCK_INVADDR. - In the other cases it returns GSOCK_IOERR. -*/ +/* 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. + */ GSocketError GSocket_SetServer(GSocket *sck) { int type; @@ -313,15 +313,16 @@ GSocketError GSocket_SetServer(GSocket *sck) return GSOCK_IOERR; } + _GSocket_Configure_Callbacks(sck); GSocket_SetNonBlocking(sck, sck->m_non_blocking); GSocket_SetTimeout(sck, sck->m_timeout); return GSOCK_NOERROR; } -/* - GSocket_WaitConnection() waits for an incoming client connection. -*/ +/* GSocket_WaitConnection: + * Waits for an incoming client connection. + */ GSocket *GSocket_WaitConnection(GSocket *socket) { GSocket *connection; @@ -370,6 +371,10 @@ GSocket *GSocket_WaitConnection(GSocket *socket) connection->m_server = FALSE; connection->m_oriented = TRUE; + _GSocket_Configure_Callbacks(connection); + GSocket_SetNonBlocking(connection, connection->m_non_blocking); + GSocket_SetTimeout(connection, connection->m_timeout); + return connection; } @@ -409,6 +414,7 @@ GSocketError GSocket_SetNonOriented(GSocket *sck) return GSOCK_IOERR; } + _GSocket_Configure_Callbacks(sck); GSocket_SetNonBlocking(sck, sck->m_non_blocking); GSocket_SetTimeout(sck, sck->m_timeout); @@ -417,11 +423,15 @@ GSocketError GSocket_SetNonOriented(GSocket *sck) /* Client specific parts */ -/* - 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. In the other case, it returns GSOCK_INVADDR. -*/ +/* 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, + * GSOCK_INVADDR, GSOCK_TIMEDOUT, GSOCK_WOULDBLOCK and GSOCK_IOERR. + * If a socket is nonblocking and Connect() returns GSOCK_WOULDBLOCK, + * the connection request can be completed later. Use GSocket_Select() + * to check or wait for a GSOCK_CONNECTION event. + */ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream) { int type, err; @@ -455,6 +465,7 @@ GSocketError GSocket_Connect(GSocket *sck, GSocketStream stream) return GSOCK_IOERR; } + _GSocket_Configure_Callbacks(sck); GSocket_SetNonBlocking(sck, sck->m_non_blocking); GSocket_SetTimeout(sck, sck->m_timeout); @@ -524,35 +535,79 @@ int GSocket_Write(GSocket *socket, const char *buffer, return _GSocket_Send_Dgram(socket, buffer, size); } -bool GSocket_DataAvailable(GSocket *socket) +/* 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) { - fd_set read_set; + fd_set readfds, writefds, exceptfds; struct timeval tv; + GSocketEventFlags mask; + int error, len; assert(socket != NULL); - if (socket->m_fd == -1 || socket->m_server) { + if (socket->m_fd == -1) + { socket->m_error = GSOCK_INVSOCK; return FALSE; } - FD_ZERO(&read_set); - FD_SET(socket->m_fd, &read_set); + FD_ZERO(&readfds); + FD_ZERO(&writefds); + FD_ZERO(&exceptfds); + FD_SET(socket->m_fd, &readfds); + FD_SET(socket->m_fd, &writefds); + FD_SET(socket->m_fd, &exceptfds); tv.tv_sec = 0; tv.tv_usec = 0; + select(socket->m_fd + 1, &readfds, &writefds, &exceptfds, &tv); + + mask = 0; + + /* If select() says that the socket is readable, then we have + * no way to distinguish if that means 'data available' (to + * recv) or 'incoming connection' (to accept). The same goes + * for writability: we cannot distinguish between 'you can + * send data' and 'connection request completed'. So we will + * assume the following: if the flag was set upon entry, + * that means that the event was possible. + */ + if (FD_ISSET(socket->m_fd, &readfds)) + { + mask |= (flags & GSOCK_CONNECTION_FLAG); + mask |= (flags & GSOCK_INPUT_FLAG); + } + if (FD_ISSET(socket->m_fd, &writefds)) + { + if (socket->m_establishing) + { + getsockopt(socket->m_fd, SOL_SOCKET, SO_ERROR, &error, &len); - select(socket->m_fd+1, &read_set, NULL, NULL, &tv); + if (error) + mask |= (flags & GSOCK_LOST_FLAG); + else + mask |= (flags & GSOCK_CONNECTION_FLAG); + } + mask |= (flags & GSOCK_OUTPUT_FLAG); + } + if (FD_ISSET(socket->m_fd, &exceptfds)) + mask |= (flags & GSOCK_LOST_FLAG); - return FD_ISSET(socket->m_fd, &read_set); + return mask; } /* Flags */ -/* - GSocket_SetNonBlocking() puts the socket in non-blocking mode. This is useful - if we don't want to wait. -*/ +/* GSocket_SetNonBlocking: + * Sets the socket to non-blocking mode. This is useful if + * we don't want to wait. + */ void GSocket_SetNonBlocking(GSocket *socket, bool non_block) { assert(socket != NULL); @@ -563,10 +618,10 @@ void GSocket_SetNonBlocking(GSocket *socket, bool non_block) ioctl(socket->m_fd, FIONBIO, &non_block); } -/* - * GSocket_SetTimeout() +/* GSocket_SetTimeout: + * Sets the timeout for blocking calls. Time is + * expressed in milliseconds. */ - void GSocket_SetTimeout(GSocket *socket, unsigned long millisec) { assert(socket != NULL); @@ -574,10 +629,9 @@ void GSocket_SetTimeout(GSocket *socket, unsigned long millisec) socket->m_timeout = millisec; } -/* - GSocket_GetError() returns the last error occured on the socket stream. -*/ - +/* GSocket_GetError: + * Returns the last error occured for this socket. + */ GSocketError GSocket_GetError(GSocket *socket) { assert(socket != NULL); @@ -587,26 +641,31 @@ GSocketError GSocket_GetError(GSocket *socket) /* Callbacks */ -/* - Only one callback is possible for each event (INPUT, OUTPUT, CONNECTION) - INPUT: The function is called when there is at least a byte in the - input buffer - OUTPUT: The function is called when the system is sure the next write call - will not block - CONNECTION: Two cases is possible: - Client socket -> the connection is established - Server socket -> a client request a connection - LOST: the connection is lost - - SetCallback accepts a combination of these flags so a same callback can - receive different events. - - 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() -*/ -void GSocket_SetCallback(GSocket *socket, GSocketEventFlags event, +/* 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() + */ + +/* GSocket_SetCallback: + * 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 flags, GSocketCallback callback, char *cdata) { int count; @@ -616,38 +675,36 @@ void GSocket_SetCallback(GSocket *socket, GSocketEventFlags event, for (count=0;countm_cbacks[count] = callback; socket->m_data[count] = cdata; - _GSocket_Enable(socket, count); } } + _GSocket_Configure_Callbacks(socket); } -/* - UnsetCallback will disables all callbacks specified by "event". - NOTE: event may be a combination of flags -*/ -void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags event) +/* GSocket_UnsetCallback: + * Disables all callbacks specified by 'flags', which may be a + * combination of flags OR'ed toghether. + */ +void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags) { - int count = 0; + int count; assert(socket != NULL); for (count=0;countm_cbacks[count] = NULL; } } + _GSocket_Configure_Callbacks(socket); } -#define CALL_CALLBACK(socket, event) \ -if (socket->m_iocalls[event] && \ - socket->m_cbacks[event]) {\ - _GSocket_Disable(socket, event); \ - socket->m_cbacks[event](socket, event, \ - socket->m_data[event]); \ +#define CALL_CALLBACK(socket, event) \ +if (socket->m_iocalls[event] && socket->m_cbacks[event]) { \ + _GSocket_Disable(socket, event); \ + socket->m_cbacks[event](socket, event, socket->m_data[event]); \ } void _GSocket_Enable(GSocket *socket, GSocketEvent event) @@ -664,6 +721,18 @@ void _GSocket_Disable(GSocket *socket, GSocketEvent event) _GSocket_Uninstall_Callback(socket, event); } +void _GSocket_Configure_Callbacks(GSocket *socket) +{ + int count; + for (count=0;countm_cbacks[count]) != NULL) { + _GSocket_Enable(socket, count); + } else { + _GSocket_Disable(socket, count); + } + } +} + int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size) { int ret;