X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f42cff13eaba35dda3527b2ca658dd00b9e7a46..fcdd53359135f790b85728c4254b97095a56dad8:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 9d3dffd789..d17ce8f2ed 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,1888 +1,1904 @@ -//////////////////////////////////////////////////////////////////////////////// -// Name: socket.cpp +///////////////////////////////////////////////////////////////////////////// +// Name: src/common/socket.cpp // Purpose: Socket handler classes -// Authors: Guilhem Lavaux (completely rewritten from a basic API of Andrew -// Davidson(1995) in wxWeb) +// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia // Created: April 1997 -// Updated: March 1998 -// Copyright: (C) 1998, 1997, Guilhem Lavaux +// Copyright: (C) 1999-1997, Guilhem Lavaux +// (C) 1999-2000, Guillermo Rodriguez Garcia +// (C) 2008 Vadim Zeitlin // RCS_ID: $Id$ -// License: see wxWindows license -//////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "socket.h" -// #pragma interface -// #pragma implementation "socket.cpp" -#endif +// License: wxWindows licence +///////////////////////////////////////////////////////////////////////////// -#ifdef __MWERKS__ -typedef int socklen_t ; -#endif +// ========================================================================== +// Declarations +// ========================================================================== // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop -#endif - -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// -#include -#include -#include -#include -#include - -// Not enough OS behaviour defined for wxStubs -#ifndef __WXSTUBS__ - -#include -#include -#include - -///////////////////////////////////////////////////////////////////////////// -// System specific headers -///////////////////////////////////////////////////////////////////////////// -#ifdef __WXMAC__ -// in order to avoid problems with our c library and double definitions -#define close closesocket -#define ioctl ioctlsocket - -#include -extern GUSISpinFn GUSISpin; -#define PROCESS_EVENTS() wxMacProcessEvents() -const short kwxMacNetEventsMax = 1000 ; -short wxMacNetEventsTop = 0 ; -short wxMacNetEventsBottom = 0 ; -short wxMacNetEventsEvents[kwxMacNetEventsMax] ; -void *wxMacNetEventsReferences[kwxMacNetEventsMax] ; - -#define FD_READ 1 -#define FD_WRITE 2 -#define FD_CLOSE 4 -#define FD_ACCEPT 8 -#define FD_CONNECT 16 -#define FD_READY 32 - -extern "C" void wxMacSocketHandlerProc( void *refcon , short event ) ; // adds events -extern "C" void wxMacSocketOnRequestProc( void *refcon , short event ) ; // consumes them -extern "C" void GUSISetReference( short sock , short eventmask , void * data ) ; -void wxMacProcessEvents() ; -#endif - -#if defined(__WINDOWS__) -#include -#endif // __WINDOWS__ - -#if defined(__UNIX__) - -#ifdef VMS -#include -#else -#include -#endif -#include - -#include -#include - -#ifdef sun -#include + #pragma hdrstop #endif -#endif // __UNIX__ +#if wxUSE_SOCKETS -#include -#include - -#ifdef __VISUALC__ -#include -#endif - -#if defined(__WXMOTIF__) || defined(__WXXT__) -#include - -///////////////////////////// -// Needs internal variables -///////////////////////////// -#ifdef __WXXT__ -#define Uses_XtIntrinsic -#endif - -#endif - -#if defined(__WXGTK__) -#include -#endif - -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// -#include "wx/module.h" -#define WXSOCK_INTERNAL -#include "wx/sckaddr.h" #include "wx/socket.h" -///////////////////////////////////////////////////////////////////////////// -// Some patch ///// BEGIN -///////////////////////////////////////////////////////////////////////////// -#ifdef __WINDOWS__ -#define close closesocket -#define ioctl ioctlsocket -#ifdef errno -#undef errno -#endif -#define errno WSAGetLastError() -#ifdef EWOULDBLOCK -#undef EWOULDBLOCK -#endif -#define EWOULDBLOCK WSAEWOULDBLOCK -#define ETIMEDOUT WSAETIMEDOUT -#undef EINTR -#define EINTR WSAEINTR -#endif - -#ifndef __WINDOWS__ -#define INVALID_SOCKET -1 +#ifndef WX_PRECOMP + #include "wx/object.h" + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/event.h" + #include "wx/app.h" + #include "wx/utils.h" + #include "wx/timer.h" + #include "wx/module.h" #endif -#ifdef __WXMOTIF__ -#define wxAPP_CONTEXT ((XtAppContext)wxTheApp->GetAppContext()) -#endif - -#ifdef __WINDOWS__ -// This is an MS TCP/IP routine and is not needed here. Some WinSock -// implementations (such as PC-NFS) will require you to include this -// or a similar routine (see appendix in WinSock doc or help file). - -#if defined( NEED_WSAFDIsSet ) || defined( __VISUALC__ ) -int PASCAL FAR __WSAFDIsSet(SOCKET fd, fd_set FAR *set) -{ - int i = set->fd_count; +#include "wx/apptrait.h" +#include "wx/sckaddr.h" +#include "wx/stopwatch.h" +#include "wx/thread.h" +#include "wx/evtloop.h" - while (i--) - { - if (set->fd_array[i] == fd) - return 1; - } +#include "wx/private/fd.h" +#include "wx/private/socket.h" - return 0; -} -#endif -#endif +// DLL options compatibility check: +#include "wx/build.h" +WX_CHECK_BUILD_OPTIONS("wxNet") -#if defined(__WINDOWS__) -#define PROCESS_EVENTS() wxYield() -#elif defined(__WXXT__) || defined(__WXMOTIF__) -#define PROCESS_EVENTS() XtAppProcessEvent(wxAPP_CONTEXT, XtIMAll) -#elif defined(__WXGTK__) -#define PROCESS_EVENTS() gtk_main_iteration() -#endif +// -------------------------------------------------------------------------- +// macros and constants +// -------------------------------------------------------------------------- -///////////////////////////////////////////////////////////////////////////// -// Some patch ///// END -///////////////////////////////////////////////////////////////////////////// +// discard buffer +#define MAX_DISCARD_SIZE (10 * 1024) -#ifdef GetClassInfo -#undef GetClassInfo -#endif +#define wxTRACE_Socket _T("wxSocket") -// -------------------------------------------------------------- -// Module -// -------------------------------------------------------------- -class wxSocketModule: public wxModule -{ - DECLARE_DYNAMIC_CLASS(wxSocketModule) -public: - wxSocketModule() {} - bool OnInit(); - void OnExit(); -}; +// -------------------------------------------------------------------------- +// wxWin macros +// -------------------------------------------------------------------------- -// -------------------------------------------------------------- -// ClassInfos -// -------------------------------------------------------------- -#if !USE_SHARED_LIBRARY IMPLEMENT_CLASS(wxSocketBase, wxObject) IMPLEMENT_CLASS(wxSocketServer, wxSocketBase) IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) -IMPLEMENT_CLASS(wxSocketHandler, wxObject) +IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase) IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) -IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) -#endif -class wxSockWakeUp : public wxTimer +// -------------------------------------------------------------------------- +// private classes +// -------------------------------------------------------------------------- + +class wxSocketState : public wxObject { public: - int *my_id; - int n_val; - wxSocketBase *sock; + wxSocketFlags m_flags; + wxSocketEventFlags m_eventmask; + bool m_notify; + void *m_clientData; - wxSockWakeUp(wxSocketBase *_sock, int *id, int new_val) - { - my_id = id; n_val = new_val; - sock = _sock; - } - virtual void Notify() - { - *my_id = n_val; - if (sock) sock->Notify(FALSE); - } +public: + wxSocketState() : wxObject() {} + + DECLARE_NO_COPY_CLASS(wxSocketState) }; -/// Socket request -class SockRequest : public wxObject +// Conditionally make the socket non-blocking for the lifetime of this object. +class wxSocketUnblocker { public: - char *buffer; - size_t size, nbytes; - bool done; - int error; - wxSockWakeUp *auto_wakeup; - wxSocketBase::wxRequestNotify type; -}; + wxSocketUnblocker(wxSocketImpl *socket, bool unblock = true) + : m_impl(socket), + m_unblock(unblock) + { + if ( m_unblock ) + m_impl->SetNonBlocking(true); + } + ~wxSocketUnblocker() + { + if ( m_unblock ) + m_impl->SetNonBlocking(false); + } -///////////////////////////////////////////////////////////////////////////// -// Some internal define -///////////////////////////////////////////////////////////////////////////// +private: + wxSocketImpl * const m_impl; + bool m_unblock; -// -------------------------------------------------------------- -// --------- wxSocketBase CONSTRUCTOR --------------------------- -// -------------------------------------------------------------- -wxSocketBase::wxSocketBase(wxSocketBase::wxSockFlags _flags, - wxSocketBase::wxSockType _type) : - wxEvtHandler(), - m_flags(_flags), m_type(_type), m_connected(FALSE), m_connecting(FALSE), - m_fd(INVALID_SOCKET), m_waitflags(0), m_cbk(0), m_cdata(0), m_id(-1), - m_handler(0), - m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)), - m_cbkon(FALSE), - m_unread(NULL), m_unrd_size(0), - m_processing(FALSE), - m_timeout(3600), m_wantbuf(0) -{ - m_internal = new wxSockInternal; -#if defined(__WXXT__) || defined(__WXMOTIF__) || defined(__WXGTK__) - m_internal->sock_inputid = 0; - m_internal->sock_outputid = 0; - m_internal->sock_exceptid = 0; -#endif -#ifdef __WINDOWS__ - m_internal->my_msg = 0; -#endif -} + DECLARE_NO_COPY_CLASS(wxSocketUnblocker) +}; -wxSocketBase::wxSocketBase() : - wxEvtHandler(), - m_flags(WAITALL), m_type(SOCK_UNINIT), m_connected(FALSE), - m_connecting(FALSE), m_fd(INVALID_SOCKET), m_waitflags(0), - m_cbk(0), m_cdata(0), - m_id(-1), m_handler(0), - m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)), - m_cbkon(FALSE), - m_unread(NULL), m_unrd_size(0), - m_processing(FALSE), - m_timeout(3600), m_wantbuf(0) -{ - m_internal = new wxSockInternal; -#if defined(__WXXT__) || defined(__WXMOTIF__) || defined(__WXGTK__) - m_internal->sock_inputid = 0; - m_internal->sock_outputid = 0; - m_internal->sock_exceptid = 0; -#endif -#ifdef __WINDOWS__ - m_internal->my_msg = 0; -#endif -} +// ============================================================================ +// wxSocketManager +// ============================================================================ -// -------------------------------------------------------------- -// wxSocketBase -// -------------------------------------------------------------- +wxSocketManager *wxSocketManager::ms_manager = NULL; -wxSocketBase::~wxSocketBase() +/* static */ +void wxSocketManager::Set(wxSocketManager *manager) { - DestroyCallbacks(); - Close(); - - if (m_unread) - free(m_unread); - if (m_handler) - { -#ifdef __WINDOWS__ - if (m_internal->my_msg) - m_handler->DestroyMessage(m_internal->my_msg); -#endif - m_handler->UnRegister(this); - } - m_states.DeleteContents(TRUE); + wxASSERT_MSG( !ms_manager, "too late to set manager now" ); - delete m_internal; + ms_manager = manager; } -bool wxSocketBase::Close() +/* static */ +void wxSocketManager::Init() { - if (m_fd != INVALID_SOCKET) - { - for (int i=0;i<3;i++) - { - wxNode *n, *node = req_list[i].First(); + wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" ); - while (node) - { - SockRequest *req = (SockRequest *)node->Data(); - req->done = TRUE; + /* + Details: Initialize() creates a hidden window as a sink for socket + events, such as 'read completed'. wxMSW has only one message loop + for the main thread. If Initialize is called in a secondary thread, + the socket window will be created for the secondary thread, but + since there is no message loop on this thread, it will never + receive events and all socket operations will time out. + BTW, the main thread must not be stopped using sleep or block + on a semaphore (a bad idea in any case) or socket operations + will time out. - n = node->Next(); - delete node; - node = n; - } - } + On the Mac side, Initialize() stores a pointer to the CFRunLoop for + the main thread. Because secondary threads do not have run loops, + adding event notifications to the "Current" loop would have no + effect at all, events would never fire. + */ + wxASSERT_MSG( wxIsMainThread(), + "sockets must be initialized from the main thread" ); - DestroyCallbacks(); - shutdown(m_fd, 2); - close(m_fd); - m_fd = INVALID_SOCKET; - m_connected = FALSE; - } + wxAppConsole * const app = wxAppConsole::GetInstance(); + wxCHECK_RET( app, "sockets can't be initialized without wxApp" ); - return TRUE; + ms_manager = app->GetTraits()->GetSocketManager(); } -// -------------------------------------------------------------- -// wxSocketBase base IO function -// -------------------------------------------------------------- +// ========================================================================== +// wxSocketImpl +// ========================================================================== -wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes) +wxSocketImpl::wxSocketImpl(wxSocketBase& wxsocket) + : m_wxsocket(&wxsocket) { - m_lcount = GetPushback(buffer, nbytes, FALSE); - nbytes -= m_lcount; - - // If we have got the whole needed buffer or if we don't want to - // wait then it returns immediately. - if (!nbytes || (m_lcount && !(m_flags & WAITALL)) ) - return *this; + m_fd = INVALID_SOCKET; + m_detected = 0; + m_local = NULL; + m_peer = NULL; + m_error = wxSOCKET_NOERROR; + m_server = false; + m_stream = true; + m_non_blocking = false; - WantBuffer(buffer, nbytes, EVT_READ); + SetTimeout(wxsocket.GetTimeout() * 1000); - return *this; + m_establishing = false; + m_reusable = false; + m_broadcast = false; + m_dobind = true; + m_initialRecvBufferSize = -1; + m_initialSendBufferSize = -1; } -wxSocketBase& wxSocketBase::Peek(char* buffer, size_t nbytes) +wxSocketImpl::~wxSocketImpl() { - size_t nbytes_old = nbytes; + if (m_fd != INVALID_SOCKET) + Shutdown(); - nbytes -= GetPushback(buffer, nbytes, TRUE); - if (!nbytes) - { - m_lcount = nbytes_old; - return *this; - } + if (m_local) + GAddress_destroy(m_local); - WantBuffer(buffer, nbytes, EVT_PEEK); - - return *this; + if (m_peer) + GAddress_destroy(m_peer); } -wxSocketBase& wxSocketBase::Write(const char *buffer, size_t nbytes) +bool wxSocketImpl::PreCreateCheck(GAddress *addr) { - WantBuffer((char *)buffer, nbytes, EVT_WRITE); - return *this; + if ( m_fd != INVALID_SOCKET ) + { + m_error = wxSOCKET_INVSOCK; + return false; + } + + if ( !addr || !addr->m_addr ) + { + m_error = wxSOCKET_INVADDR; + return false; + } + + return true; } -wxSocketBase& wxSocketBase::ReadMsg(char* buffer, size_t nbytes) +void wxSocketImpl::PostCreation() { - SockMsg msg; - size_t len, len2, sig; + // FreeBSD variants can't use MSG_NOSIGNAL, and instead use a socket option +#ifdef SO_NOSIGPIPE + EnableSocketOption(SO_NOSIGPIPE); +#endif - Read((char *)&msg, sizeof(msg)); - if (m_lcount != sizeof(msg)) - return *this; + if ( m_reusable ) + EnableSocketOption(SO_REUSEADDR); - sig = msg.sig[0] & 0xff; - sig |= (size_t)(msg.sig[1] & 0xff) << 8; - sig |= (size_t)(msg.sig[2] & 0xff) << 16; - sig |= (size_t)(msg.sig[3] & 0xff) << 24; + if ( m_broadcast ) + { + wxASSERT_MSG( !m_stream, "broadcasting is for datagram sockets only" ); - if (sig != 0xfeeddead) - return *this; - len = msg.len[0] & 0xff; - len |= (size_t)(msg.len[1] & 0xff) << 8; - len |= (size_t)(msg.len[2] & 0xff) << 16; - len |= (size_t)(msg.len[3] & 0xff) << 24; - len2 = len; - if (len > nbytes) - len = nbytes; - else - len2 = 0; - - if (Read(buffer, len).LastCount() != len) - return *this; - if (len2 && (Read(NULL, len2).LastCount() != len2)) - return *this; - if (Read((char *)&msg, sizeof(msg)).LastCount() != sizeof(msg)) - return *this; + EnableSocketOption(SO_BROADCAST); + } - sig = msg.sig[0] & 0xff; - sig |= (size_t)(msg.sig[1] & 0xff) << 8; - sig |= (size_t)(msg.sig[2] & 0xff) << 16; - sig |= (size_t)(msg.sig[3] & 0xff) << 24; -// ERROR - if (sig != 0xdeadfeed) - return *this; + if ( m_initialRecvBufferSize >= 0 ) + SetSocketOption(SO_RCVBUF, m_initialRecvBufferSize); + if ( m_initialSendBufferSize >= 0 ) + SetSocketOption(SO_SNDBUF, m_initialSendBufferSize); - return *this; + // FIXME: shouldn't we check for m_non_blocking here? as it is now, all our + // sockets are non-blocking + UnblockAndRegisterWithEventLoop(); } -wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, size_t nbytes) +wxSocketError wxSocketImpl::UpdateLocalAddress() { - SockMsg msg; + WX_SOCKLEN_T lenAddr; + if ( getsockname(m_fd, m_local->m_addr, &lenAddr) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } - // warning about 'cast truncates constant value' -#ifdef __VISUALC__ - #pragma warning(disable: 4310) -#endif // __VISUALC__ + m_local->m_len = lenAddr; - msg.sig[0] = (char) 0xad; - msg.sig[1] = (char) 0xde; - msg.sig[2] = (char) 0xed; - msg.sig[3] = (char) 0xfe; + return wxSOCKET_NOERROR; +} - msg.len[0] = (char) nbytes & 0xff; - msg.len[1] = (char) (nbytes >> 8) & 0xff; - msg.len[2] = (char) (nbytes >> 16) & 0xff; - msg.len[3] = (char) (nbytes >> 24) & 0xff; +wxSocketError wxSocketImpl::CreateServer() +{ + if ( !PreCreateCheck(m_local) ) + return m_error; - if (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg)) - return *this; - if (Write(buffer, nbytes).LastCount() < nbytes) - return *this; + m_server = true; + m_stream = true; - msg.sig[0] = (char) 0xed; - msg.sig[1] = (char) 0xfe; - msg.sig[2] = (char) 0xad; - msg.sig[3] = (char) 0xde; - msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = (char) 0; - Write((char *)&msg, sizeof(msg)); + // do create the socket + m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0); - return *this; + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } -#ifdef __VISUALC__ - #pragma warning(default: 4310) -#endif // __VISUALC__ -} + PostCreation(); -wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes) -{ - CreatePushbackAfter(buffer, nbytes); - return *this; -} + // and then bind to and listen on it + // + // FIXME: should we test for m_dobind here? + if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 ) + m_error = wxSOCKET_IOERR; -bool wxSocketBase::IsData() const -{ - struct timeval tv; - fd_set sock_set; + if ( IsOk() ) + { + if ( listen(m_fd, 5) != 0 ) + m_error = wxSOCKET_IOERR; + } - if (m_fd < 0) - return FALSE; - if (m_unrd_size > 0) - return TRUE; + if ( !IsOk() ) + { + Close(); + return m_error; + } - tv.tv_sec = 0; - tv.tv_usec = 0; - FD_ZERO(&sock_set); - FD_SET(m_fd, &sock_set); - select(FD_SETSIZE, &sock_set, NULL, NULL, &tv); - return (FD_ISSET(m_fd, &sock_set) != 0); + // finally retrieve the address we effectively bound to + return UpdateLocalAddress(); } -// --------------------------------------------------------------------- -// --------- wxSocketBase Discard(): deletes all byte in the input queue -// --------------------------------------------------------------------- -void wxSocketBase::Discard() +wxSocketError wxSocketImpl::CreateClient() { -#define MAX_BUFSIZE (10*1024) - char *my_data = new char[MAX_BUFSIZE]; - size_t recv_size = MAX_BUFSIZE; + if ( !PreCreateCheck(m_peer) ) + return m_error; - SaveState(); - SetFlags((wxSockFlags)(NOWAIT | SPEED)); + m_fd = socket(m_peer->m_realfamily, SOCK_STREAM, 0); - while (recv_size == MAX_BUFSIZE) - { - recv_size = Read(my_data, MAX_BUFSIZE).LastCount(); - } + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } + + PostCreation(); - RestoreState(); - delete [] my_data; + // If a local address has been set, then bind to it before calling connect + if ( m_local && m_local->m_addr ) + { + if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } + } -#undef MAX_BUFSIZE + // Connect to the peer and handle the EWOULDBLOCK return value in + // platform-specific code + return DoHandleConnect(connect(m_fd, m_peer->m_addr, m_peer->m_len)); } -// If what? Who seems to need unsigned int? -// BTW uint isn't even defined on wxMSW for VC++ for some reason. Even if it -// were, getpeername/getsockname don't take unsigned int*, they take int*. -// -// Under glibc 2.0.7, socketbits.h declares socklen_t to be unsigned int -// and it uses *socklen_t as the 3rd parameter. Robert. -// JACS - How can we detect this? -// Meanwhile, if your compiler complains about socklen_t, -// switch lines below. +wxSocketError wxSocketImpl::CreateUDP() +{ + if ( !PreCreateCheck(m_local) ) + return m_error; -#if wxHAVE_GLIBC2 -# define wxSOCKET_INT socklen_t -#else -# define wxSOCKET_INT int -#endif + m_stream = false; + m_server = false; -// -------------------------------------------------------------- -// wxSocketBase socket info functions -// -------------------------------------------------------------- + m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0); -bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const -{ - struct sockaddr my_addr; - wxSOCKET_INT len_addr = sizeof(my_addr); + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } - if (m_fd < 0) - return FALSE; + PostCreation(); - if (getpeername(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) - return FALSE; + if ( m_dobind ) + { + if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } + + return UpdateLocalAddress(); + } - addr_man.Disassemble(&my_addr, len_addr); - return TRUE; + return wxSOCKET_NOERROR; } -bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const + +void wxSocketImpl::Close() { - struct sockaddr my_addr; - wxSOCKET_INT len_addr = sizeof(my_addr); + if ( m_fd != INVALID_SOCKET ) + { + DoClose(); + m_fd = INVALID_SOCKET; + } +} - if (m_fd < 0) - return FALSE; +/* + * Disallow further read/write operations on this socket, close + * the fd and disable all callbacks. + */ +void wxSocketImpl::Shutdown() +{ + if ( m_fd != INVALID_SOCKET ) + { + shutdown(m_fd, 1 /* SD_SEND */); + Close(); + } - if (getsockname(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) + m_detected = wxSOCKET_LOST_FLAG; +} - return FALSE; +/* + * Sets the timeout for blocking calls. Time is expressed in + * milliseconds. + */ +void wxSocketImpl::SetTimeout(unsigned long millis) +{ + m_timeout.tv_sec = (millis / 1000); + m_timeout.tv_usec = (millis % 1000) * 1000; +} - addr_man.Disassemble(&my_addr, len_addr); - return TRUE; +void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event) +{ + m_wxsocket->OnRequest(event); } -// -------------------------------------------------------------- -// wxSocketBase wait functions -// -------------------------------------------------------------- +/* Address handling */ -void wxSocketBase::SaveState() -{ - wxSockState *state = new wxSockState; +/* + * Set or get the local or peer address for this socket. The 'set' + * functions return wxSOCKET_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 socket. + * + * Error codes: + * wxSOCKET_INVSOCK - the socket is not valid. + * wxSOCKET_INVADDR - the address is not valid. + */ +wxSocketError wxSocketImpl::SetLocal(GAddress *address) +{ + /* the socket must be initialized, or it must be a server */ + if (m_fd != INVALID_SOCKET && !m_server) + { + m_error = wxSOCKET_INVSOCK; + return wxSOCKET_INVSOCK; + } + + /* check address */ + if (address == NULL || address->m_family == wxSOCKET_NOFAMILY) + { + m_error = wxSOCKET_INVADDR; + return wxSOCKET_INVADDR; + } + + if (m_local) + GAddress_destroy(m_local); - state->cbk_on = m_cbkon; - state->cbk_set= m_neededreq; - state->cbk = m_cbk; - state->cdata = m_cdata; - state->flags = m_flags; - state->notif = m_notifyme; + m_local = GAddress_copy(address); - m_states.Append(state); + return wxSOCKET_NOERROR; } -void wxSocketBase::RestoreState() +wxSocketError wxSocketImpl::SetPeer(GAddress *address) { - wxNode *node; - - node = m_states.Last(); - if (!node) - return; + /* check address */ + if (address == NULL || address->m_family == wxSOCKET_NOFAMILY) + { + m_error = wxSOCKET_INVADDR; + return wxSOCKET_INVADDR; + } - wxSockState *state = (wxSockState *)node->Data(); + if (m_peer) + GAddress_destroy(m_peer); - SetFlags(state->flags); - m_neededreq = state->cbk_set; - m_cbk = state->cbk; - m_cdata = state->cdata; - m_notifyme = state->notif; - if (state->cbk_on) - SetupCallbacks(); - else - DestroyCallbacks(); + m_peer = GAddress_copy(address); - delete node; - delete state; + return wxSOCKET_NOERROR; } -// -------------------------------------------------------------- -// --------- wxSocketBase wait functions ------------------------ -// -------------------------------------------------------------- - -bool wxSocketBase::_Wait(long seconds, long microseconds, int type) +GAddress *wxSocketImpl::GetLocal() { - if ((!m_connected && !m_connecting) || m_fd < 0) - return FALSE; + GAddress *address; + wxSockAddr addr; + WX_SOCKLEN_T size = sizeof(addr); + wxSocketError err; - wxSockWakeUp wakeup(this, &m_waitflags, 0); + /* try to get it from the m_local var first */ + if (m_local) + return GAddress_copy(m_local); - SaveState(); - SetNotify((wxRequestNotify)type); - SetupCallbacks(); - - if (seconds != -1) - wakeup.Start((int)(seconds*1000 + (microseconds / 1000)), TRUE); + /* else, if the socket is initialized, try getsockname */ + if (m_fd == INVALID_SOCKET) + { + m_error = wxSOCKET_INVSOCK; + return NULL; + } - m_waitflags = 0x80 | type; - while (m_waitflags & 0x80) - PROCESS_EVENTS(); + if (getsockname(m_fd, (sockaddr*)&addr, &size) == SOCKET_ERROR) + { + m_error = wxSOCKET_IOERR; + return NULL; + } - RestoreState(); + /* got a valid address from getsockname, create a GAddress object */ + if ((address = GAddress_new()) == NULL) + { + m_error = wxSOCKET_MEMERR; + return NULL; + } - if (m_waitflags & 0x40) + if ((err = _GAddress_translate_from(address, (sockaddr*)&addr, size)) != wxSOCKET_NOERROR) { - m_waitflags = 0; - return TRUE; + GAddress_destroy(address); + m_error = err; + return NULL; } - m_waitflags = 0; - return FALSE; + return address; } -bool wxSocketBase::Wait(long seconds, long microseconds) +GAddress *wxSocketImpl::GetPeer() { - return _Wait(seconds, microseconds, REQ_ACCEPT | REQ_CONNECT | - REQ_READ | REQ_WRITE | REQ_LOST); -} + /* try to get it from the m_peer var */ + if (m_peer) + return GAddress_copy(m_peer); -bool wxSocketBase::WaitForRead(long seconds, long microseconds) -{ - return _Wait(seconds, microseconds, REQ_READ | REQ_LOST); + return NULL; } -bool wxSocketBase::WaitForWrite(long seconds, long microseconds) -{ - return _Wait(seconds, microseconds, REQ_WRITE); -} +// ========================================================================== +// wxSocketBase +// ========================================================================== + +// -------------------------------------------------------------------------- +// Initialization and shutdown +// -------------------------------------------------------------------------- + +// FIXME-MT: all this is MT-unsafe, of course, we should protect all accesses +// to m_countInit with a crit section +size_t wxSocketBase::m_countInit = 0; -bool wxSocketBase::WaitForLost(long seconds, long microseconds) +bool wxSocketBase::IsInitialized() { - return _Wait(seconds, microseconds, REQ_LOST); + return m_countInit > 0; } -// -------------------------------------------------------------- -// --------- wxSocketBase callback management ------------------- -// -------------------------------------------------------------- - -#if defined(__WXMOTIF__) || defined(__WXXT__) || defined(__WXGTK__) -#if defined(__WXMOTIF__) || defined(__WXXT__) -static void wx_socket_read(XtPointer client, int *fid, - XtInputId *WXUNUSED(id)) -#define fd *fid -#else -static void wx_socket_read(gpointer client, gint fd, - GdkInputCondition WXUNUSED(cond)) -#define fd fd -#endif +bool wxSocketBase::Initialize() { - wxSocketBase *sock = (wxSocketBase *)client; - char c; - int i; + if ( !m_countInit++ ) + { + wxSocketManager * const manager = wxSocketManager::Get(); + if ( !manager || !manager->OnInit() ) + { + m_countInit--; - i = recv(fd, &c, 1, MSG_PEEK); + return false; + } + } - if (i == -1 && (sock->NeededReq() & wxSocketBase::REQ_ACCEPT)) - { - sock->OnRequest(wxSocketBase::EVT_ACCEPT); - return; - } + return true; +} - if (i != 0) - { - if (!(sock->NeededReq() & wxSocketBase::REQ_READ)) +void wxSocketBase::Shutdown() +{ + // we should be initialized + wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") ); + if ( --m_countInit == 0 ) { - return; + wxSocketManager * const manager = wxSocketManager::Get(); + wxCHECK_RET( manager, "should have a socket manager" ); + + manager->OnExit(); } +} - sock->OnRequest(wxSocketBase::EVT_READ); - } - else - { - if (!(sock->NeededReq() & wxSocketBase::REQ_LOST)) +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- + +void wxSocketBase::Init() +{ + m_impl = NULL; + m_type = wxSOCKET_UNINIT; + + // state + m_flags = 0; + m_connected = + m_establishing = + m_reading = + m_writing = + m_error = + m_closed = false; + m_lcount = 0; + m_timeout = 600; + m_beingDeleted = false; + + // pushback buffer + m_unread = NULL; + m_unrd_size = 0; + m_unrd_cur = 0; + + // events + m_id = wxID_ANY; + m_handler = NULL; + m_clientData = NULL; + m_notify = false; + m_eventmask = 0; + + if ( !IsInitialized() ) { - sock->Close(); - return; + // this Initialize() will be undone by wxSocketModule::OnExit(), all + // the other calls to it should be matched by a call to Shutdown() + Initialize(); } - - sock->OnRequest(wxSocketBase::EVT_LOST); - } } -#undef fd -#if defined(__WXMOTIF__) || defined(__WXXT__) -static void wx_socket_write(XtPointer client, int *WXUNUSED(fid), - XtInputId *WXUNUSED(id)) -#else -static void wx_socket_write(gpointer client, gint WXUNUSED(fd), - GdkInputCondition WXUNUSED(cond)) -#endif +wxSocketBase::wxSocketBase() { - wxSocketBase *sock = (wxSocketBase *)client; - - if (!sock->IsConnected()) - sock->OnRequest(wxSocketBase::EVT_CONNECT); - else - sock->OnRequest(wxSocketBase::EVT_WRITE); + Init(); } -#endif -#ifdef wx_xview -Notify_value wx_sock_read_xview (Notify_client client, int fd) +wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type) { - wxSocketBase *sock = (wxSocketBase *)client; - char c; - int i; + Init(); - i = recv(fd, &c, 1, MSG_PEEK); + SetFlags(flags); - if (i == -1 && (sock->NeededReq() & wxSocketBase::REQ_ACCEPT)) - { - sock->OnRequest(wxSocketBase::EVT_ACCEPT); - return; - } + m_type = type; +} - /* Bytes arrived */ - if (i != 0) - { - if (!(sock->NeededReq() & wxSocketBase::REQ_READ)) - return (Notify_value) FALSE; +wxSocketBase::~wxSocketBase() +{ + // Just in case the app called Destroy() *and* then deleted the socket + // immediately: don't leave dangling pointers. + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) + traits->RemoveFromPendingDelete(this); - sock->OnRequest(wxSocketBase::EVT_READ); - } - else - { - if (!(sock->NeededReq() & wxSocketBase::REQ_LOST)) - return; + // Shutdown and close the socket + if (!m_beingDeleted) + Close(); - sock->OnRequest(wxSocketBase::EVT_LOST); - } + // Destroy the implementation object + delete m_impl; - return (Notify_value) FALSE; + // Free the pushback buffer + if (m_unread) + free(m_unread); } -Notify_value wx_sock_write_xview (Notify_client client, int fd) +bool wxSocketBase::Destroy() { - wxSocketBase *sock = (wxSocketBase *)client; + // Delayed destruction: the socket will be deleted during the next idle + // loop iteration. This ensures that all pending events have been + // processed. + m_beingDeleted = true; - if (!sock->IsConnected()) - sock->OnRequest(wxSocketBase::EVT_CONNECT); - else - sock->OnRequest(wxSocketBase::EVT_WRITE); + // Shutdown and close the socket + Close(); + + // Supress events from now on + Notify(false); + + // schedule this object for deletion + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) + { + // let the traits object decide what to do with us + traits->ScheduleForDestroy(this); + } + else // no app or no traits + { + // in wxBase we might have no app object at all, don't leak memory + delete this; + } - return (Notify_value) TRUE; + return true; } -#endif -wxSocketBase::wxRequestNotify wxSocketBase::EventToNotify(wxRequestEvent evt) +// ---------------------------------------------------------------------------- +// simply accessors +// ---------------------------------------------------------------------------- + +wxSocketError wxSocketBase::LastError() const { - switch (evt) - { - case EVT_READ: - return REQ_READ; - case EVT_PEEK: - return REQ_PEEK; - case EVT_WRITE: - return REQ_WRITE; - case EVT_LOST: - return REQ_LOST; - case EVT_ACCEPT: - return REQ_ACCEPT; - case EVT_CONNECT: - return REQ_CONNECT; - } - return 0; + return m_impl->GetError(); } -void wxSocketBase::SetFlags(wxSockFlags _flags) +// -------------------------------------------------------------------------- +// Basic IO calls +// -------------------------------------------------------------------------- + +// The following IO operations update m_error and m_lcount: +// {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard} +// +// TODO: Should Connect, Accept and AcceptWith update m_error? + +bool wxSocketBase::Close() { - m_flags = _flags; - if (_flags & SPEED) - { - unsigned long flag = 0; - ioctl(m_fd, FIONBIO, &flag); + // Interrupt pending waits + InterruptWait(); - // SPEED and WAITALL are antagonists. - m_flags = (wxSockFlags)(m_flags & ~WAITALL); + if (m_impl) + m_impl->Shutdown(); - Notify(FALSE); - } - else - { - unsigned long flag = 1; - ioctl(m_fd, FIONBIO, &flag); - } + m_connected = false; + m_establishing = false; + return true; } -void wxSocketBase::SetNotify(wxRequestNotify flags) +wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { - wxRequestNotify old_needed_req = m_neededreq; - if (flags & REQ_ACCEPT) - { - /* Check if server */ - if (!(GetClassInfo()->IsKindOf(CLASSINFO(wxSocketServer)))) - flags &= ~REQ_ACCEPT; - } - m_neededreq = flags; + // Mask read events + m_reading = true; -/* - if (m_cbkon && old_needed_req != flags) seems to be wrong, Robert Roebling - SetupCallbacks(); -*/ + m_lcount = DoRead(buffer, nbytes); + + // If in wxSOCKET_WAITALL mode, all bytes should have been read. + if (m_flags & wxSOCKET_WAITALL) + m_error = (m_lcount != nbytes); + else + m_error = (m_lcount == 0); - if (old_needed_req != flags) - SetupCallbacks(); + // Allow read events from now on + m_reading = false; + + return *this; } -void wxSocketBase::SetupCallbacks() +wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) { - if (m_fd == INVALID_SOCKET || !m_handler || (m_flags & SPEED)) - return; + // We use pointer arithmetic here which doesn't work with void pointers. + char *buffer = static_cast(buffer_); -#if defined(__WXMOTIF__) || defined(__WXXT__) - if (m_neededreq & (REQ_ACCEPT | REQ_READ | REQ_LOST)) - { - if (m_internal->sock_inputid <= 0) + // Try the push back buffer first, even before checking whether the socket + // is valid to allow reading previously pushed back data from an already + // closed socket. + wxUint32 total = GetPushback(buffer, nbytes, false); + nbytes -= total; + buffer += total; + + // If it's indeed closed or if read everything, there is nothing more to do. + if ( !m_impl || !nbytes ) + return total; + + wxCHECK_MSG( buffer, 0, "NULL buffer" ); + + + // wxSOCKET_NOWAIT overrides all the other flags and means that we are + // polling the socket and don't block at all. + if ( m_flags & wxSOCKET_NOWAIT ) { - m_internal->sock_inputid = XtAppAddInput (wxAPP_CONTEXT, m_fd, - (XtPointer *) XtInputReadMask, - (XtInputCallbackProc) wx_socket_read, - (XtPointer) this); + wxSocketUnblocker unblock(m_impl); + int ret = m_impl->Read(buffer, nbytes); + if ( ret < 0 ) + return 0; + + total += ret; } - } - else - { - if (m_internal->sock_inputid > 0) + else // blocking socket { - XtRemoveInput(m_internal->sock_inputid); - m_internal->sock_inputid = 0; + for ( ;; ) + { + // Wait until socket becomes ready for reading dispatching the GUI + // events in the meanwhile unless wxSOCKET_BLOCK was explicitly + // specified to disable this. + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() ) + break; + + const int ret = m_impl->Read(buffer, nbytes); + if ( ret == 0 ) + { + // for connection-oriented (e.g. TCP) sockets we can only read + // 0 bytes if the other end has been closed, and for + // connectionless ones (UDP) this flag doesn't make sense + // anyhow so we can set it to true too without doing any harm + m_closed = true; + break; + } + + if ( ret < 0 ) + { + // this will be always interpreted as error by Read() + return 0; + } + + total += ret; + + // If wxSOCKET_WAITALL is not set, we can leave now as we did read + // something and we don't need to wait for all nbytes bytes to be + // read. + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + // Otherwise continue reading until we do read everything. + nbytes -= ret; + if ( !nbytes ) + break; + + buffer += ret; + } } - } - - if (m_neededreq & (REQ_CONNECT | REQ_WRITE)) - { - if (m_internal->sock_outputid <= 0) + + return total; +} + +wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) +{ + wxUint32 len, len2, sig, total; + bool error; + int old_flags; + struct { - m_internal->sock_outputid = XtAppAddInput (wxAPP_CONTEXT, m_fd, - (XtPointer *) XtInputWriteMask, - (XtInputCallbackProc) wx_socket_write, - (XtPointer) this); - } - } - else - { - if (m_internal->sock_outputid > 0) + unsigned char sig[4]; + unsigned char len[4]; + } msg; + + // Mask read events + m_reading = true; + + total = 0; + error = true; + old_flags = m_flags; + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); + + if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) + goto exit; + + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); + + if (sig != 0xfeeddead) { - XtRemoveInput(m_internal->sock_outputid); - m_internal->sock_outputid = 0; + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); + goto exit; } - } -#endif + len = (wxUint32)msg.len[0]; + len |= (wxUint32)(msg.len[1] << 8); + len |= (wxUint32)(msg.len[2] << 16); + len |= (wxUint32)(msg.len[3] << 24); -#ifdef __WXGTK__ - if (m_neededreq & (REQ_ACCEPT | REQ_READ | REQ_LOST)) - { - if (m_internal->sock_inputid <= 0) + if (len > nbytes) { - m_internal->sock_inputid = gdk_input_add(m_fd, GDK_INPUT_READ, - wx_socket_read, (gpointer)this); + len2 = len - nbytes; + len = nbytes; } - } - else - { - if (m_internal->sock_inputid > 0) + else + len2 = 0; + + // Don't attempt to read if the msg was zero bytes long. + if (len) { -/* - gdk_input_remove(m_internal->sock_inputid); - m_internal->sock_inputid = 0; -*/ + total = DoRead(buffer, len); + + if (total != len) + goto exit; } - } - - if (m_neededreq & (REQ_CONNECT | REQ_WRITE)) - { - if (m_internal->sock_outputid <= 0) + + if (len2) { - m_internal->sock_outputid = gdk_input_add(m_fd, GDK_INPUT_WRITE, - wx_socket_write, (gpointer)this); + char *discard_buffer = new char[MAX_DISCARD_SIZE]; + long discard_len; + + // NOTE: discarded bytes don't add to m_lcount. + do + { + discard_len = ((len2 > MAX_DISCARD_SIZE)? MAX_DISCARD_SIZE : len2); + discard_len = DoRead(discard_buffer, (wxUint32)discard_len); + len2 -= (wxUint32)discard_len; + } + while ((discard_len > 0) && len2); + + delete [] discard_buffer; + + if (len2 != 0) + goto exit; } - } - else - { - if (m_internal->sock_outputid > 0) + if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) + goto exit; + + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); + + if (sig != 0xdeadfeed) { -/* - gdk_input_remove(m_internal->sock_outputid); - m_internal->sock_outputid = 0; -*/ + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); + goto exit; } - } -#endif + // everything was OK + error = false; -#ifdef __WXMSW__ - WORD mask = 0; +exit: + m_error = error; + m_lcount = total; + m_reading = false; + SetFlags(old_flags); - if (m_neededreq & REQ_READ) - mask |= FD_READ; - if (m_neededreq & REQ_WRITE) - mask |= FD_WRITE; - if (m_neededreq & REQ_LOST) - mask |= FD_CLOSE; - if (m_neededreq & REQ_ACCEPT) - mask |= FD_ACCEPT; - if (m_neededreq & REQ_CONNECT) - mask |= FD_CONNECT; + return *this; +} - if (!m_internal->my_msg) - m_internal->my_msg = m_handler->NewMessage(this); - WSAAsyncSelect(m_fd, m_handler->GetHWND(), m_internal->my_msg, mask); -#endif -#ifdef __WXMAC__ - short mask = 0; - - if (m_neededreq & REQ_READ) - mask |= FD_READ; - if (m_neededreq & REQ_WRITE) - mask |= FD_WRITE; - if (m_neededreq & REQ_LOST) - mask |= FD_CLOSE; - if (m_neededreq & REQ_ACCEPT) - mask |= FD_ACCEPT; - if (m_neededreq & REQ_CONNECT) - mask |= FD_CONNECT; - - GUSISetReference( m_fd ,mask, this ) ; - unsigned long flag = 1; - ioctl(m_fd, FIONBIO, &flag); -#endif - m_cbkon = TRUE; - m_processing = FALSE; -} - -void wxSocketBase::DestroyCallbacks() -{ - if (!m_cbkon || !m_handler) - return; - - m_cbkon = FALSE; - m_processing = FALSE; -#if defined(__WXMOTIF__) || defined(__WXXT__) - if (m_internal->sock_inputid > 0) - XtRemoveInput(m_internal->sock_inputid); - m_internal->sock_inputid = 0; - if (m_internal->sock_outputid > 0) - XtRemoveInput(m_internal->sock_outputid); - m_internal->sock_outputid = 0; -#endif -#ifdef __WXGTK__ - if (m_internal->sock_inputid > 0) - gdk_input_remove(m_internal->sock_inputid); - m_internal->sock_inputid = 0; - if (m_internal->sock_outputid > 0) - gdk_input_remove(m_internal->sock_outputid); - m_internal->sock_outputid = 0; -#endif -#ifdef __WINDOWS__ - WSAAsyncSelect(m_fd, m_handler->GetHWND(), 0, 0); -#endif -#ifdef __WXMAC__ - GUSISetReference( m_fd , 0 , 0 ) ; - int bottom = wxMacNetEventsBottom ; - while ( wxMacNetEventsTop != bottom ) - { - // set all events that reference this socket to nil - if ( wxMacNetEventsReferences[bottom] == (void*) this ) - wxMacNetEventsReferences[bottom] = NULL ; - bottom++ ; - if ( bottom == kwxMacNetEventsMax ) - bottom = 0 ; - } - SetFlags( m_flags ) ; -#endif +wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) +{ + // Mask read events + m_reading = true; + + m_lcount = DoRead(buffer, nbytes); + Pushback(buffer, m_lcount); + + // If in wxSOCKET_WAITALL mode, all bytes should have been read. + if (m_flags & wxSOCKET_WAITALL) + m_error = (m_lcount != nbytes); + else + m_error = (m_lcount == 0); + + // Allow read events again + m_reading = false; + + return *this; } -void wxSocketBase::Notify(bool notify) +wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { - if (m_notifyme == notify) - return; - if (notify) - SetupCallbacks(); - else - DestroyCallbacks(); - m_notifyme = notify; + // Mask write events + m_writing = true; + + m_lcount = DoWrite(buffer, nbytes); + + // If in wxSOCKET_WAITALL mode, all bytes should have been written. + if (m_flags & wxSOCKET_WAITALL) + m_error = (m_lcount != nbytes); + else + m_error = (m_lcount == 0); + + // Allow write events again + m_writing = false; + + return *this; +} + +// This function is a mirror image of DoRead() except that it doesn't use the +// push back buffer, please see comments there +wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes) +{ + const char *buffer = static_cast(buffer_); + + // Return if there is nothing to read or the socket is (already?) closed. + if ( !m_impl || !nbytes ) + return 0; + + wxCHECK_MSG( buffer, 0, "NULL buffer" ); + + wxUint32 total = 0; + if ( m_flags & wxSOCKET_NOWAIT ) + { + wxSocketUnblocker unblock(m_impl); + const int ret = m_impl->Write(buffer, nbytes); + if ( ret > 0 ) + total += ret; + } + else // blocking socket + { + for ( ;; ) + { + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() ) + break; + + const int ret = m_impl->Write(buffer, nbytes); + if ( ret == 0 ) + { + m_closed = true; + break; + } + + if ( ret < 0 ) + return 0; + + total += ret; + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + nbytes -= ret; + if ( !nbytes ) + break; + + buffer += ret; + } + } + + return total; } -void wxSocketBase::OnRequest(wxRequestEvent req_evt) +wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) { - wxRequestNotify req_notif = EventToNotify(req_evt); + wxUint32 total; + bool error; + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; - // Mask the current event - SetNotify(m_neededreq & ~req_notif); - - if (req_evt <= EVT_WRITE && DoRequests(req_evt)) - return; + // Mask write events + m_writing = true; - if (m_waitflags & 0xF0) - { - // Wake up - if ((m_waitflags & 0x0F) == req_evt) - { - m_waitflags = 0x80; -#ifndef __WXGTK__ - DestroyCallbacks(); -#endif - } - return; - } + error = true; + total = 0; + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); - if (req_evt == EVT_LOST) - { - m_connected = FALSE; - Close(); - } - if (m_notifyme) - OldOnNotify(req_evt); + msg.sig[0] = (unsigned char) 0xad; + msg.sig[1] = (unsigned char) 0xde; + msg.sig[2] = (unsigned char) 0xed; + msg.sig[3] = (unsigned char) 0xfe; - // Unmask - SetNotify(m_neededreq | req_notif); -} + msg.len[0] = (unsigned char) (nbytes & 0xff); + msg.len[1] = (unsigned char) ((nbytes >> 8) & 0xff); + msg.len[2] = (unsigned char) ((nbytes >> 16) & 0xff); + msg.len[3] = (unsigned char) ((nbytes >> 24) & 0xff); -wxSocketEvent::wxSocketEvent(int id) - : wxEvent(id) -{ - wxEventType type = (wxEventType)wxEVT_SOCKET; + if (DoWrite(&msg, sizeof(msg)) < sizeof(msg)) + goto exit; - SetEventType(type); -} + total = DoWrite(buffer, nbytes); -void wxSocketBase::OldOnNotify(wxRequestEvent evt) -{ - wxSocketEvent event(m_id); + if (total < nbytes) + goto exit; - event.SetEventObject(this); - event.m_skevt = evt; - ProcessEvent(event); + msg.sig[0] = (unsigned char) 0xed; + msg.sig[1] = (unsigned char) 0xfe; + msg.sig[2] = (unsigned char) 0xad; + msg.sig[3] = (unsigned char) 0xde; + msg.len[0] = + msg.len[1] = + msg.len[2] = + msg.len[3] = (char) 0; - if (m_cbk) - m_cbk(*this, evt, m_cdata); -} + if ((DoWrite(&msg, sizeof(msg))) < sizeof(msg)) + goto exit; -// -------------------------------------------------------------- -// --------- wxSocketBase functions [Callback, CallbackData] ---- -// -------------------------------------------------------------- + // everything was OK + error = false; -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSocketBase::wxSockCbk _cbk) -{ - wxSockCbk old_cbk = m_cbk; +exit: + m_error = error; + m_lcount = total; + m_writing = false; - m_cbk = _cbk; - return old_cbk; + return *this; } -char *wxSocketBase::CallbackData(char *cdata_) +wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) { - char *old_cdata = m_cdata; + if (nbytes != 0) + Pushback(buffer, nbytes); - m_cdata = cdata_; - return old_cdata; + m_error = false; + m_lcount = nbytes; + + return *this; } -void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id) +wxSocketBase& wxSocketBase::Discard() { - SetNextHandler(&h_evt); - m_id = id; -} + char *buffer = new char[MAX_DISCARD_SIZE]; + wxUint32 ret; + wxUint32 total = 0; -// -------------------------------------------------------------- -// --------- wxSocketBase pushback library ---------------------- -// -------------------------------------------------------------- + // Mask read events + m_reading = true; -void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size) -{ - char *curr_pos; + SetFlags(wxSOCKET_NOWAIT); + + do + { + ret = DoRead(buffer, MAX_DISCARD_SIZE); + total += ret; + } + while (ret == MAX_DISCARD_SIZE); + + delete[] buffer; + m_lcount = total; + m_error = false; - m_unread = (char *) realloc(m_unread, m_unrd_size+size); - curr_pos = m_unread + m_unrd_size; + // Allow read events again + m_reading = false; - memcpy(curr_pos, buffer, size); - m_unrd_size += size; + return *this; } -void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size) -{ - char *curr_pos, *new_buf; +// -------------------------------------------------------------------------- +// Wait functions +// -------------------------------------------------------------------------- - new_buf = (char *) malloc(m_unrd_size+size); - curr_pos = new_buf + size; +/* + * 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. + */ +wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags) +{ + assert(this); + + wxSocketEventFlags result = 0; + fd_set readfds; + fd_set writefds; + fd_set exceptfds; + struct timeval tv; - memcpy(new_buf, buffer, size); - memcpy(curr_pos, m_unread, m_unrd_size); + if (m_fd == -1) + return (wxSOCKET_LOST_FLAG & flags); - free(m_unread); - m_unread = new_buf; - m_unrd_size += size; -} + /* Do not use a static struct, Linux can garble it */ + tv.tv_sec = 0; + tv.tv_usec = 0; -size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek) -{ - if (!m_unrd_size) - return 0; + wxFD_ZERO(&readfds); + wxFD_ZERO(&writefds); + wxFD_ZERO(&exceptfds); + wxFD_SET(m_fd, &readfds); + if (flags & wxSOCKET_OUTPUT_FLAG || flags & wxSOCKET_CONNECTION_FLAG) + wxFD_SET(m_fd, &writefds); + wxFD_SET(m_fd, &exceptfds); + + /* Check 'sticky' CONNECTION flag first */ + result |= wxSOCKET_CONNECTION_FLAG & m_detected; + + /* If we have already detected a LOST event, then don't try + * to do any further processing. + */ + if ((m_detected & wxSOCKET_LOST_FLAG) != 0) + { + m_establishing = false; + return (wxSOCKET_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 exceptions and errors */ + if (wxFD_ISSET(m_fd, &exceptfds)) + { + m_establishing = false; + m_detected = wxSOCKET_LOST_FLAG; + + /* LOST event: Abort any further processing */ + return (wxSOCKET_LOST_FLAG & flags); + } + + /* Check for readability */ + if (wxFD_ISSET(m_fd, &readfds)) + { + result |= wxSOCKET_INPUT_FLAG; + + if (m_server && m_stream) + { + /* This is a TCP server socket that detected a connection. + While the INPUT_FLAG is also set, it doesn't matter on + this kind of sockets, as we can only Accept() from them. */ + m_detected |= wxSOCKET_CONNECTION_FLAG; + } + } + + /* Check for writability */ + if (wxFD_ISSET(m_fd, &writefds)) + { + if (m_establishing && !m_server) + { + int error; + SOCKOPTLEN_T len = sizeof(error); + m_establishing = false; + getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len); - if (size > m_unrd_size) - size = m_unrd_size; - memcpy(buffer, m_unread, size); + if (error) + { + m_detected = wxSOCKET_LOST_FLAG; - if (!peek) { - m_unrd_size -= size; - if (!m_unrd_size) { - free(m_unread); - m_unread = NULL; + /* LOST event: Abort any further processing */ + return (wxSOCKET_LOST_FLAG & flags); + } + else + { + m_detected |= wxSOCKET_CONNECTION_FLAG; + } + } + else + { + result |= wxSOCKET_OUTPUT_FLAG; } } - return size; + return (result | m_detected) & flags; } -// -------------------------------------------------------------- -// --------- wxSocketBase "multi-thread" core ------------------- -// -------------------------------------------------------------- +// All Wait functions poll the socket using Select() to +// check for the specified combination of conditions, until one +// of these conditions become true, an error occurs, or the +// timeout elapses. The polling loop runs the event loop so that +// this won't block the GUI. -bool wxSocketBase::DoRequests(wxRequestEvent req_flag) +bool +wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) { - wxNode *node = req_list[req_flag].First(); - size_t len; - int ret; + wxCHECK_MSG( m_impl, false, "can't wait on invalid socket" ); - if (!node) - return FALSE; + // This can be set to true from Interrupt() to exit this function a.s.a.p. + m_interrupt = false; - SockRequest *req = (SockRequest *)node->Data(); - delete node; + // Use either the provided timeout or the default timeout value associated + // with this socket. + // + // TODO: allow waiting forever, see #9443 + const long timeout = seconds == -1 ? m_timeout * 1000 + : seconds * 1000 + milliseconds; + const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout; - switch (req->type) - { - case EVT_READ: - case EVT_PEEK: - ret = recv(m_fd, req->buffer, req->size, - (req->type == EVT_PEEK) ? MSG_PEEK : 0); - if (ret < 0) - { - req->error = errno; - req->done = TRUE; - break; - } - len = ret; - if ((len < req->size) && (m_flags & WAITALL)) + // Get the active event loop which we'll use for the message dispatching + // when running in the main thread + wxEventLoopBase *eventLoop; + if ( wxIsMainThread() ) { - req->size -= len; - req->nbytes += len; - req->buffer += len; - req->auto_wakeup->Start(m_timeout*1000, TRUE); - req_list[req_flag].Insert(req); - break; + eventLoop = wxEventLoop::GetActive(); } - req->done = TRUE; - req->nbytes += len; -#ifndef __WXGTK__ - DestroyCallbacks(); -#endif - break; - case EVT_WRITE: - ret = send(m_fd, req->buffer, req->size, 0); - if (ret < 0) + else // in worker thread { - req->error = errno; - req->done = TRUE; - break; + // We never dispatch messages from threads other than the main one. + eventLoop = NULL; } - len = ret; - if ((len < req->size) && (m_flags & WAITALL)) + + // Wait in an active polling loop: notice that the loop is executed at + // least once, even if timeout is 0 (i.e. polling). + bool gotEvent = false; + for ( ;; ) { - req->size -= len; - req->nbytes += len; - req->buffer += len; - req->auto_wakeup->Start(m_timeout*1000, TRUE); - req_list[req_flag].Insert(req); - break; + // We always stop waiting when the connection is lost as it doesn't + // make sense to continue further, even if wxSOCKET_LOST_FLAG is not + // specified in flags to wait for. + const wxSocketEventFlags + result = m_impl->Select(flags | wxSOCKET_LOST_FLAG); + + // Incoming connection (server) or connection established (client)? + if ( result & wxSOCKET_CONNECTION_FLAG ) + { + m_connected = true; + m_establishing = false; + gotEvent = true; + break; + } + + // Data available or output buffer ready? + if ( (result & wxSOCKET_INPUT_FLAG) || (result & wxSOCKET_OUTPUT_FLAG) ) + { + gotEvent = true; + break; + } + + // Connection lost + if ( result & wxSOCKET_LOST_FLAG ) + { + m_connected = false; + m_establishing = false; + if ( flags & wxSOCKET_LOST_FLAG ) + gotEvent = true; + break; + } + + if ( m_interrupt ) + break; + + // Wait more? + const wxMilliClock_t timeNow = wxGetLocalTimeMillis(); + if ( timeNow >= timeEnd ) + break; + + if ( eventLoop ) + { + // This function is only called if wxSOCKET_BLOCK flag was not used + // and so we should dispatch the events if there is an event loop + // capable of doing it. + if ( eventLoop->Pending() ) + eventLoop->Dispatch(); + } +#if wxUSE_THREADS + else // no event loop or waiting in another thread + { + // We're busy waiting but at least give up the rest of our current + // time slice. + wxThread::Yield(); + } +#endif // wxUSE_THREADS } - req->done = TRUE; - req->nbytes += len; -#ifndef __WXGTK__ - DestroyCallbacks(); -#endif - break; - default: - return FALSE; - } - return TRUE; + + return gotEvent; } -void wxSocketBase::WantSpeedBuffer(char *buffer, size_t nbytes, - wxRequestEvent evt) +bool wxSocketBase::Wait(long seconds, long milliseconds) { - int ret = 0; - - switch (evt) - { - case EVT_PEEK: - case EVT_READ: - ret = recv(m_fd, buffer, nbytes, - (evt == EVT_PEEK) ? MSG_PEEK : 0); - break; - case EVT_WRITE: - ret = send(m_fd, buffer, nbytes, 0); - break; - } - if (ret < 0) - { - m_lcount = 0; - m_error = errno; - } - else - { - m_lcount = ret; - m_error = 0; - } + return DoWait(seconds, milliseconds, + wxSOCKET_INPUT_FLAG | + wxSOCKET_OUTPUT_FLAG | + wxSOCKET_CONNECTION_FLAG | + wxSOCKET_LOST_FLAG + ); } -void wxSocketBase::WantBuffer(char *buffer, size_t nbytes, - wxRequestEvent evt) +bool wxSocketBase::WaitForRead(long seconds, long milliseconds) { - bool buf_timed_out; + // Check pushback buffer before entering DoWait + if ( m_unread ) + return true; - if (m_fd == INVALID_SOCKET || !m_handler || !m_connected) - return; + // Note that wxSOCKET_INPUT_LOST has to be explicitly passed to DoWait + // because of the semantics of WaitForRead: a return value of true means + // that a Read call will return immediately, not that there is + // actually data to read. + return DoWait(seconds, milliseconds, wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG); +} - if (m_flags & SPEED) - { - WantSpeedBuffer(buffer, nbytes, evt); - return; - } - SockRequest *buf = new SockRequest; - wxSockWakeUp s_wake(NULL, (int *)&buf_timed_out, (int)TRUE); - - m_wantbuf++; - req_list[evt].Append(buf); - - SaveState(); - SetNotify(REQ_LOST | EventToNotify(evt)); - SetupCallbacks(); - buf->buffer = buffer; - buf->size = nbytes; - buf->done = FALSE; - buf->type = evt; - buf->nbytes = 0; - buf->auto_wakeup = &s_wake; - buf->error = 0; - buf_timed_out = FALSE; - - s_wake.Start(m_timeout*1000, TRUE); - if (m_flags & NOWAIT) - { - DoRequests(evt); - } - else - { - while (!buf->done && !buf_timed_out) - PROCESS_EVENTS(); - } - m_wantbuf--; - m_lcount = buf->nbytes; - if (buf_timed_out) - m_error = ETIMEDOUT; - else - m_error = buf->error; +bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) +{ + return DoWait(seconds, milliseconds, wxSOCKET_OUTPUT_FLAG | wxSOCKET_LOST_FLAG); +} - delete buf; - RestoreState(); +bool wxSocketBase::WaitForLost(long seconds, long milliseconds) +{ + return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG); } -// -------------------------------------------------------------- -// wxSocketServer -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Miscellaneous +// -------------------------------------------------------------------------- -wxSocketServer::wxSocketServer(wxSockAddress& addr_man, - wxSockFlags flags) : - wxSocketBase(flags, SOCK_SERVER) +// +// Get local or peer address +// + +bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const { - m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0); + GAddress *peer; - if (m_fd == INVALID_SOCKET) - return; + if (!m_impl) + return false; - int flag = 1; - setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (char*)&flag, sizeof(int)); + peer = m_impl->GetPeer(); - struct sockaddr *myaddr; - size_t len; + // copying a null address would just trigger an assert anyway - addr_man.Build(myaddr, len); - if (bind(m_fd, myaddr, addr_man.SockAddrLen()) < 0) - return; + if (!peer) + return false; - if (listen(m_fd, 5) < 0) { - m_fd = INVALID_SOCKET; - return; - } -} + addr_man.SetAddress(peer); + GAddress_destroy(peer); -// -------------------------------------------------------------- -// wxSocketServer Accept -// -------------------------------------------------------------- + return true; +} -bool wxSocketServer::AcceptWith(wxSocketBase& sock) +bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const { - int fd2; + GAddress *local; - if ((fd2 = accept(m_fd, 0, 0)) < 0) - return FALSE; + if (!m_impl) + return false; - struct linger linger; - linger.l_onoff = 0; - linger.l_linger = 1; + local = m_impl->GetLocal(); + addr_man.SetAddress(local); + GAddress_destroy(local); - setsockopt(fd2, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger)); + return true; +} - int flag = 0; - setsockopt(fd2, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int)); +// +// Save and restore socket state +// - if (!(sock.m_flags & SPEED)) - { - unsigned long flag2 = 1; - ioctl(fd2, FIONBIO, &flag2); - } +void wxSocketBase::SaveState() +{ + wxSocketState *state; - sock.m_type = SOCK_INTERNAL; - sock.m_fd = fd2; - sock.m_connected = TRUE; + state = new wxSocketState(); - return TRUE; + state->m_flags = m_flags; + state->m_notify = m_notify; + state->m_eventmask = m_eventmask; + state->m_clientData = m_clientData; + + m_states.Append(state); } -wxSocketBase *wxSocketServer::Accept() +void wxSocketBase::RestoreState() { - wxSocketBase* sock = new wxSocketBase(); + wxList::compatibility_iterator node; + wxSocketState *state; - sock->SetFlags((wxSockFlags)m_flags); + node = m_states.GetLast(); + if (!node) + return; - if (!AcceptWith(*sock)) - return NULL; + state = (wxSocketState *)node->GetData(); - if (m_handler) - m_handler->Register(sock); + m_flags = state->m_flags; + m_notify = state->m_notify; + m_eventmask = state->m_eventmask; + m_clientData = state->m_clientData; - return sock; + m_states.Erase(node); + delete state; } -// -------------------------------------------------------------- -// wxSocketServer callbacks -// -------------------------------------------------------------- +// +// Timeout and flags +// -void wxSocketServer::OnRequest(wxRequestEvent evt) +void wxSocketBase::SetTimeout(long seconds) { - if (evt == EVT_ACCEPT) - { - OldOnNotify(EVT_ACCEPT); - } -} + m_timeout = seconds; -// -------------------------------------------------------------- -// wxSocketClient -// -------------------------------------------------------------- - -// --------- wxSocketClient CONSTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) : - wxSocketBase(_flags, SOCK_CLIENT) -{ + if (m_impl) + m_impl->SetTimeout(m_timeout * 1000); } -// -------------------------------------------------------------- -// --------- wxSocketClient DESTRUCTOR -------------------------- -// -------------------------------------------------------------- -wxSocketClient::~wxSocketClient() +void wxSocketBase::SetFlags(wxSocketFlags flags) { + // Do some sanity checking on the flags used: not all values can be used + // together. + wxASSERT_MSG( !(flags & wxSOCKET_NOWAIT) || + !(flags & (wxSOCKET_WAITALL | wxSOCKET_BLOCK)), + "Using wxSOCKET_WAITALL or wxSOCKET_BLOCK with " + "wxSOCKET_NOWAIT doesn't make sense" ); + + m_flags = flags; } -// -------------------------------------------------------------- -// --------- wxSocketClient Connect functions ------------------- -// -------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) ) -{ - struct linger linger; - if (IsConnected()) - Close(); +// -------------------------------------------------------------------------- +// Event handling +// -------------------------------------------------------------------------- - m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0); +void wxSocketBase::OnRequest(wxSocketNotify notification) +{ + switch(notification) + { + case wxSOCKET_CONNECTION: + m_establishing = false; + m_connected = true; + break; + + // If we are in the middle of a R/W operation, do not + // propagate events to users. Also, filter 'late' events + // which are no longer valid. + + case wxSOCKET_INPUT: + if (m_reading || !m_impl->Select(wxSOCKET_INPUT_FLAG)) + return; + break; + + case wxSOCKET_OUTPUT: + if (m_writing || !m_impl->Select(wxSOCKET_OUTPUT_FLAG)) + return; + break; + + case wxSOCKET_LOST: + m_connected = false; + m_establishing = false; + break; + + case wxSOCKET_MAX_EVENT: + wxFAIL_MSG( "unexpected notification" ); + return; + } - if (m_fd < 0) - return FALSE; + // Schedule the event - m_connected = FALSE; + wxSocketEventFlags flag = 0; + wxUnusedVar(flag); + switch (notification) + { + case wxSOCKET_INPUT: flag = wxSOCKET_INPUT_FLAG; break; + case wxSOCKET_OUTPUT: flag = wxSOCKET_OUTPUT_FLAG; break; + case wxSOCKET_CONNECTION: flag = wxSOCKET_CONNECTION_FLAG; break; + case wxSOCKET_LOST: flag = wxSOCKET_LOST_FLAG; break; + default: + wxLogWarning(_("wxSocket: unknown event!.")); + return; + } - linger.l_onoff = 1; - linger.l_linger = 5; - setsockopt(m_fd, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger)); + if (((m_eventmask & flag) == flag) && m_notify) + { + if (m_handler) + { + wxSocketEvent event(m_id); + event.m_event = notification; + event.m_clientData = m_clientData; + event.SetEventObject(this); + + m_handler->AddPendingEvent(event); + } + } +} - // Stay in touch with the state of things... +void wxSocketBase::Notify(bool notify) +{ + m_notify = notify; + if (m_impl) + m_impl->Notify(notify); +} - unsigned long flag = 1; - setsockopt(m_fd, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int)); +void wxSocketBase::SetNotify(wxSocketEventFlags flags) +{ + m_eventmask = flags; +} - // Disable the nagle algorithm, which delays sends till the - // buffer is full (or a certain time period has passed?)... +void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id) +{ + m_handler = &handler; + m_id = id; +} -#if defined(__WINDOWS__) || (defined(IPPROTO_TCP) && defined(TCP_NODELAY)) - flag = 1; - setsockopt(m_fd, IPPROTO_TCP, TCP_NODELAY, (char*)&flag, sizeof(int)); -#endif +// -------------------------------------------------------------------------- +// Pushback buffer +// -------------------------------------------------------------------------- - struct sockaddr *remote; - size_t len; +void wxSocketBase::Pushback(const void *buffer, wxUint32 size) +{ + if (!size) return; - addr_man.Build(remote, len); + if (m_unread == NULL) + m_unread = malloc(size); + else + { + void *tmp; - if (connect(m_fd, remote, len) != 0) - return FALSE; + tmp = malloc(m_unrd_size + size); + memcpy((char *)tmp + size, m_unread, m_unrd_size); + free(m_unread); - if (!(m_flags & SPEED)) - { - flag = 1; - ioctl(m_fd, FIONBIO, &flag); - } + m_unread = tmp; + } - Notify(TRUE); + m_unrd_size += size; - m_connected = TRUE; - return TRUE; + memcpy(m_unread, buffer, size); } -bool wxSocketClient::WaitOnConnect(long seconds, long microseconds) +wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek) { - int ret = _Wait(seconds, microseconds, REQ_CONNECT | REQ_LOST); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - if (ret) - m_connected = TRUE; + if (!m_unrd_size) + return 0; - return m_connected; -} + if (size > (m_unrd_size-m_unrd_cur)) + size = m_unrd_size-m_unrd_cur; -void wxSocketClient::OnRequest(wxRequestEvent evt) -{ - if (evt == EVT_CONNECT) - { - if (m_connected) + memcpy(buffer, (char *)m_unread + m_unrd_cur, size); + + if (!peek) { -#ifndef __WXGTK__ - SetNotify(m_neededreq & ~REQ_CONNECT); -#endif - return; + m_unrd_cur += size; + if (m_unrd_size == m_unrd_cur) + { + free(m_unread); + m_unread = NULL; + m_unrd_size = 0; + m_unrd_cur = 0; + } } - m_waitflags = 0x40; - m_connected = TRUE; - OldOnNotify(EVT_CONNECT); -#ifndef __WXGTK__ - DestroyCallbacks(); -#endif - return; - } - wxSocketBase::OnRequest(evt); -} -///////////////////////////////////////////////////////////////// -// wxSocketHandler /////////////////////////////////////////////// -///////////////////////////////////////////////////////////////// - -wxSocketHandler *wxSocketHandler::master = NULL; -#if defined(__WINDOWS__) -static int win_initialized = 0; -#endif + return size; +} -// -------------------------------------------------------------- -// --------- wxSocketHandler CONSTRUCTOR ------------------------ -// -------------------------------------------------------------- -#ifdef __WXMAC__ -extern "C" int updatestatus(int s) ; +// ========================================================================== +// wxSocketServer +// ========================================================================== -void wxMacSocketOnRequestProc( void *refcon , short event ) -{ - if ( refcon ) - { - wxSocketBase *sock = (wxSocketBase *) refcon ; - - wxSocketBase::wxRequestEvent sk_req; - - int canRead ; - int canWrite ; - int exception ; - - switch (event) { - case FD_READ: - sk_req = wxSocketBase::EVT_READ; - sock->OnRequest(sk_req); - break; - case FD_WRITE: - sk_req = wxSocketBase::EVT_WRITE; - sock->OnRequest(sk_req); - break; - case FD_CLOSE: - sk_req = wxSocketBase::EVT_LOST; - sock->OnRequest(sk_req); - break; - case FD_ACCEPT: - sk_req = wxSocketBase::EVT_ACCEPT; - sock->OnRequest(sk_req); - break; - case FD_CONNECT: - sk_req = wxSocketBase::EVT_CONNECT; - sock->OnRequest(sk_req); - break; - case FD_READY : - break ; - } - updatestatus ( sock->m_fd ) ; - } -} +// -------------------------------------------------------------------------- +// Ctor +// -------------------------------------------------------------------------- -void wxMacSocketHandlerProc( void *refcon , short event ) +wxSocketServer::wxSocketServer(const wxSockAddress& addr_man, + wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_SERVER) { - wxMacNetEventsReferences[wxMacNetEventsTop] = refcon ; - wxMacNetEventsEvents[wxMacNetEventsTop] = event ; + wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") ); - // clumsy construct in order to never have a incorrect wxMacNetEventsTop (above limits) + m_impl = wxSocketImpl::Create(*this); - if ( wxMacNetEventsTop + 1 == kwxMacNetEventsMax ) - wxMacNetEventsTop = 0 ; - else - wxMacNetEventsTop++ ; -} + if (!m_impl) + { + wxLogTrace( wxTRACE_Socket, _T("*** Failed to create m_impl") ); + return; + } -#endif -#ifdef __WINDOWS__ + // Setup the socket as server + m_impl->Notify(m_notify); + m_impl->SetLocal(addr_man.GetAddress()); -extern char wxPanelClassName[]; + if (GetFlags() & wxSOCKET_REUSEADDR) { + m_impl->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) { + m_impl->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) { + m_impl->DontDoBind(); + } -LRESULT APIENTRY _EXPORT wxSocketHandlerWndProc(HWND hWnd, UINT message, - WPARAM wParam, LPARAM lParam) -{ - if(message==WM_DESTROY) - { - ::SetWindowLong(hWnd, GWL_WNDPROC, (LONG) DefWindowProc); - return DefWindowProc(hWnd, message, wParam, lParam); - } - wxSocketHandler *h_sock = (wxSocketHandler *)GetWindowLong(hWnd, GWL_USERDATA); - wxNode *node = h_sock->smsg_list->Find(message); - wxSocketBase *sock; - wxSocketBase::wxRequestEvent sk_req; - UINT event = WSAGETSELECTEVENT(lParam); - - if (!node) - return DefWindowProc(hWnd, message, wParam, lParam); - - sock = (wxSocketBase *)node->Data(); - - switch (event) { - case FD_READ: - sk_req = wxSocketBase::EVT_READ; - break; - case FD_WRITE: - sk_req = wxSocketBase::EVT_WRITE; - break; - case FD_CLOSE: - sk_req = wxSocketBase::EVT_LOST; - break; - case FD_ACCEPT: - sk_req = wxSocketBase::EVT_ACCEPT; - break; - case FD_CONNECT: - sk_req = wxSocketBase::EVT_CONNECT; - break; - - default: - wxFAIL_MSG("invalid socket event"); - return (LRESULT)0; - } + if (m_impl->CreateServer() != wxSOCKET_NOERROR) + { + delete m_impl; + m_impl = NULL; - sock->OnRequest(sk_req); + wxLogTrace( wxTRACE_Socket, _T("*** CreateServer() failed") ); + return; + } - return (LRESULT)0; + wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_impl->m_fd ); } -FARPROC wxSocketSubClassProc = NULL; - -#endif +// -------------------------------------------------------------------------- +// Accept +// -------------------------------------------------------------------------- -wxSocketHandler::wxSocketHandler() +bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { -#if defined(__WINDOWS__) - if (!win_initialized) - { - WSADATA wsaData; + if (!m_impl) + return false; - WSAStartup((1 << 8) | 1, &wsaData); - win_initialized = 1; - } - internal = new wxSockHandlerInternal; - internal->sockWin = ::CreateWindow(wxPanelClassName, NULL, 0, - 0, 0, 0, 0, NULL, (HMENU) NULL, - wxhInstance, 0); - - // Subclass the window - if (!wxSocketSubClassProc) - wxSocketSubClassProc = MakeProcInstance((FARPROC) wxSocketHandlerWndProc, wxhInstance); - ::SetWindowLong(internal->sockWin, GWL_WNDPROC, (LONG) wxSocketSubClassProc); - ::SetWindowLong(internal->sockWin, GWL_USERDATA, (LONG) this); - - internal->firstAvailableMsg = 5000; - smsg_list = new wxList(wxKEY_INTEGER); -#endif + // If wait == false, then the call should be nonblocking. + // When we are finished, we put the socket to blocking mode + // again. + wxSocketUnblocker unblock(m_impl, !wait); + sock.m_impl = m_impl->WaitConnection(sock); - socks = new wxList; + if ( !sock.m_impl ) + return false; -#ifndef __WINDOWS__ - signal(SIGPIPE, SIG_IGN); -#endif + sock.m_type = wxSOCKET_BASE; + sock.m_connected = true; + + return true; } -// -------------------------------------------------------------- -// --------- wxSocketHandler DESTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketHandler::~wxSocketHandler() +wxSocketBase *wxSocketServer::Accept(bool wait) { - wxNode *next_node, *node = socks->First(); - - while (node) - { - wxSocketBase* sock = (wxSocketBase*)node->Data(); - - delete sock; - next_node = node->Next(); - delete node; - node = next_node; - } - - delete socks; + wxSocketBase* sock = new wxSocketBase(); -#ifdef __WINDOWS__ - delete smsg_list; + sock->SetFlags(m_flags); - ::DestroyWindow(internal->sockWin); - WSACleanup(); - win_initialized = 0; + if (!AcceptWith(*sock, wait)) + { + sock->Destroy(); + sock = NULL; + } - delete internal; -#endif + return sock; } -// -------------------------------------------------------------- -// --------- wxSocketHandler registering functions -------------- -// -------------------------------------------------------------- +bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) +{ + return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG); +} -void wxSocketHandler::Register(wxSocketBase* sock) +bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen) { - wxNode *node; + wxASSERT_MSG( m_impl, _T("Socket not initialised") ); - for (node = socks->First(); node != NULL; node = node->Next()) - { - wxSocketBase* s = (wxSocketBase*)node->Data(); + SOCKOPTLEN_T lenreal; + if ( getsockopt(m_impl->m_fd, level, optname, + static_cast(optval), &lenreal) != 0 ) + return false; - if (s == sock) - return; - } + *optlen = lenreal; - if (sock) - { - socks->Append(sock); - sock->SetHandler(this); - sock->SetupCallbacks(); - } + return true; } -void wxSocketHandler::UnRegister(wxSocketBase* sock) +bool +wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen) { - wxNode *node; + wxASSERT_MSG( m_impl, _T("Socket not initialised") ); - for (node = socks->First(); node; node = node->Next()) - { - wxSocketBase* s = (wxSocketBase*)node->Data(); + return setsockopt(m_impl->m_fd, level, optname, + static_cast(optval), optlen) == 0; +} + +bool wxSocketBase::SetLocal(const wxIPV4address& local) +{ + GAddress* la = local.GetAddress(); - if (s == sock) + // If the address is valid, save it for use when we call Connect + if (la && la->m_addr) { - delete node; - sock->DestroyCallbacks(); - sock->SetHandler(NULL); - return; + m_localAddress = local; + + return true; } - } + + return false; } -unsigned long wxSocketHandler::Count() const +// ========================================================================== +// wxSocketClient +// ========================================================================== + +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- + +wxSocketClient::wxSocketClient(wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_CLIENT) { - return socks->Number(); + m_initialRecvBufferSize = + m_initialSendBufferSize = -1; } -// -------------------------------------------------------------- -// --------- wxSocketHandler "big" wait functions --------------- -// -------------------------------------------------------------- -void handler_cbk(wxSocketBase& sock, - wxSocketBase::wxRequestEvent WXUNUSED(flags), - char *cdata) +wxSocketClient::~wxSocketClient() { - int *a_wait = (int *)cdata; - - (*a_wait)++; - sock.Notify(FALSE); } -int wxSocketHandler::Wait(long seconds, long microseconds) -{ - int i; - int on_wait; - wxSockWakeUp s_wake(NULL, &on_wait, -2); - wxNode *node; +// -------------------------------------------------------------------------- +// Connect +// -------------------------------------------------------------------------- - for (node = socks->First(), i=0; node; node = node->Next(), i++) - { - wxSocketBase *sock = (wxSocketBase *)node->Data(); +bool wxSocketClient::DoConnect(const wxSockAddress& addr_man, + const wxSockAddress* local, + bool wait) +{ + if (m_impl) + { + // Shutdown and destroy the socket + Close(); + delete m_impl; + } - sock->SaveState(); + m_impl = wxSocketImpl::Create(*this); + m_connected = false; + m_establishing = false; - sock->SetupCallbacks(); + if (!m_impl) + return false; - sock->Callback(handler_cbk); - sock->CallbackData((char *)&on_wait); - } - on_wait = 0; - if (seconds != -1) - s_wake.Start((seconds*1000) + (microseconds/1000), TRUE); + // If wait == false, then the call should be nonblocking. When we are + // finished, we put the socket to blocking mode again. + wxSocketUnblocker unblock(m_impl, !wait); - while (!on_wait) - PROCESS_EVENTS(); + // Reuse makes sense for clients too, if we are trying to rebind to the same port + if (GetFlags() & wxSOCKET_REUSEADDR) + { + m_impl->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) + { + m_impl->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) + { + m_impl->DontDoBind(); + } - for (node = socks->First(), i=0; node; node = node->Next(), i++) - { - wxSocketBase *sock = (wxSocketBase *)node->Data(); + // If no local address was passed and one has been set, use the one that was Set + if (!local && m_localAddress.GetAddress()) + { + local = &m_localAddress; + } - sock->RestoreState(); - } + // Bind to the local IP address and port, when provided + if (local) + { + GAddress* la = local->GetAddress(); - if (on_wait == -2) - return 0; + if (la && la->m_addr) + m_impl->SetLocal(la); + } - return on_wait; -} + m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); -void wxSocketHandler::YieldSock() -{ - wxNode *node; + m_impl->SetPeer(addr_man.GetAddress()); + const wxSocketError err = m_impl->CreateClient(); - for (node = socks->First(); node; node = node->Next() ) - { - wxSocketBase *sock = (wxSocketBase *)node->Data(); + //this will register for callbacks - must be called after m_impl->m_fd was initialized + m_impl->Notify(m_notify); - sock->SaveState(); + if (err != wxSOCKET_NOERROR) + { + if (err == wxSOCKET_WOULDBLOCK) + m_establishing = true; - sock->SetFlags(wxSocketBase::SPEED); - if (sock->IsData()) - sock->DoRequests(wxSocketBase::EVT_READ); - sock->DoRequests(wxSocketBase::EVT_WRITE); + return false; + } - sock->RestoreState(); - } + m_connected = true; + return true; } -// -------------------------------------------------------------- -// --------- wxSocketHandler: create and register the socket ---- -// -------------------------------------------------------------- -wxSocketServer *wxSocketHandler::CreateServer(wxSockAddress& addr, - wxSocketBase::wxSockFlags flags) +bool wxSocketClient::Connect(const wxSockAddress& addr_man, bool wait) { - wxSocketServer *serv = new wxSocketServer(addr, flags); + return DoConnect(addr_man, NULL, wait); +} - Register(serv); - return serv; +bool wxSocketClient::Connect(const wxSockAddress& addr_man, + const wxSockAddress& local, + bool wait) +{ + return DoConnect(addr_man, &local, wait); } -wxSocketClient *wxSocketHandler::CreateClient(wxSocketBase::wxSockFlags flags) +bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) { - wxSocketClient *client = new wxSocketClient(flags); + if ( m_connected ) + { + // this happens if the initial attempt to connect succeeded without + // blocking + return true; + } + + wxCHECK_MSG( m_establishing && m_impl, false, + "No connection establishment attempt in progress" ); - Register(client); - return client; + // we must specify wxSOCKET_LOST_FLAG here explicitly because we must return + // true if the connection establishment process is finished, whether it is + // over because we successfully connected or because we were not able to + // connect + return DoWait(seconds, milliseconds, + wxSOCKET_CONNECTION_FLAG | wxSOCKET_LOST_FLAG); } -#ifdef __WINDOWS__ -// -------------------------------------------------------------- -// --------- wxSocketHandler: Windows specific methods ---------- -// -------------------------------------------------------------- +// ========================================================================== +// wxDatagramSocket +// ========================================================================== -UINT wxSocketHandler::NewMessage(wxSocketBase *sock) +wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr, + wxSocketFlags flags ) + : wxSocketBase( flags, wxSOCKET_DATAGRAM ) { - internal->firstAvailableMsg++; - smsg_list->Append(internal->firstAvailableMsg, sock); - return internal->firstAvailableMsg; -} + // Create the socket + m_impl = wxSocketImpl::Create(*this); -void wxSocketHandler::DestroyMessage(UINT msg) -{ - wxNode *node = smsg_list->Find(msg); - delete node; -} + if (!m_impl) + return; -HWND wxSocketHandler::GetHWND() const -{ - return internal->sockWin; -} + m_impl->Notify(m_notify); + // Setup the socket as non connection oriented + m_impl->SetLocal(addr.GetAddress()); + if (flags & wxSOCKET_REUSEADDR) + { + m_impl->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) + { + m_impl->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) + { + m_impl->DontDoBind(); + } -#endif + if ( m_impl->CreateUDP() != wxSOCKET_NOERROR ) + { + delete m_impl; + m_impl = NULL; + return; + } -bool wxSocketModule::OnInit() -{ - wxSocketHandler::master = new wxSocketHandler(); - return TRUE; + // Initialize all stuff + m_connected = false; + m_establishing = false; } -void wxSocketModule::OnExit() +wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, + void* buf, + wxUint32 nBytes ) { - delete wxSocketHandler::master; - wxSocketHandler::master = NULL; + Read(buf, nBytes); + GetPeer(addr); + return (*this); } -#ifdef __WXMAC__ -void wxMacProcessSocketEvents() ; -void wxMacProcessEvents() +wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr, + const void* buf, + wxUint32 nBytes ) { - wxMacProcessSocketEvents() ; - (*GUSISpin)(SP_MISC, 0) ; + wxASSERT_MSG( m_impl, _T("Socket not initialised") ); + + m_impl->SetPeer(addr.GetAddress()); + Write(buf, nBytes); + return (*this); } -void wxMacProcessSocketEvents() +// ========================================================================== +// wxSocketModule +// ========================================================================== + +class wxSocketModule : public wxModule { - while ( wxMacNetEventsTop != wxMacNetEventsBottom ) - { - // consume event at wxMacNetEventsBottom - wxMacSocketOnRequestProc(wxMacNetEventsReferences[wxMacNetEventsBottom] , wxMacNetEventsEvents[wxMacNetEventsBottom] ) ; - wxMacNetEventsBottom++ ; - if ( wxMacNetEventsBottom == kwxMacNetEventsMax ) - wxMacNetEventsBottom = 0 ; - } -} -#endif +public: + virtual bool OnInit() + { + // wxSocketBase will call Initialize() itself only if sockets are + // really used, don't do it from here + return true; + } -#endif - // __WXSTUBS__ + virtual void OnExit() + { + if ( wxSocketBase::IsInitialized() ) + wxSocketBase::Shutdown(); + } + +private: + DECLARE_DYNAMIC_CLASS(wxSocketModule) +}; + +IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) + +#endif // wxUSE_SOCKETS