/* ------------------------------------------------------------------------- * Project: GSocket (Generic Socket) for WX * Name: gsocket.c * Authors: David Elliott (C++ conversion, maintainer) * Guilhem Lavaux, * Guillermo Rodriguez Garcia * Purpose: GSocket main Unix and OS/2 file * Licence: The wxWindows licence * CVSID: $Id$ * ------------------------------------------------------------------------- */ /* * PLEASE don't put C++ comments here - this is a C source file. */ #ifndef __GSOCKET_STANDALONE__ #include "wx/setup.h" #endif #if defined(__VISAGECPP__) /* Seems to be needed by Visual Age C++, though I don't see how it manages to not break on including a C++ header into a plain C source file */ #include "wx/defs.h" #define BSD_SELECT /* use Berkley Sockets select */ #endif #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) #include #include #ifdef __VISAGECPP__ #include #include #include #include #endif #include #include #ifdef __VMS__ #include struct sockaddr_un { u_char sun_len; /* sockaddr len including null */ u_char sun_family; /* AF_UNIX */ char sun_path[108]; /* path name (gag) */ }; #else #include #include #endif #ifndef __VISAGECPP__ #include #include #include #include #include #include #else #include # if __IBMCPP__ < 400 #include #include #include #include #include #define EBADF SOCEBADF # ifdef min # undef min # endif # else #include #include #include #define close(a) soclose(a) #define select(a,b,c,d,e) bsdselect(a,b,c,d,e) int _System bsdselect(int, struct fd_set *, struct fd_set *, struct fd_set *, struct timeval *); int _System soclose(int); # endif #endif #ifdef __EMX__ #include #endif #include #include #include #include #ifdef sun # include #endif #ifdef sgi # include #endif #include #ifndef SOCKLEN_T #ifdef VMS # define SOCKLEN_T unsigned int #else # ifdef __GLIBC__ # if __GLIBC__ == 2 # define SOCKLEN_T socklen_t # endif # else # define SOCKLEN_T int # endif #endif #else /* undefine for OSX - its really an int */ # ifdef __DARWIN__ # undef SOCKLEN_T # define SOCKLEN_T int # endif #endif /* SOCKLEN_T */ /* * MSW defines this, Unices don't. */ #ifndef INVALID_SOCKET #define INVALID_SOCKET -1 #endif /* UnixWare reportedly needs this for FIONBIO definition */ #ifdef __UNIXWARE__ #include #endif /* * INADDR_BROADCAST is identical to INADDR_NONE which is not defined * on all systems. INADDR_BROADCAST should be fine to indicate an error. */ #ifndef INADDR_NONE #define INADDR_NONE INADDR_BROADCAST #endif #define MASK_SIGNAL() \ { \ void (*old_handler)(int); \ \ old_handler = signal(SIGPIPE, SIG_IGN); #define UNMASK_SIGNAL() \ signal(SIGPIPE, old_handler); \ } #ifndef __GSOCKET_STANDALONE__ # include "wx/unix/gsockunx.h" # include "wx/gsocket.h" #else # include "gsockunx.h" # include "gsocket.h" #endif /* __GSOCKET_STANDALONE__ */ /* debugging helpers */ #ifdef __GSOCKET_DEBUG__ # define GSocket_Debug(args) printf args #else # define GSocket_Debug(args) #endif /* __GSOCKET_DEBUG__ */ /* Table of GUI-related functions. We must call them indirectly because * of wxBase and GUI separation: */ static GSocketGUIFunctionsTable *gs_gui_functions; class GSocketGUIFunctionsTableNull: public GSocketGUIFunctionsTable { public: virtual bool OnInit(); virtual void OnExit(); virtual bool CanUseEventLoop(); virtual bool Init_Socket(GSocket *socket); virtual void Destroy_Socket(GSocket *socket); virtual void Install_Callback(GSocket *socket, GSocketEvent event); virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event); virtual void Enable_Events(GSocket *socket); virtual void Disable_Events(GSocket *socket); }; bool GSocketGUIFunctionsTableNull::OnInit() { return true; } void GSocketGUIFunctionsTableNull::OnExit() {} bool GSocketGUIFunctionsTableNull::CanUseEventLoop() { return false; } bool GSocketGUIFunctionsTableNull::Init_Socket(GSocket *socket) { return true; } void GSocketGUIFunctionsTableNull::Destroy_Socket(GSocket *socket) {} void GSocketGUIFunctionsTableNull::Install_Callback(GSocket *socket, GSocketEvent event) {} void GSocketGUIFunctionsTableNull::Uninstall_Callback(GSocket *socket, GSocketEvent event) {} void GSocketGUIFunctionsTableNull::Enable_Events(GSocket *socket) {} void GSocketGUIFunctionsTableNull::Disable_Events(GSocket *socket) {} /* Global initialisers */ void GSocket_SetGUIFunctions(GSocketGUIFunctionsTable *guifunc) { gs_gui_functions = guifunc; } int GSocket_Init(void) { if (!gs_gui_functions) { static GSocketGUIFunctionsTableNull table; gs_gui_functions = &table; } if ( !gs_gui_functions->OnInit() ) return 0; return 1; } void GSocket_Cleanup(void) { if (gs_gui_functions) { gs_gui_functions->OnExit(); } } /* Constructors / Destructors for GSocket */ GSocket::GSocket() { int i; m_fd = INVALID_SOCKET; for (i=0;iInit_Socket(this); } void GSocket::Close() { gs_gui_functions->Disable_Events(this); /* gsockosx.c calls CFSocketInvalidate which closes the socket for us */ #if !(defined(__DARWIN__) && (defined(__WXMAC__) || defined(__WXCOCOA__))) close(m_fd); #endif m_fd = INVALID_SOCKET; } GSocket::~GSocket() { assert(this); /* Check that the socket is really shutdowned */ if (m_fd != INVALID_SOCKET) Shutdown(); /* Per-socket GUI-specific cleanup */ gs_gui_functions->Destroy_Socket(this); /* Destroy private addresses */ if (m_local) GAddress_destroy(m_local); if (m_peer) GAddress_destroy(m_peer); } /* GSocket_Shutdown: * Disallow further read/write operations on this socket, close * the fd and disable all callbacks. */ void GSocket::Shutdown() { int evt; assert(this); /* If socket has been created, shutdown it */ if (m_fd != INVALID_SOCKET) { shutdown(m_fd, 2); Close(); } /* Disable GUI callbacks */ for (evt = 0; evt < GSOCK_MAX_EVENT; evt++) m_cbacks[evt] = NULL; m_detected = GSOCK_LOST_FLAG; } /* 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(GAddress *address) { assert(this); /* the socket must be initialized, or it must be a server */ if ((m_fd != INVALID_SOCKET && !m_server)) { m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } /* check address */ if (address == NULL || address->m_family == GSOCK_NOFAMILY) { m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } if (m_local) GAddress_destroy(m_local); m_local = GAddress_copy(address); return GSOCK_NOERROR; } GSocketError GSocket::SetPeer(GAddress *address) { assert(this); /* check address */ if (address == NULL || address->m_family == GSOCK_NOFAMILY) { m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } if (m_peer) GAddress_destroy(m_peer); m_peer = GAddress_copy(address); return GSOCK_NOERROR; } GAddress *GSocket::GetLocal() { GAddress *address; struct sockaddr addr; SOCKLEN_T size = sizeof(addr); GSocketError err; assert(this); /* try to get it from the m_local var first */ if (m_local) return GAddress_copy(m_local); /* else, if the socket is initialized, try getsockname */ if (m_fd == INVALID_SOCKET) { m_error = GSOCK_INVSOCK; return NULL; } if (getsockname(m_fd, &addr, (SOCKLEN_T *) &size) < 0) { m_error = GSOCK_IOERR; return NULL; } /* got a valid address from getsockname, create a GAddress object */ address = GAddress_new(); if (address == NULL) { m_error = GSOCK_MEMERR; return NULL; } err = _GAddress_translate_from(address, &addr, size); if (err != GSOCK_NOERROR) { GAddress_destroy(address); m_error = err; return NULL; } return address; } GAddress *GSocket::GetPeer() { assert(this); /* try to get it from the m_peer var */ if (m_peer) return GAddress_copy(m_peer); return NULL; } /* Server specific parts */ /* GSocket_SetServer: * 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() { int arg = 1; assert(this); /* must not be in use */ if (m_fd != INVALID_SOCKET) { m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } /* the local addr must have been set */ if (!m_local) { m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } /* Initialize all fields */ m_stream = true; m_server = true; /* Create the socket */ m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0); if (m_fd == INVALID_SOCKET) { m_error = GSOCK_IOERR; return GSOCK_IOERR; } #if defined(__EMX__) || defined(__VISAGECPP__) ioctl(m_fd, FIONBIO, (char*)&arg, sizeof(arg)); #else ioctl(m_fd, FIONBIO, &arg); #endif gs_gui_functions->Enable_Events(this); /* allow a socket to re-bind if the socket is in the TIME_WAIT state after being previously closed. */ if (m_reusable) setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (const char*)&arg, sizeof(u_long)); /* Bind to the local address, * retrieve the actual address bound, * and listen up to 5 connections. */ if ((bind(m_fd, m_local->m_addr, m_local->m_len) != 0) || (getsockname(m_fd, m_local->m_addr, (SOCKLEN_T *) &m_local->m_len) != 0) || (listen(m_fd, 5) != 0)) { Close(); m_error = GSOCK_IOERR; return GSOCK_IOERR; } return GSOCK_NOERROR; } /* GSocket_WaitConnection: * 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() { struct sockaddr from; SOCKLEN_T fromlen = sizeof(from); GSocket *connection; GSocketError err; int arg = 1; assert(this); /* Reenable CONNECTION events */ Enable(GSOCK_CONNECTION); /* If the socket has already been created, we exit immediately */ if (m_fd == INVALID_SOCKET || !m_server) { m_error = GSOCK_INVSOCK; return NULL; } /* Create a GSocket object for the new connection */ connection = GSocket_new(); if (!connection) { m_error = GSOCK_MEMERR; return NULL; } /* Wait for a connection (with timeout) */ if (Input_Timeout() == GSOCK_TIMEDOUT) { delete connection; /* m_error set by _GSocket_Input_Timeout */ return NULL; } connection->m_fd = accept(m_fd, &from, (SOCKLEN_T *) &fromlen); if (connection->m_fd == INVALID_SOCKET) { if (errno == EWOULDBLOCK) m_error = GSOCK_WOULDBLOCK; else m_error = GSOCK_IOERR; delete connection; return NULL; } /* Initialize all fields */ connection->m_server = false; connection->m_stream = true; /* Setup the peer address field */ connection->m_peer = GAddress_new(); if (!connection->m_peer) { delete connection; m_error = GSOCK_MEMERR; return NULL; } err = _GAddress_translate_from(connection->m_peer, &from, fromlen); if (err != GSOCK_NOERROR) { GAddress_destroy(connection->m_peer); delete connection; m_error = err; return NULL; } #if defined(__EMX__) || defined(__VISAGECPP__) ioctl(connection->m_fd, FIONBIO, (char*)&arg, sizeof(arg)); #else ioctl(connection->m_fd, FIONBIO, &arg); #endif gs_gui_functions->Enable_Events(connection); return connection; } bool GSocket::SetReusable() { /* socket must not be null, and must not be in use/already bound */ if (this && m_fd == INVALID_SOCKET) { m_reusable = true; return true; } return false; } /* Client specific parts */ /* 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(GSocketStream stream) { int err, ret; int arg = 1; assert(this); /* Enable CONNECTION events (needed for nonblocking connections) */ Enable(GSOCK_CONNECTION); if (m_fd != INVALID_SOCKET) { m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } if (!m_peer) { m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } /* Streamed or dgram socket? */ m_stream = (stream == GSOCK_STREAMED); m_server = false; m_establishing = false; /* Create the socket */ m_fd = socket(m_peer->m_realfamily, m_stream? SOCK_STREAM : SOCK_DGRAM, 0); if (m_fd == INVALID_SOCKET) { m_error = GSOCK_IOERR; return GSOCK_IOERR; } #if defined(__EMX__) || defined(__VISAGECPP__) ioctl(m_fd, FIONBIO, (char*)&arg, sizeof(arg)); #else ioctl(m_fd, FIONBIO, &arg); #endif gs_gui_functions->Enable_Events(this); /* Connect it to the peer address, with a timeout (see below) */ ret = connect(m_fd, m_peer->m_addr, m_peer->m_len); if (ret == -1) { err = errno; /* If connect failed with EINPROGRESS 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 == EINPROGRESS) && (!m_non_blocking)) { if (Output_Timeout() == GSOCK_TIMEDOUT) { Close(); /* m_error is set in _GSocket_Output_Timeout */ return GSOCK_TIMEDOUT; } else { int error; SOCKLEN_T len = sizeof(error); getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (void*) &error, &len); if (!error) return GSOCK_NOERROR; } } /* If connect failed with EINPROGRESS 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 == EINPROGRESS) && (m_non_blocking)) { m_establishing = true; m_error = GSOCK_WOULDBLOCK; return GSOCK_WOULDBLOCK; } /* If connect failed with an error other than EINPROGRESS, * then the call to GSocket_Connect has failed. */ Close(); m_error = GSOCK_IOERR; return GSOCK_IOERR; } return GSOCK_NOERROR; } /* Datagram sockets */ /* 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::SetNonOriented() { int arg = 1; assert(this); if (m_fd != INVALID_SOCKET) { m_error = GSOCK_INVSOCK; return GSOCK_INVSOCK; } if (!m_local) { m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } /* Initialize all fields */ m_stream = false; m_server = false; /* Create the socket */ m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0); if (m_fd == INVALID_SOCKET) { m_error = GSOCK_IOERR; return GSOCK_IOERR; } #if defined(__EMX__) || defined(__VISAGECPP__) ioctl(m_fd, FIONBIO, (char*)&arg, sizeof(arg)); #else ioctl(m_fd, FIONBIO, &arg); #endif gs_gui_functions->Enable_Events(this); /* Bind to the local address, * and retrieve the actual address bound. */ if ((bind(m_fd, m_local->m_addr, m_local->m_len) != 0) || (getsockname(m_fd, m_local->m_addr, (SOCKLEN_T *) &m_local->m_len) != 0)) { Close(); m_error = GSOCK_IOERR; return GSOCK_IOERR; } return GSOCK_NOERROR; } /* Generic IO */ /* Like recv(), send(), ... */ int GSocket::Read(char *buffer, int size) { int ret; assert(this); if (m_fd == INVALID_SOCKET || m_server) { m_error = GSOCK_INVSOCK; return -1; } /* Disable events during query of socket status */ Disable(GSOCK_INPUT); /* If the socket is blocking, wait for data (with a timeout) */ if (Input_Timeout() == GSOCK_TIMEDOUT) /* We no longer return here immediately, otherwise socket events would not be re-enabled! */ ret = -1; else { /* Read the data */ if (m_stream) ret = Recv_Stream(buffer, size); else ret = Recv_Dgram(buffer, size); } if (ret == -1) { if (errno == EWOULDBLOCK) m_error = GSOCK_WOULDBLOCK; else m_error = GSOCK_IOERR; } /* Enable events again now that we are done processing */ Enable(GSOCK_INPUT); return ret; } int GSocket::Write(const char *buffer, int size) { int ret; assert(this); GSocket_Debug(( "GSocket_Write #1, size %d\n", size )); if (m_fd == INVALID_SOCKET || m_server) { m_error = GSOCK_INVSOCK; return -1; } GSocket_Debug(( "GSocket_Write #2, size %d\n", size )); /* If the socket is blocking, wait for writability (with a timeout) */ if (Output_Timeout() == GSOCK_TIMEDOUT) return -1; GSocket_Debug(( "GSocket_Write #3, size %d\n", size )); /* Write the data */ if (m_stream) ret = Send_Stream(buffer, size); else ret = Send_Dgram(buffer, size); GSocket_Debug(( "GSocket_Write #4, size %d\n", size )); if (ret == -1) { if (errno == EWOULDBLOCK) { m_error = GSOCK_WOULDBLOCK; GSocket_Debug(( "GSocket_Write error WOULDBLOCK\n" )); } else { m_error = GSOCK_IOERR; GSocket_Debug(( "GSocket_Write error IOERR\n" )); } /* Only reenable OUTPUT events after an error (just like WSAAsyncSelect * in MSW). 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. */ Enable(GSOCK_OUTPUT); return -1; } GSocket_Debug(( "GSocket_Write #5, size %d ret %d\n", size, ret )); return ret; } /* 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(GSocketEventFlags flags) { if (!gs_gui_functions->CanUseEventLoop()) { GSocketEventFlags result = 0; fd_set readfds; fd_set writefds; fd_set exceptfds; struct timeval tv; assert(this); /* Do not use a static struct, Linux can garble it */ tv.tv_sec = m_timeout / 1000; tv.tv_usec = (m_timeout % 1000) * 1000; FD_ZERO(&readfds); FD_ZERO(&writefds); FD_ZERO(&exceptfds); FD_SET(m_fd, &readfds); if (flags & GSOCK_OUTPUT_FLAG || flags & GSOCK_CONNECTION_FLAG) FD_SET(m_fd, &writefds); FD_SET(m_fd, &exceptfds); /* Check 'sticky' CONNECTION flag first */ result |= (GSOCK_CONNECTION_FLAG & m_detected); /* If we have already detected a LOST event, then don't try * to do any further processing. */ if ((m_detected & GSOCK_LOST_FLAG) != 0) { m_establishing = false; return (GSOCK_LOST_FLAG & flags); } /* Try select now */ if (select(m_fd + 1, &readfds, &writefds, &exceptfds, &tv) <= 0) { /* What to do here? */ return (result & flags); } /* Check for readability */ if (FD_ISSET(m_fd, &readfds)) { char c; if (recv(m_fd, &c, 1, MSG_PEEK) > 0) { result |= GSOCK_INPUT_FLAG; } else { if (m_server && m_stream) { result |= GSOCK_CONNECTION_FLAG; m_detected |= GSOCK_CONNECTION_FLAG; } else { m_detected = GSOCK_LOST_FLAG; m_establishing = false; /* LOST event: Abort any further processing */ return (GSOCK_LOST_FLAG & flags); } } } /* Check for writability */ if (FD_ISSET(m_fd, &writefds)) { if (m_establishing && !m_server) { int error; SOCKLEN_T len = sizeof(error); m_establishing = false; getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (void*)&error, &len); if (error) { m_detected = GSOCK_LOST_FLAG; /* LOST event: Abort any further processing */ return (GSOCK_LOST_FLAG & flags); } else { result |= GSOCK_CONNECTION_FLAG; m_detected |= GSOCK_CONNECTION_FLAG; } } else { result |= GSOCK_OUTPUT_FLAG; } } /* Check for exceptions and errors (is this useful in Unices?) */ if (FD_ISSET(m_fd, &exceptfds)) { m_establishing = false; m_detected = GSOCK_LOST_FLAG; /* LOST event: Abort any further processing */ return (GSOCK_LOST_FLAG & flags); } return (result & flags); } else { assert(this); return flags & m_detected; } } /* Flags */ /* GSocket_SetNonBlocking: * Sets the socket to non-blocking mode. All IO calls will return * immediately. */ void GSocket::SetNonBlocking(bool non_block) { assert(this); GSocket_Debug( ("GSocket_SetNonBlocking: %d\n", (int)non_block) ); m_non_blocking = non_block; } /* GSocket_SetTimeout: * Sets the timeout for blocking calls. Time is expressed in * milliseconds. */ void GSocket::SetTimeout(unsigned long millisec) { assert(this); m_timeout = millisec; } /* GSocket_GetError: * 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 WXDLLIMPEXP_NET GSocket::GetError() { assert(this); return m_error; } /* Callbacks */ /* 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 '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(GSocketEventFlags flags, GSocketCallback callback, char *cdata) { int count; assert(this); for (count = 0; count < GSOCK_MAX_EVENT; count++) { if ((flags & (1 << count)) != 0) { m_cbacks[count] = callback; m_data[count] = cdata; } } } /* GSocket_UnsetCallback: * Disables all callbacks specified by 'flags', which may be a * combination of flags OR'ed toghether. */ void GSocket::UnsetCallback(GSocketEventFlags flags) { int count; assert(this); for (count = 0; count < GSOCK_MAX_EVENT; count++) { if ((flags & (1 << count)) != 0) { m_cbacks[count] = NULL; m_data[count] = NULL; } } } GSocketError GSocket::GetSockOpt(int level, int optname, void *optval, int *optlen) { if (getsockopt(m_fd, level, optname, optval, (SOCKLEN_T*)optlen) == 0) { return GSOCK_NOERROR; } return GSOCK_OPTERR; } GSocketError GSocket::SetSockOpt(int level, int optname, const void *optval, int optlen) { if (setsockopt(m_fd, level, optname, optval, optlen) == 0) { return GSOCK_NOERROR; } return GSOCK_OPTERR; } #define CALL_CALLBACK(socket, event) { \ socket->Disable(event); \ if (socket->m_cbacks[event]) \ socket->m_cbacks[event](socket, event, socket->m_data[event]); \ } void GSocket::Enable(GSocketEvent event) { m_detected &= ~(1 << event); gs_gui_functions->Install_Callback(this, event); } void GSocket::Disable(GSocketEvent event) { m_detected |= (1 << event); gs_gui_functions->Uninstall_Callback(this, event); } /* _GSocket_Input_Timeout: * For blocking sockets, wait until data is available or * until timeout ellapses. */ GSocketError GSocket::Input_Timeout() { struct timeval tv; fd_set readfds; int ret; /* Linux select() will overwrite the struct on return */ tv.tv_sec = (m_timeout / 1000); tv.tv_usec = (m_timeout % 1000) * 1000; if (!m_non_blocking) { FD_ZERO(&readfds); FD_SET(m_fd, &readfds); ret = select(m_fd + 1, &readfds, NULL, NULL, &tv); if (ret == 0) { GSocket_Debug(( "GSocket_Input_Timeout, select returned 0\n" )); m_error = GSOCK_TIMEDOUT; return GSOCK_TIMEDOUT; } if (ret == -1) { GSocket_Debug(( "GSocket_Input_Timeout, select returned -1\n" )); if (errno == EBADF) { GSocket_Debug(( "Invalid file descriptor\n" )); } if (errno == EINTR) { GSocket_Debug(( "A non blocked signal was caught\n" )); } if (errno == EINVAL) { GSocket_Debug(( "The highest number descriptor is negative\n" )); } if (errno == ENOMEM) { GSocket_Debug(( "Not enough memory\n" )); } m_error = GSOCK_TIMEDOUT; return GSOCK_TIMEDOUT; } } return GSOCK_NOERROR; } /* _GSocket_Output_Timeout: * For blocking sockets, wait until data can be sent without * blocking or until timeout ellapses. */ GSocketError GSocket::Output_Timeout() { struct timeval tv; fd_set writefds; int ret; /* Linux select() will overwrite the struct on return */ tv.tv_sec = (m_timeout / 1000); tv.tv_usec = (m_timeout % 1000) * 1000; GSocket_Debug( ("m_non_blocking has: %d\n", (int)m_non_blocking) ); if (!m_non_blocking) { FD_ZERO(&writefds); FD_SET(m_fd, &writefds); ret = select(m_fd + 1, NULL, &writefds, NULL, &tv); if (ret == 0) { GSocket_Debug(( "GSocket_Output_Timeout, select returned 0\n" )); m_error = GSOCK_TIMEDOUT; return GSOCK_TIMEDOUT; } if (ret == -1) { GSocket_Debug(( "GSocket_Output_Timeout, select returned -1\n" )); if (errno == EBADF) { GSocket_Debug(( "Invalid file descriptor\n" )); } if (errno == EINTR) { GSocket_Debug(( "A non blocked signal was caught\n" )); } if (errno == EINVAL) { GSocket_Debug(( "The highest number descriptor is negative\n" )); } if (errno == ENOMEM) { GSocket_Debug(( "Not enough memory\n" )); } m_error = GSOCK_TIMEDOUT; return GSOCK_TIMEDOUT; } if ( ! FD_ISSET(m_fd, &writefds) ) { GSocket_Debug(( "GSocket_Output_Timeout is buggy!\n" )); } else { GSocket_Debug(( "GSocket_Output_Timeout seems correct\n" )); } } else { GSocket_Debug(( "GSocket_Output_Timeout, didn't try select!\n" )); } return GSOCK_NOERROR; } int GSocket::Recv_Stream(char *buffer, int size) { return recv(m_fd, buffer, size, 0); } int GSocket::Recv_Dgram(char *buffer, int size) { struct sockaddr from; SOCKLEN_T fromlen = sizeof(from); int ret; GSocketError err; fromlen = sizeof(from); ret = recvfrom(m_fd, buffer, size, 0, &from, (SOCKLEN_T *) &fromlen); if (ret == -1) return -1; /* Translate a system address into a GSocket address */ if (!m_peer) { m_peer = GAddress_new(); if (!m_peer) { m_error = GSOCK_MEMERR; return -1; } } err = _GAddress_translate_from(m_peer, &from, fromlen); if (err != GSOCK_NOERROR) { GAddress_destroy(m_peer); m_peer = NULL; m_error = err; return -1; } return ret; } int GSocket::Send_Stream(const char *buffer, int size) { int ret; #ifndef __VISAGECPP__ MASK_SIGNAL(); ret = send(m_fd, buffer, size, 0); UNMASK_SIGNAL(); #else ret = send(m_fd, (char *)buffer, size, 0); #endif return ret; } int GSocket::Send_Dgram(const char *buffer, int size) { struct sockaddr *addr; int len, ret; GSocketError err; if (!m_peer) { m_error = GSOCK_INVADDR; return -1; } err = _GAddress_translate_to(m_peer, &addr, &len); if (err != GSOCK_NOERROR) { m_error = err; return -1; } #ifndef __VISAGECPP__ MASK_SIGNAL(); ret = sendto(m_fd, buffer, size, 0, addr, len); UNMASK_SIGNAL(); #else ret = sendto(m_fd, (char *)buffer, size, 0, addr, len); #endif /* Frees memory allocated from _GAddress_translate_to */ free(addr); return ret; } void GSocket::Detected_Read() { char c; /* If we have already detected a LOST event, then don't try * to do any further processing. */ if ((m_detected & GSOCK_LOST_FLAG) != 0) { m_establishing = false; CALL_CALLBACK(this, GSOCK_LOST); Shutdown(); return; } if (recv(m_fd, &c, 1, MSG_PEEK) > 0) { CALL_CALLBACK(this, GSOCK_INPUT); } else { if (m_server && m_stream) { CALL_CALLBACK(this, GSOCK_CONNECTION); } else { CALL_CALLBACK(this, GSOCK_LOST); Shutdown(); } } } void GSocket::Detected_Write() { /* If we have already detected a LOST event, then don't try * to do any further processing. */ if ((m_detected & GSOCK_LOST_FLAG) != 0) { m_establishing = false; CALL_CALLBACK(this, GSOCK_LOST); Shutdown(); return; } if (m_establishing && !m_server) { int error; SOCKLEN_T len = sizeof(error); m_establishing = false; getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (void*)&error, &len); if (error) { CALL_CALLBACK(this, GSOCK_LOST); Shutdown(); } else { CALL_CALLBACK(this, GSOCK_CONNECTION); /* We have to fire this event by hand because CONNECTION (for clients) * and OUTPUT are internally the same and we just disabled CONNECTION * events with the above macro. */ CALL_CALLBACK(this, GSOCK_OUTPUT); } } else { CALL_CALLBACK(this, GSOCK_OUTPUT); } } /* Compatibility functions for GSocket */ GSocket *GSocket_new(void) { GSocket *newsocket = new GSocket(); if(newsocket->IsOk()) return newsocket; delete newsocket; return NULL; } /* * ------------------------------------------------------------------------- * GAddress * ------------------------------------------------------------------------- */ /* CHECK_ADDRESS verifies that the current address family is either * GSOCK_NOFAMILY or GSOCK_*family*, and if it is GSOCK_NOFAMILY, it * initalizes it to be a GSOCK_*family*. In other cases, it returns * an appropiate error code. * * CHECK_ADDRESS_RETVAL does the same but returning 'retval' on error. */ #define CHECK_ADDRESS(address, family) \ { \ if (address->m_family == GSOCK_NOFAMILY) \ if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \ return address->m_error; \ if (address->m_family != GSOCK_##family) \ { \ address->m_error = GSOCK_INVADDR; \ return GSOCK_INVADDR; \ } \ } #define CHECK_ADDRESS_RETVAL(address, family, retval) \ { \ if (address->m_family == GSOCK_NOFAMILY) \ if (_GAddress_Init_##family(address) != GSOCK_NOERROR) \ return retval; \ if (address->m_family != GSOCK_##family) \ { \ address->m_error = GSOCK_INVADDR; \ return retval; \ } \ } GAddress *GAddress_new(void) { GAddress *address; if ((address = (GAddress *) malloc(sizeof(GAddress))) == NULL) return NULL; address->m_family = GSOCK_NOFAMILY; address->m_addr = NULL; address->m_len = 0; return address; } GAddress *GAddress_copy(GAddress *address) { GAddress *addr2; assert(address != NULL); if ((addr2 = (GAddress *) malloc(sizeof(GAddress))) == NULL) return NULL; memcpy(addr2, address, sizeof(GAddress)); if (address->m_addr && address->m_len > 0) { addr2->m_addr = (struct sockaddr *)malloc(addr2->m_len); if (addr2->m_addr == NULL) { free(addr2); return NULL; } memcpy(addr2->m_addr, address->m_addr, addr2->m_len); } return addr2; } void GAddress_destroy(GAddress *address) { assert(address != NULL); if (address->m_addr) free(address->m_addr); free(address); } void GAddress_SetFamily(GAddress *address, GAddressType type) { assert(address != NULL); address->m_family = type; } GAddressType GAddress_GetFamily(GAddress *address) { assert(address != NULL); return address->m_family; } GSocketError _GAddress_translate_from(GAddress *address, struct sockaddr *addr, int len) { address->m_realfamily = addr->sa_family; switch (addr->sa_family) { case AF_INET: address->m_family = GSOCK_INET; break; case AF_UNIX: address->m_family = GSOCK_UNIX; break; #ifdef AF_INET6 case AF_INET6: address->m_family = GSOCK_INET6; break; #endif default: { address->m_error = GSOCK_INVOP; return GSOCK_INVOP; } } if (address->m_addr) free(address->m_addr); address->m_len = len; address->m_addr = (struct sockaddr *)malloc(len); if (address->m_addr == NULL) { address->m_error = GSOCK_MEMERR; return GSOCK_MEMERR; } memcpy(address->m_addr, addr, len); return GSOCK_NOERROR; } GSocketError _GAddress_translate_to(GAddress *address, struct sockaddr **addr, int *len) { if (!address->m_addr) { address->m_error = GSOCK_INVADDR; return GSOCK_INVADDR; } *len = address->m_len; *addr = (struct sockaddr *)malloc(address->m_len); if (*addr == NULL) { address->m_error = GSOCK_MEMERR; return GSOCK_MEMERR; } memcpy(*addr, address->m_addr, address->m_len); return GSOCK_NOERROR; } /* * ------------------------------------------------------------------------- * Internet address family * ------------------------------------------------------------------------- */ 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) { address->m_error = GSOCK_MEMERR; return GSOCK_MEMERR; } address->m_family = GSOCK_INET; address->m_realfamily = PF_INET; ((struct sockaddr_in *)address->m_addr)->sin_family = AF_INET; ((struct sockaddr_in *)address->m_addr)->sin_addr.s_addr = INADDR_ANY; return GSOCK_NOERROR; } GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname) { struct hostent *he; struct in_addr *addr; assert(address != NULL); CHECK_ADDRESS(address, INET); addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr); /* If it is a numeric host name, convert it now */ #if defined(HAVE_INET_ATON) if (inet_aton(hostname, addr) == 0) { #elif defined(HAVE_INET_ADDR) if ( (addr->s_addr = inet_addr(hostname)) == -1 ) { #else /* Use gethostbyname by default */ #ifndef __WXMAC__ int val = 1; /* VA doesn't like constants in conditional expressions */ if (val) #endif { #endif struct in_addr *array_addr; /* It is a real name, we solve it */ if ((he = gethostbyname(hostname)) == NULL) { /* Reset to invalid address */ addr->s_addr = INADDR_NONE; address->m_error = GSOCK_NOHOST; return GSOCK_NOHOST; } array_addr = (struct in_addr *) *(he->h_addr_list); addr->s_addr = array_addr[0].s_addr; } 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) { struct in_addr *addr; assert(address != NULL); CHECK_ADDRESS(address, INET); addr = &(((struct sockaddr_in *)address->m_addr)->sin_addr); addr->s_addr = htonl(hostaddr); return GSOCK_NOERROR; } GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port, const char *protocol) { struct servent *se; struct sockaddr_in *addr; assert(address != NULL); CHECK_ADDRESS(address, INET); if (!port) { address->m_error = GSOCK_INVPORT; return GSOCK_INVPORT; } se = getservbyname(port, protocol); if (!se) { /* the cast to int suppresses compiler warnings about subscript having the type char */ if (isdigit((int)port[0])) { int port_int; port_int = atoi(port); addr = (struct sockaddr_in *)address->m_addr; addr->sin_port = htons(port_int); return GSOCK_NOERROR; } address->m_error = GSOCK_INVPORT; return GSOCK_INVPORT; } addr = (struct sockaddr_in *)address->m_addr; addr->sin_port = se->s_port; return GSOCK_NOERROR; } GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port) { struct sockaddr_in *addr; assert(address != NULL); CHECK_ADDRESS(address, INET); addr = (struct sockaddr_in *)address->m_addr; addr->sin_port = htons(port); return GSOCK_NOERROR; } GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname, size_t sbuf) { struct hostent *he; char *addr_buf; struct sockaddr_in *addr; assert(address != NULL); CHECK_ADDRESS(address, INET); addr = (struct sockaddr_in *)address->m_addr; addr_buf = (char *)&(addr->sin_addr); he = gethostbyaddr(addr_buf, sizeof(addr->sin_addr), AF_INET); if (he == NULL) { address->m_error = GSOCK_NOHOST; return GSOCK_NOHOST; } strncpy(hostname, he->h_name, sbuf); return GSOCK_NOERROR; } unsigned long GAddress_INET_GetHostAddress(GAddress *address) { struct sockaddr_in *addr; assert(address != NULL); CHECK_ADDRESS_RETVAL(address, INET, 0); addr = (struct sockaddr_in *)address->m_addr; return ntohl(addr->sin_addr.s_addr); } unsigned short GAddress_INET_GetPort(GAddress *address) { struct sockaddr_in *addr; assert(address != NULL); CHECK_ADDRESS_RETVAL(address, INET, 0); addr = (struct sockaddr_in *)address->m_addr; return ntohs(addr->sin_port); } /* * ------------------------------------------------------------------------- * Unix address family * ------------------------------------------------------------------------- */ #ifndef __VISAGECPP__ GSocketError _GAddress_Init_UNIX(GAddress *address) { address->m_len = sizeof(struct sockaddr_un); address->m_addr = (struct sockaddr *)malloc(address->m_len); if (address->m_addr == NULL) { address->m_error = GSOCK_MEMERR; return GSOCK_MEMERR; } address->m_family = GSOCK_UNIX; address->m_realfamily = PF_UNIX; ((struct sockaddr_un *)address->m_addr)->sun_family = AF_UNIX; ((struct sockaddr_un *)address->m_addr)->sun_path[0] = 0; return GSOCK_NOERROR; } #define UNIX_SOCK_PATHLEN (sizeof(addr->sun_path)/sizeof(addr->sun_path[0])) GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path) { struct sockaddr_un *addr; assert(address != NULL); CHECK_ADDRESS(address, UNIX); addr = ((struct sockaddr_un *)address->m_addr); strncpy(addr->sun_path, path, UNIX_SOCK_PATHLEN); addr->sun_path[UNIX_SOCK_PATHLEN - 1] = '\0'; return GSOCK_NOERROR; } GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf) { struct sockaddr_un *addr; assert(address != NULL); CHECK_ADDRESS(address, UNIX); addr = (struct sockaddr_un *)address->m_addr; strncpy(path, addr->sun_path, sbuf); return GSOCK_NOERROR; } #endif /* !defined(__VISAGECPP__) */ #endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */