X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/46ccb5107ff22cb5cc1b36ef2a28ea1e31b0fc91..08670ea85abf4b4946a9ce64971b591d7b1ee30b:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 414efb7b8e..36a9dc1090 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,1545 +1,2123 @@ -//////////////////////////////////////////////////////////////////////////////// -// 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 +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + +// ========================================================================== +// Declarations +// ========================================================================== // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// -#include -#include -#include -#include -#include +#if wxUSE_SOCKETS -// Not enough OS behaviour defined for wxStubs -#ifndef __WXSTUBS__ +#include "wx/socket.h" -#include -#include -#include +#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 -///////////////////////////////////////////////////////////////////////////// -// System specific headers -///////////////////////////////////////////////////////////////////////////// -#if defined(__WINDOWS__) -#include -#endif // __WINDOWS__ +#include "wx/apptrait.h" +#include "wx/sckaddr.h" +#include "wx/stopwatch.h" +#include "wx/thread.h" +#include "wx/evtloop.h" +#include "wx/link.h" -#if defined(__UNIX__) +#include "wx/private/fd.h" +#include "wx/private/socket.h" -#ifdef VMS -#include -#else -#include +#ifdef __UNIX__ + #include #endif -#include -#include -#include - -#ifdef sun -#include +// we use MSG_NOSIGNAL to avoid getting SIGPIPE when sending data to a remote +// host which closed the connection if it is available, otherwise we rely on +// SO_NOSIGPIPE existency +// +// this should cover all the current Unix systems (Windows never sends any +// signals anyhow) but if we find one that has neither we should explicitly +// ignore SIGPIPE for it +// OpenVMS has neither MSG_NOSIGNAL nor SO_NOSIGPIPE. However the socket sample +// seems to work. Not sure if problems will show up on OpenVMS using sockets. +#ifdef MSG_NOSIGNAL + #define wxSOCKET_MSG_NOSIGNAL MSG_NOSIGNAL +#else // MSG_NOSIGNAL not available (BSD including OS X) + // next best possibility is to use SO_NOSIGPIPE socket option, this covers + // BSD systems (including OS X) -- but if we don't have it neither (AIX and + // old HP-UX do not), we have to fall back to the old way of simply + // disabling SIGPIPE temporarily, so define a class to do it in a safe way + #if defined(__UNIX__) && !defined(SO_NOSIGPIPE) + extern "C" { typedef void (*wxSigHandler_t)(int); } + namespace + { + class IgnoreSignal + { + public: + // ctor disables the given signal + IgnoreSignal(int sig) + : m_handler(signal(sig, SIG_IGN)), + m_sig(sig) + { + } + + // dtor restores the old handler + ~IgnoreSignal() + { + signal(m_sig, m_handler); + } + + private: + const wxSigHandler_t m_handler; + const int m_sig; + + wxDECLARE_NO_COPY_CLASS(IgnoreSignal); + }; + } // anonymous namespace + + #define wxNEEDS_IGNORE_SIGPIPE + #endif // Unix without SO_NOSIGPIPE + + #define wxSOCKET_MSG_NOSIGNAL 0 #endif -#endif // __UNIX__ +// DLL options compatibility check: +#include "wx/build.h" +WX_CHECK_BUILD_OPTIONS("wxNet") -#include -#include +// -------------------------------------------------------------------------- +// macros and constants +// -------------------------------------------------------------------------- -#ifdef _MSC_VER -#include -#endif +// event +wxDEFINE_EVENT(wxEVT_SOCKET, wxSocketEvent); -#if defined(__WXMOTIF__) || defined(__WXXT__) -#include +// discard buffer +#define MAX_DISCARD_SIZE (10 * 1024) -///////////////////////////// -// Needs internal variables -///////////////////////////// -#ifdef __WXXT__ -#define Uses_XtIntrinsic -#endif +#define wxTRACE_Socket wxT("wxSocket") -#endif +// -------------------------------------------------------------------------- +// wxWin macros +// -------------------------------------------------------------------------- -#if defined(__WXGTK__) -#include -#endif +IMPLEMENT_CLASS(wxSocketBase, wxObject) +IMPLEMENT_CLASS(wxSocketServer, wxSocketBase) +IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) +IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase) +IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// -#define WXSOCK_INTERNAL -#include "wx/sckaddr.h" -#include "wx/socket.h" +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- -///////////////////////////////////////////////////////////////////////////// -// 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 +namespace +{ -#ifndef __WINDOWS__ -#define INVALID_SOCKET -1 -#endif +void SetTimeValFromMS(timeval& tv, unsigned long ms) +{ + tv.tv_sec = (ms / 1000); + tv.tv_usec = (ms % 1000) * 1000; +} -#ifdef __WXMOTIF__ -#define wxAPP_CONTEXT ((XtAppContext)wxTheApp->GetAppContext()) -#endif +} // anonymous namespace -#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). +// -------------------------------------------------------------------------- +// private classes +// -------------------------------------------------------------------------- -#if defined( NEED_WSAFDIsSet ) || defined( _MSC_VER ) -int PASCAL FAR __WSAFDIsSet(SOCKET fd, fd_set FAR *set) +class wxSocketState : public wxObject { - int i = set->fd_count; +public: + wxSocketFlags m_flags; + wxSocketEventFlags m_eventmask; + bool m_notify; + void *m_clientData; - while (i--) - { - if (set->fd_array[i] == fd) - return 1; - } +public: + wxSocketState() : wxObject() {} - return 0; -} -#endif -#endif + wxDECLARE_NO_COPY_CLASS(wxSocketState); +}; -#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 +// wxSocketWaitModeChanger: temporarily change the socket flags affecting its +// wait mode +class wxSocketWaitModeChanger +{ +public: + // temporarily set the flags to include the flag value which may be either + // wxSOCKET_NOWAIT or wxSOCKET_WAITALL + wxSocketWaitModeChanger(wxSocketBase *socket, int flag) + : m_socket(socket), + m_oldflags(socket->GetFlags()) + + { + wxASSERT_MSG( flag == wxSOCKET_WAITALL || flag == wxSOCKET_NOWAIT, + "not a wait flag" ); + + // preserve wxSOCKET_BLOCK value when switching to wxSOCKET_WAITALL + // mode but not when switching to wxSOCKET_NOWAIT as the latter is + // incompatible with wxSOCKET_BLOCK + if ( flag != wxSOCKET_NOWAIT ) + flag |= m_oldflags & wxSOCKET_BLOCK; + + socket->SetFlags(flag); + } -///////////////////////////////////////////////////////////////////////////// -// Some patch ///// END -///////////////////////////////////////////////////////////////////////////// + ~wxSocketWaitModeChanger() + { + m_socket->SetFlags(m_oldflags); + } -// -------------------------------------------------------------- -// ClassInfos -// -------------------------------------------------------------- -#if !USE_SHARED_LIBRARY -IMPLEMENT_CLASS(wxSocketBase, wxObject) -IMPLEMENT_CLASS(wxSocketServer, wxSocketBase) -IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) -IMPLEMENT_CLASS(wxSocketHandler, wxObject) -IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) -#endif +private: + wxSocketBase * const m_socket; + const int m_oldflags; -class wxSockWakeUp : public wxTimer { -public: - int *my_id; - int n_val; - wxSocketBase *sock; - - 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); - } + wxDECLARE_NO_COPY_CLASS(wxSocketWaitModeChanger); }; -/// Socket request -class SockRequest : public wxObject { +// wxSocketRead/WriteGuard are instantiated before starting reading +// from/writing to the socket +class wxSocketReadGuard +{ public: - char *buffer; - size_t size, nbytes; - bool done; - int error; - wxSockWakeUp *auto_wakeup; - wxSocketBase::wxRequestNotify type; -}; + wxSocketReadGuard(wxSocketBase *socket) + : m_socket(socket) + { + wxASSERT_MSG( !m_socket->m_reading, "read reentrancy?" ); + m_socket->m_reading = true; + } -///////////////////////////////////////////////////////////////////////////// -// Some internal define -///////////////////////////////////////////////////////////////////////////// + ~wxSocketReadGuard() + { + m_socket->m_reading = false; -// -------------------------------------------------------------- -// --------- 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 -} + // connection could have been lost while reading, in this case calling + // ReenableEvents() would assert and is not necessary anyhow + wxSocketImpl * const impl = m_socket->m_impl; + if ( impl && impl->m_fd != INVALID_SOCKET ) + impl->ReenableEvents(wxSOCKET_INPUT_FLAG); + } -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 -} +private: + wxSocketBase * const m_socket; -// -------------------------------------------------------------- -// --------- wxSocketBase CONSTRUCTOR --------------------------- -// -------------------------------------------------------------- -wxSocketBase::~wxSocketBase() + wxDECLARE_NO_COPY_CLASS(wxSocketReadGuard); +}; + +class wxSocketWriteGuard { - DestroyCallbacks(); - Close(); +public: + wxSocketWriteGuard(wxSocketBase *socket) + : m_socket(socket) + { + wxASSERT_MSG( !m_socket->m_writing, "write reentrancy?" ); - 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); + m_socket->m_writing = true; + } - delete m_internal; -} + ~wxSocketWriteGuard() + { + m_socket->m_writing = false; -bool wxSocketBase::Close() -{ - if (m_fd != INVALID_SOCKET) { - for (int i=0;i<3;i++) { - wxNode *n, *node = req_list[i].First(); + wxSocketImpl * const impl = m_socket->m_impl; + if ( impl && impl->m_fd != INVALID_SOCKET ) + impl->ReenableEvents(wxSOCKET_OUTPUT_FLAG); + } - while (node) { - SockRequest *req = (SockRequest *)node->Data(); - req->done = TRUE; +private: + wxSocketBase * const m_socket; - n = node->Next(); - delete node; - node = n; - } - } + wxDECLARE_NO_COPY_CLASS(wxSocketWriteGuard); +}; + +// ============================================================================ +// wxSocketManager +// ============================================================================ - DestroyCallbacks(); - shutdown(m_fd, 2); - close(m_fd); - m_fd = INVALID_SOCKET; - m_connected = FALSE; - } +wxSocketManager *wxSocketManager::ms_manager = NULL; - return TRUE; +/* static */ +void wxSocketManager::Set(wxSocketManager *manager) +{ + wxASSERT_MSG( !ms_manager, "too late to set manager now" ); + + ms_manager = manager; } -// -------------------------------------------------------------- -// --------- wxSocketBase base IO functions --------------------- -// -------------------------------------------------------------- -wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes) +/* static */ +void wxSocketManager::Init() { - m_lcount = GetPushback(buffer, nbytes, FALSE); + wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" ); - // 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; + /* + 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. + + 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" ); - WantBuffer(buffer, nbytes, EVT_READ); + wxAppConsole * const app = wxAppConsole::GetInstance(); + wxCHECK_RET( app, "sockets can't be initialized without wxApp" ); - return *this; + ms_manager = app->GetTraits()->GetSocketManager(); } -wxSocketBase& wxSocketBase::Peek(char* buffer, size_t nbytes) -{ - size_t nbytes_old = nbytes; +// ========================================================================== +// wxSocketImpl +// ========================================================================== - nbytes -= GetPushback(buffer, nbytes, TRUE); - if (!nbytes) { - m_lcount = nbytes_old; - return *this; - } +wxSocketImpl::wxSocketImpl(wxSocketBase& wxsocket) + : m_wxsocket(&wxsocket) +{ + m_fd = INVALID_SOCKET; + m_error = wxSOCKET_NOERROR; + m_server = false; + m_stream = true; - WantBuffer(buffer, nbytes, EVT_PEEK); + 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::Write(const char *buffer, size_t nbytes) +wxSocketImpl::~wxSocketImpl() { - WantBuffer((char *)buffer, nbytes, EVT_WRITE); - return *this; + if ( m_fd != INVALID_SOCKET ) + Shutdown(); } -wxSocketBase& wxSocketBase::ReadMsg(char* buffer, size_t nbytes) +bool wxSocketImpl::PreCreateCheck(const wxSockAddressImpl& addr) { - SockMsg msg; - size_t len, len2, sig; - - Read((char *)&msg, sizeof(msg)); - if (m_lcount != sizeof(msg)) - return *this; - - 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 (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; + if ( m_fd != INVALID_SOCKET ) + { + m_error = wxSOCKET_INVSOCK; + return false; + } - 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 ( !addr.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return false; + } - return *this; + return true; } -wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, size_t nbytes) +void wxSocketImpl::PostCreation() { - SockMsg msg; + // FreeBSD variants can't use MSG_NOSIGNAL, and instead use a socket option +#ifdef SO_NOSIGPIPE + EnableSocketOption(SO_NOSIGPIPE); +#endif - msg.sig[0] = (char) 0xad; - msg.sig[1] = (char) 0xde; - msg.sig[2] = (char) 0xed; - msg.sig[3] = (char) 0xfe; + if ( m_reusable ) + EnableSocketOption(SO_REUSEADDR); - 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; + if ( m_broadcast ) + { + wxASSERT_MSG( !m_stream, "broadcasting is for datagram sockets only" ); - if (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg)) - return *this; - if (Write(buffer, nbytes).LastCount() < nbytes) - return *this; + EnableSocketOption(SO_BROADCAST); + } - 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)); + if ( m_initialRecvBufferSize >= 0 ) + SetSocketOption(SO_RCVBUF, m_initialRecvBufferSize); + if ( m_initialSendBufferSize >= 0 ) + SetSocketOption(SO_SNDBUF, m_initialSendBufferSize); - return *this; + // we always put our sockets in unblocked mode and handle blocking + // ourselves in DoRead/Write() if wxSOCKET_WAITALL is specified + UnblockAndRegisterWithEventLoop(); } -wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes) +wxSocketError wxSocketImpl::UpdateLocalAddress() { - CreatePushbackAfter(buffer, nbytes); - return *this; -} - -bool wxSocketBase::IsData() const -{ - struct timeval tv; - fd_set sock_set; + if ( !m_local.IsOk() ) + { + // ensure that we have a valid object using the correct family: correct + // being the same one as our peer uses as we have no other way to + // determine it + m_local.Create(m_peer.GetFamily()); + } - if (m_fd < 0) - return FALSE; - if (m_unrd_size > 0) - return TRUE; + WX_SOCKLEN_T lenAddr = m_local.GetLen(); + if ( getsockname(m_fd, m_local.GetWritableAddr(), &lenAddr) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + 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); + return wxSOCKET_NOERROR; } -// --------------------------------------------------------------------- -// --------- wxSocketBase Discard(): deletes all byte in the input queue -// --------------------------------------------------------------------- -void wxSocketBase::Discard() +wxSocketError wxSocketImpl::CreateServer() { -#define MAX_BUFSIZE (10*1024) - char *my_data = new char[MAX_BUFSIZE]; - size_t recv_size = MAX_BUFSIZE; + if ( !PreCreateCheck(m_local) ) + return m_error; - SaveState(); - SetFlags((wxSockFlags)(NOWAIT | SPEED)); + m_server = true; + m_stream = true; - while (recv_size == MAX_BUFSIZE) { - recv_size = Read(my_data, MAX_BUFSIZE).LastCount(); - } + // do create the socket + m_fd = socket(m_local.GetFamily(), SOCK_STREAM, 0); - RestoreState(); - delete [] my_data; + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } -#undef MAX_BUFSIZE -} + PostCreation(); -// -------------------------------------------------------------- -// --------- wxSocketBase socket info functions ----------------- -// -------------------------------------------------------------- -bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const -{ - struct sockaddr my_addr; - size_t len_addr = sizeof(my_addr); + // and then bind to and listen on it + // + // FIXME: should we test for m_dobind here? + if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 ) + m_error = wxSOCKET_IOERR; - if (m_fd < 0) - return FALSE; + if ( IsOk() ) + { + if ( listen(m_fd, 5) != 0 ) + m_error = wxSOCKET_IOERR; + } - if (getpeername(m_fd, (struct sockaddr *)&my_addr, (int *)&len_addr) < 0) - return FALSE; + if ( !IsOk() ) + { + Close(); + return m_error; + } - addr_man.Disassemble(&my_addr, len_addr); - return TRUE; + // finally retrieve the address we effectively bound to + return UpdateLocalAddress(); } -bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const +wxSocketError wxSocketImpl::CreateClient(bool wait) { - struct sockaddr my_addr; - size_t len_addr = sizeof(my_addr); + if ( !PreCreateCheck(m_peer) ) + return m_error; + + m_fd = socket(m_peer.GetFamily(), SOCK_STREAM, 0); + + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } - if (m_fd < 0) - return FALSE; + PostCreation(); + + // If a local address has been set, then bind to it before calling connect + if ( m_local.IsOk() ) + { + if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } + } - if (getsockname(m_fd, (struct sockaddr *)&my_addr, (int *)&len_addr) < 0) - return FALSE; + // Do connect now + int rc = connect(m_fd, m_peer.GetAddr(), m_peer.GetLen()); + if ( rc == SOCKET_ERROR ) + { + wxSocketError err = GetLastError(); + if ( err == wxSOCKET_WOULDBLOCK ) + { + m_establishing = true; + + // block waiting for connection if we should (otherwise just return + // wxSOCKET_WOULDBLOCK to the caller) + if ( wait ) + { + err = SelectWithTimeout(wxSOCKET_CONNECTION_FLAG) + ? wxSOCKET_NOERROR + : wxSOCKET_TIMEDOUT; + m_establishing = false; + } + } + + m_error = err; + } + else // connected + { + m_error = wxSOCKET_NOERROR; + } - addr_man.Disassemble(&my_addr, len_addr); - return TRUE; + return m_error; } -// -------------------------------------------------------------- -// --------- wxSocketBase wait functions ------------------------ -// -------------------------------------------------------------- -void wxSocketBase::SaveState() + +wxSocketError wxSocketImpl::CreateUDP() { - wxSockState *state = new wxSockState; + if ( !PreCreateCheck(m_local) ) + return m_error; - 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_stream = false; + m_server = false; - m_states.Append(state); -} + m_fd = socket(m_local.GetFamily(), SOCK_DGRAM, 0); -void wxSocketBase::RestoreState() -{ - wxNode *node; + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } - node = m_states.Last(); - if (!node) - return; + PostCreation(); - wxSockState *state = (wxSockState *)node->Data(); + if ( m_dobind ) + { + if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } - 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(); + return UpdateLocalAddress(); + } - delete node; - delete state; + return wxSOCKET_NOERROR; } -// -------------------------------------------------------------- -// --------- wxSocketBase wait functions ------------------------ -// -------------------------------------------------------------- -// -bool wxSocketBase::_Wait(long seconds, long microseconds, int type) +wxSocketImpl *wxSocketImpl::Accept(wxSocketBase& wxsocket) { - if ((!m_connected && !m_connecting) || m_fd < 0) - return FALSE; + wxSockAddressStorage from; + WX_SOCKLEN_T fromlen = sizeof(from); + const SOCKET fd = accept(m_fd, &from.addr, &fromlen); - wxSockWakeUp wakeup(this, &m_waitflags, 0); + // accepting is similar to reading in the sense that it resets "ready for + // read" flag on the socket + ReenableEvents(wxSOCKET_INPUT_FLAG); - SaveState(); - SetNotify((wxRequestNotify)type); - SetupCallbacks(); + if ( fd == INVALID_SOCKET ) + return NULL; - if (seconds != -1) - wakeup.Start((int)(seconds*1000 + (microseconds / 1000)), TRUE); + wxSocketManager * const manager = wxSocketManager::Get(); + if ( !manager ) + return NULL; - m_waitflags = 0x80 | type; - while (m_waitflags & 0x80) - PROCESS_EVENTS(); + wxSocketImpl * const sock = manager->CreateSocket(wxsocket); + if ( !sock ) + return NULL; - RestoreState(); + sock->m_fd = fd; + sock->m_peer = wxSockAddressImpl(from.addr, fromlen); - if (m_waitflags & 0x40) { - m_waitflags = 0; - return TRUE; - } - m_waitflags = 0; + sock->UnblockAndRegisterWithEventLoop(); - return FALSE; + return sock; } -bool wxSocketBase::Wait(long seconds, long microseconds) + +void wxSocketImpl::Close() { - return _Wait(seconds, microseconds, REQ_ACCEPT | REQ_CONNECT | - REQ_READ | REQ_WRITE | REQ_LOST); + if ( m_fd != INVALID_SOCKET ) + { + DoClose(); + m_fd = INVALID_SOCKET; + } } -bool wxSocketBase::WaitForRead(long seconds, long microseconds) +void wxSocketImpl::Shutdown() { - return _Wait(seconds, microseconds, REQ_READ | REQ_LOST); + if ( m_fd != INVALID_SOCKET ) + { + shutdown(m_fd, 1 /* SD_SEND */); + Close(); + } } -bool wxSocketBase::WaitForWrite(long seconds, long microseconds) +/* + * Sets the timeout for blocking calls. Time is expressed in + * milliseconds. + */ +void wxSocketImpl::SetTimeout(unsigned long millis) { - return _Wait(seconds, microseconds, REQ_WRITE); + SetTimeValFromMS(m_timeout, millis); } -bool wxSocketBase::WaitForLost(long seconds, long microseconds) +void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event) { - return _Wait(seconds, microseconds, REQ_LOST); + m_wxsocket->OnRequest(event); } -// -------------------------------------------------------------- -// --------- 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 +/* Address handling */ +wxSocketError wxSocketImpl::SetLocal(const wxSockAddressImpl& local) { - wxSocketBase *sock = (wxSocketBase *)client; - char c; - int i; + /* 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; + } - i = recv(fd, &c, 1, MSG_PEEK); + if ( !local.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return wxSOCKET_INVADDR; + } - if (i == -1 && (sock->NeededReq() & wxSocketBase::REQ_ACCEPT)) { - sock->OnRequest(wxSocketBase::EVT_ACCEPT); - return; - } + m_local = local; - if (i != 0) { - if (!(sock->NeededReq() & wxSocketBase::REQ_READ)) - return; + return wxSOCKET_NOERROR; +} - sock->OnRequest(wxSocketBase::EVT_READ); - } else { - if (!(sock->NeededReq() & wxSocketBase::REQ_LOST)) { - sock->Close(); - return; +wxSocketError wxSocketImpl::SetPeer(const wxSockAddressImpl& peer) +{ + if ( !peer.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return wxSOCKET_INVADDR; } - sock->OnRequest(wxSocketBase::EVT_LOST); - } + m_peer = peer; + + return wxSOCKET_NOERROR; +} + +const wxSockAddressImpl& wxSocketImpl::GetLocal() +{ + if ( !m_local.IsOk() ) + UpdateLocalAddress(); + + return m_local; } -#undef fd -#if defined(__WXMOTIF__) || defined(__WXXT__) -static void wx_socket_write(XtPointer client, int *WXUNUSED(fid), - XtInputId *WXUNUSED(id)) +// ---------------------------------------------------------------------------- +// wxSocketImpl IO +// ---------------------------------------------------------------------------- + +// this macro wraps the given expression (normally a syscall) in a loop which +// ignores any interruptions, i.e. reevaluates it again if it failed and errno +// is EINTR +#ifdef __UNIX__ + #define DO_WHILE_EINTR( rc, syscall ) \ + do { \ + rc = (syscall); \ + } \ + while ( rc == -1 && errno == EINTR ) #else -static void wx_socket_write(gpointer client, gint WXUNUSED(fd), - GdkInputCondition WXUNUSED(cond)) + #define DO_WHILE_EINTR( rc, syscall ) rc = (syscall) #endif + +int wxSocketImpl::RecvStream(void *buffer, int size) { - wxSocketBase *sock = (wxSocketBase *)client; + int ret; + DO_WHILE_EINTR( ret, recv(m_fd, static_cast(buffer), size, 0) ); + + if ( !ret ) + { + // receiving 0 bytes for a TCP socket indicates that the connection was + // closed by peer so shut down our end as well (for UDP sockets empty + // datagrams are also possible) + m_establishing = false; + NotifyOnStateChange(wxSOCKET_LOST); - if (!sock->IsConnected()) - sock->OnRequest(wxSocketBase::EVT_CONNECT); - else - sock->OnRequest(wxSocketBase::EVT_WRITE); + Shutdown(); + + // do not return an error in this case however + } + + return ret; } + +int wxSocketImpl::SendStream(const void *buffer, int size) +{ +#ifdef wxNEEDS_IGNORE_SIGPIPE + IgnoreSignal ignore(SIGPIPE); #endif -#ifdef wx_xview -Notify_value wx_sock_read_xview (Notify_client client, int fd) + int ret; + DO_WHILE_EINTR( ret, send(m_fd, static_cast(buffer), size, + wxSOCKET_MSG_NOSIGNAL) ); + + return ret; +} + +int wxSocketImpl::RecvDgram(void *buffer, int size) { - wxSocketBase *sock = (wxSocketBase *)client; - char c; - int i; + wxSockAddressStorage from; + WX_SOCKLEN_T fromlen = sizeof(from); + + int ret; + DO_WHILE_EINTR( ret, recvfrom(m_fd, static_cast(buffer), size, + 0, &from.addr, &fromlen) ); - i = recv(fd, &c, 1, MSG_PEEK); + if ( ret == SOCKET_ERROR ) + return SOCKET_ERROR; - if (i == -1 && (sock->NeededReq() & wxSocketBase::REQ_ACCEPT)) { - sock->OnRequest(wxSocketBase::EVT_ACCEPT); - return; - } + m_peer = wxSockAddressImpl(from.addr, fromlen); + if ( !m_peer.IsOk() ) + return -1; - /* Bytes arrived */ - if (i != 0) { - if (!(sock->NeededReq() & wxSocketBase::REQ_READ)) - return (Notify_value) FALSE; + return ret; +} - sock->OnRequest(wxSocketBase::EVT_READ); - } else { - if (!(sock->NeededReq() & wxSocketBase::REQ_LOST)) - return; +int wxSocketImpl::SendDgram(const void *buffer, int size) +{ + if ( !m_peer.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return -1; + } - sock->OnRequest(wxSocketBase::EVT_LOST); - } + int ret; + DO_WHILE_EINTR( ret, sendto(m_fd, static_cast(buffer), size, + 0, m_peer.GetAddr(), m_peer.GetLen()) ); - return (Notify_value) FALSE; + return ret; } -Notify_value wx_sock_write_xview (Notify_client client, int fd) +int wxSocketImpl::Read(void *buffer, int size) { - wxSocketBase *sock = (wxSocketBase *)client; + // server sockets can't be used for IO, only to accept new connections + if ( m_fd == INVALID_SOCKET || m_server ) + { + m_error = wxSOCKET_INVSOCK; + return -1; + } + + int ret = m_stream ? RecvStream(buffer, size) + : RecvDgram(buffer, size); - if (!sock->IsConnected()) - sock->OnRequest(wxSocketBase::EVT_CONNECT); - else - sock->OnRequest(wxSocketBase::EVT_WRITE); + m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR; - return (Notify_value) TRUE; + return ret; } -#endif -wxSocketBase::wxRequestNotify wxSocketBase::EventToNotify(wxRequestEvent evt) -{ - 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; -} - -void wxSocketBase::SetFlags(wxSockFlags _flags) -{ - m_flags = _flags; - if (_flags & SPEED) { - unsigned long flag = 0; - ioctl(m_fd, FIONBIO, &flag); - - // SPEED and WAITALL are antagonists. - m_flags = (wxSockFlags)(m_flags & ~WAITALL); - - Notify(FALSE); - } else { - unsigned long flag = 1; - ioctl(m_fd, FIONBIO, &flag); - } -} - -void wxSocketBase::SetNotify(wxRequestNotify flags) -{ - wxRequestNotify old_needed_req = m_neededreq; - if (flags & REQ_ACCEPT) { - /* Check if server */ - if (!(GetClassInfo()->IsKindOf(CLASSINFO(wxSocketServer)))) - flags &= ~REQ_ACCEPT; - } - m_neededreq = flags; - if (m_cbkon && old_needed_req != flags) - SetupCallbacks(); -} - -void wxSocketBase::SetupCallbacks() -{ - if (m_fd == INVALID_SOCKET || !m_handler || (m_flags & SPEED)) - return; - -#if defined(__WXMOTIF__) || defined(__WXXT__) || defined(__WXGTK__) - if (m_cbkon) - DestroyCallbacks(); - if (m_neededreq & (REQ_ACCEPT | REQ_READ | REQ_LOST)) { -#ifdef __WXGTK__ - m_internal->sock_inputid = gdk_input_add(m_fd, GDK_INPUT_READ, - wx_socket_read, (gpointer)this); -#else - m_internal->sock_inputid = XtAppAddInput (wxAPP_CONTEXT, m_fd, - (XtPointer *) XtInputReadMask, - (XtInputCallbackProc) wx_socket_read, - (XtPointer) this); -#endif - } - if (m_neededreq & (REQ_CONNECT | REQ_WRITE)) { -#ifdef __WXGTK__ - m_internal->sock_inputid = gdk_input_add(m_fd, GDK_INPUT_WRITE, - wx_socket_write, (gpointer)this); -#else - m_internal->sock_outputid = XtAppAddInput (wxAPP_CONTEXT, m_fd, - (XtPointer *) XtInputWriteMask, - (XtInputCallbackProc) wx_socket_write, - (XtPointer) this); -#endif - } -#endif -#ifdef __WINDOWS__ - WORD 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; - - 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 - 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 +int wxSocketImpl::Write(const void *buffer, int size) +{ + if ( m_fd == INVALID_SOCKET || m_server ) + { + m_error = wxSOCKET_INVSOCK; + return -1; + } + + int ret = m_stream ? SendStream(buffer, size) + : SendDgram(buffer, size); + + m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR; + + return ret; } -void wxSocketBase::Notify(bool notify) +// ========================================================================== +// wxSocketBase +// ========================================================================== + +// -------------------------------------------------------------------------- +// Initialization and shutdown +// -------------------------------------------------------------------------- + +namespace { - if (m_notifyme == notify) - return; - if (notify) - SetupCallbacks(); - else - DestroyCallbacks(); - m_notifyme = notify; + +// counts the number of calls to Initialize() minus the number of calls to +// Shutdown(): we don't really need it any more but it was documented that +// Shutdown() must be called the same number of times as Initialize() and using +// a counter helps us to check it +int gs_socketInitCount = 0; + +} // anonymous namespace + +bool wxSocketBase::IsInitialized() +{ + wxASSERT_MSG( wxIsMainThread(), "unsafe to call from other threads" ); + + return gs_socketInitCount != 0; } -void wxSocketBase::OnRequest(wxRequestEvent req_evt) +bool wxSocketBase::Initialize() { - wxRequestNotify req_notif = EventToNotify(req_evt); + wxCHECK_MSG( wxIsMainThread(), false, + "must be called from the main thread" ); - // Mask the current event - SetNotify(m_neededreq & ~req_notif); + if ( !gs_socketInitCount ) + { + wxSocketManager * const manager = wxSocketManager::Get(); + if ( !manager || !manager->OnInit() ) + return false; + } - if (req_evt <= EVT_WRITE && DoRequests(req_evt)) - return; + gs_socketInitCount++; - if (m_waitflags & 0xF0) { - // Wake up - if ((m_waitflags & 0x0F) == req_evt) { - m_waitflags = 0x80; -#ifndef __WXGTK__ - DestroyCallbacks(); // I disable it to prevent infinite loop on X11. -#endif + return true; +} + +void wxSocketBase::Shutdown() +{ + wxCHECK_RET( wxIsMainThread(), "must be called from the main thread" ); + + wxCHECK_RET( gs_socketInitCount > 0, "too many calls to Shutdown()" ); + + if ( !--gs_socketInitCount ) + { + wxSocketManager * const manager = wxSocketManager::Get(); + wxCHECK_RET( manager, "should have a socket manager" ); + + manager->OnExit(); } - return; - } +} - if (req_evt == EVT_LOST) { - m_connected = FALSE; - Close(); - } - if (m_notifyme) - OldOnNotify(req_evt); +// -------------------------------------------------------------------------- +// 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_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 = + m_eventsgot = 0; + + // when we create the first socket in the main thread we initialize the + // OS-dependent socket stuff: notice that this means that the user code + // needs to call wxSocket::Initialize() itself if the first socket it + // creates is not created in the main thread + if ( wxIsMainThread() ) + { + if ( !Initialize() ) + { + wxLogError(_("Cannot initialize sockets")); + } + } +} - // Unmask - SetNotify(m_neededreq | req_notif); +wxSocketBase::wxSocketBase() +{ + Init(); } -wxSocketEvent::wxSocketEvent(int id) - : wxEvent(id) +wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type) { - wxEventType type = (wxEventType)wxEVT_SOCKET; + Init(); + + SetFlags(flags); - SetEventType(type); + m_type = type; } -void wxSocketBase::OldOnNotify(wxRequestEvent evt) +wxSocketBase::~wxSocketBase() { - wxSocketEvent event(m_id); + // Shutdown and close the socket + if (!m_beingDeleted) + Close(); - event.SetEventObject(this); - event.m_skevt = evt; - ProcessEvent(event); + // Destroy the implementation object + delete m_impl; - if (m_cbk) - m_cbk(*this, evt, m_cdata); + // Free the pushback buffer + free(m_unread); } -// -------------------------------------------------------------- -// --------- wxSocketBase functions [Callback, CallbackData] ---- -// -------------------------------------------------------------- -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSocketBase::wxSockCbk _cbk) +bool wxSocketBase::Destroy() { - wxSockCbk old_cbk = m_cbk; + // 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; + + // Shutdown and close the socket + Close(); + + // Suppress events from now on + Notify(false); + + // Schedule this object for deletion instead of destroying it right now if + // possible as we may have other events pending for it + if ( wxTheApp ) + { + wxTheApp->ScheduleForDestruction(this); + } + else // no app + { + // in wxBase we might have no app object at all, don't leak memory + delete this; + } - m_cbk = _cbk; - return old_cbk; + return true; } -char *wxSocketBase::CallbackData(char *cdata_) +// ---------------------------------------------------------------------------- +// simple accessors +// ---------------------------------------------------------------------------- + +void wxSocketBase::SetError(wxSocketError error) { - char *old_cdata = m_cdata; + m_impl->m_error = error; +} - m_cdata = cdata_; - return old_cdata; +wxSocketError wxSocketBase::LastError() const +{ + return m_impl->GetError(); } -void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id) +// -------------------------------------------------------------------------- +// Basic IO calls +// -------------------------------------------------------------------------- + +// The following IO operations update m_lcount: +// {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard} +bool wxSocketBase::Close() { - SetNextHandler(&h_evt); - m_id = id; + // Interrupt pending waits + InterruptWait(); + + ShutdownOutput(); + + m_connected = false; + m_establishing = false; + return true; +} + +void wxSocketBase::ShutdownOutput() +{ + if ( m_impl ) + m_impl->Shutdown(); } -// -------------------------------------------------------------- -// --------- wxSocketBase pushback library ---------------------- -// -------------------------------------------------------------- -void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size) +wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { - char *curr_pos; + wxSocketReadGuard read(this); - m_unread = (char *) realloc(m_unread, m_unrd_size+size); - curr_pos = m_unread + m_unrd_size; + m_lcount = DoRead(buffer, nbytes); - memcpy(curr_pos, buffer, size); - m_unrd_size += size; + return *this; } -void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size) +wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) +{ + wxCHECK_MSG( m_impl, 0, "socket must be valid" ); + + // We use pointer arithmetic here which doesn't work with void pointers. + char *buffer = static_cast(buffer_); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); + + // 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; + + while ( nbytes ) + { + // our socket is non-blocking so Read() will return immediately if + // there is nothing to read yet and it's more efficient to try it first + // before entering DoWait() which is going to start dispatching GUI + // events and, even more importantly, we must do this under Windows + // where we're not going to get notifications about socket being ready + // for reading before we read all the existing data from it + const int ret = !m_impl->m_stream || m_connected + ? m_impl->Read(buffer, nbytes) + : 0; + if ( ret == -1 ) + { + if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK ) + { + // if we don't want to wait, just return immediately + if ( m_flags & wxSOCKET_NOWAIT ) + { + // this shouldn't be counted as an error in this case + SetError(wxSOCKET_NOERROR); + break; + } + + // otherwise wait until the socket becomes ready for reading or + // an error occurs on it + if ( !DoWaitWithTimeout(wxSOCKET_INPUT_FLAG) ) + { + // and exit if the timeout elapsed before it did + SetError(wxSOCKET_TIMEDOUT); + break; + } + + // retry reading + continue; + } + else // "real" error + { + SetError(wxSOCKET_IOERR); + break; + } + } + else 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; + + // we're not going to read anything else and so if we haven't read + // anything (or not everything in wxSOCKET_WAITALL case) already, + // signal an error + if ( (m_flags & wxSOCKET_WAITALL) || !total ) + SetError(wxSOCKET_IOERR); + break; + } + + total += ret; + + // if we are happy to read something and not the entire nbytes bytes, + // then we're done + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + nbytes -= ret; + buffer += ret; + } + + return total; +} + +wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) +{ + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; + + wxSocketReadGuard read(this); + + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL); + + bool ok = false; + if ( DoRead(&msg, sizeof(msg)) == sizeof(msg) ) + { + wxUint32 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 ) + { + wxUint32 len = (wxUint32)msg.len[0]; + len |= (wxUint32)(msg.len[1] << 8); + len |= (wxUint32)(msg.len[2] << 16); + len |= (wxUint32)(msg.len[3] << 24); + + wxUint32 len2; + if (len > nbytes) + { + len2 = len - nbytes; + len = nbytes; + } + else + len2 = 0; + + // Don't attempt to read if the msg was zero bytes long. + m_lcount = len ? DoRead(buffer, len) : 0; + + if ( len2 ) + { + char discard_buffer[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); + } + + if ( !len2 && DoRead(&msg, sizeof(msg)) == sizeof(msg) ) + { + 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 ) + ok = true; + } + } + } + + if ( !ok ) + SetError(wxSOCKET_IOERR); + + return *this; +} + +wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) { - char *curr_pos, *new_buf; + wxSocketReadGuard read(this); + + // Peek() should never block + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT); - new_buf = (char *) malloc(m_unrd_size+size); - curr_pos = new_buf + size; + m_lcount = DoRead(buffer, nbytes); - memcpy(new_buf, buffer, size); - memcpy(curr_pos, m_unread, m_unrd_size); + Pushback(buffer, m_lcount); - free(m_unread); - m_unread = new_buf; - m_unrd_size += size; + return *this; } -size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek) +wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { - if (!m_unrd_size) - return 0; + wxSocketWriteGuard write(this); - if (size > m_unrd_size) - size = m_unrd_size; - memcpy(buffer, m_unread, size); + m_lcount = DoWrite(buffer, nbytes); - if (!peek) { - m_unrd_size -= size; - if (!m_unrd_size) { - free(m_unread); - m_unread = NULL; + return *this; +} + +// This function is a mirror image of DoRead() except that it doesn't use the +// push back buffer and doesn't treat 0 return value specially (normally this +// shouldn't happen at all here), so please see comments there for explanations +wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes) +{ + wxCHECK_MSG( m_impl, 0, "socket must be valid" ); + + const char *buffer = static_cast(buffer_); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); + + wxUint32 total = 0; + while ( nbytes ) + { + if ( m_impl->m_stream && !m_connected ) + { + if ( (m_flags & wxSOCKET_WAITALL) || !total ) + SetError(wxSOCKET_IOERR); + break; + } + + const int ret = m_impl->Write(buffer, nbytes); + if ( ret == -1 ) + { + if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK ) + { + if ( m_flags & wxSOCKET_NOWAIT ) + break; + + if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) ) + { + SetError(wxSOCKET_TIMEDOUT); + break; + } + + continue; + } + else // "real" error + { + SetError(wxSOCKET_IOERR); + break; + } + } + + total += ret; + + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + nbytes -= ret; + buffer += ret; + } + + return total; +} + +wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) +{ + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; + + wxSocketWriteGuard write(this); + + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL); + + msg.sig[0] = (unsigned char) 0xad; + msg.sig[1] = (unsigned char) 0xde; + msg.sig[2] = (unsigned char) 0xed; + msg.sig[3] = (unsigned char) 0xfe; + + 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); + + bool ok = false; + if ( DoWrite(&msg, sizeof(msg)) == sizeof(msg) ) + { + m_lcount = DoWrite(buffer, nbytes); + if ( m_lcount == nbytes ) + { + 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 ( DoWrite(&msg, sizeof(msg)) == sizeof(msg)) + ok = true; + } } - } - return size; + if ( !ok ) + SetError(wxSOCKET_IOERR); + + return *this; } -// -------------------------------------------------------------- -// --------- wxSocketBase "multi-thread" core ------------------- -// -------------------------------------------------------------- +wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) +{ + if (nbytes != 0) + Pushback(buffer, nbytes); + + SetError(wxSOCKET_NOERROR); + m_lcount = nbytes; + + return *this; +} -bool wxSocketBase::DoRequests(wxRequestEvent req_flag) +wxSocketBase& wxSocketBase::Discard() { - wxNode *node = req_list[req_flag].First(); - size_t len; - int ret; + char *buffer = new char[MAX_DISCARD_SIZE]; + wxUint32 ret; + wxUint32 total = 0; + + wxSocketReadGuard read(this); - if (!node) - return FALSE; + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT); - SockRequest *req = (SockRequest *)node->Data(); + do + { + ret = DoRead(buffer, MAX_DISCARD_SIZE); + total += ret; + } + while (ret == MAX_DISCARD_SIZE); + + delete[] buffer; + m_lcount = total; + SetError(wxSOCKET_NOERROR); - delete node; + return *this; +} - 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; +// -------------------------------------------------------------------------- +// Wait functions +// -------------------------------------------------------------------------- + +/* + This function will check for the events specified in the flags parameter, + and it will return a mask indicating which operations can be performed. + */ +wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags, + const timeval *timeout) +{ + if ( m_fd == INVALID_SOCKET ) + return (wxSOCKET_LOST_FLAG & flags); + + struct timeval tv; + if ( timeout ) + tv = *timeout; + else + tv.tv_sec = tv.tv_usec = 0; + + // prepare the FD sets, passing NULL for the one(s) we don't use + fd_set + readfds, *preadfds = NULL, + writefds, *pwritefds = NULL, + exceptfds; // always want to know about errors + + if ( flags & wxSOCKET_INPUT_FLAG ) + preadfds = &readfds; + + if ( flags & wxSOCKET_OUTPUT_FLAG ) + pwritefds = &writefds; + + // When using non-blocking connect() the client socket becomes connected + // (successfully or not) when it becomes writable but when using + // non-blocking accept() the server socket becomes connected when it + // becomes readable. + if ( flags & wxSOCKET_CONNECTION_FLAG ) + { + if ( m_server ) + preadfds = &readfds; + else + pwritefds = &writefds; } - len = ret; - if ((len < req->size) && (m_flags & WAITALL)) { - req->size -= len; - req->nbytes += len; - req->buffer += len; - req->auto_wakeup->Start(m_timeout*1000, TRUE); - req_list[req_flag].Insert(req); - break; + + if ( preadfds ) + { + wxFD_ZERO(preadfds); + wxFD_SET(m_fd, preadfds); + } + + if ( pwritefds ) + { + wxFD_ZERO(pwritefds); + wxFD_SET(m_fd, pwritefds); } - 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) { - req->error = errno; - req->done = TRUE; - break; - } - len = ret; - if ((len < req->size) && (m_flags & WAITALL)) { - req->size -= len; - req->nbytes += len; - req->buffer += len; - req->auto_wakeup->Start(m_timeout*1000, TRUE); - req_list[req_flag].Insert(req); - break; - } - req->done = TRUE; - req->nbytes += len; -#ifndef __WXGTK__ - DestroyCallbacks(); -#endif - break; - default: - return FALSE; - } - return TRUE; -} - -void wxSocketBase::WantSpeedBuffer(char *buffer, size_t nbytes, - wxRequestEvent evt) -{ - 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; -} - -void wxSocketBase::WantBuffer(char *buffer, size_t nbytes, - wxRequestEvent evt) -{ - bool buf_timed_out; - - if (m_fd == INVALID_SOCKET || !m_handler || !m_connected) - return; - - if (m_flags & SPEED) { - WantSpeedBuffer(buffer, nbytes, evt); - return; - } - SockRequest *buf = new SockRequest; - wxSockWakeUp s_wake(NULL, (int *)&buf_timed_out, (int)TRUE); + wxFD_ZERO(&exceptfds); + wxFD_SET(m_fd, &exceptfds); - m_wantbuf++; - req_list[evt].Append(buf); + const int rc = select(m_fd + 1, preadfds, pwritefds, &exceptfds, &tv); - 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; + // check for errors first + if ( rc == -1 || wxFD_ISSET(m_fd, &exceptfds) ) + { + m_establishing = 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; + return wxSOCKET_LOST_FLAG & flags; + } + + if ( rc == 0 ) + return 0; + + wxASSERT_MSG( rc == 1, "unexpected select() return value" ); + + wxSocketEventFlags detected = 0; + if ( preadfds && wxFD_ISSET(m_fd, preadfds) ) + detected |= wxSOCKET_INPUT_FLAG; + + if ( pwritefds && wxFD_ISSET(m_fd, pwritefds) ) + { + // check for the case of non-blocking connect() + 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 ( error ) + detected = wxSOCKET_LOST_FLAG; + else + detected |= wxSOCKET_CONNECTION_FLAG; + } + else // not called to get non-blocking connect() status + { + detected |= wxSOCKET_OUTPUT_FLAG; + } + } - delete buf; - RestoreState(); + return detected & flags; } -// -------------------------------------------------------------- -// wxSocketServer /////////////////////////////////////////////// -// -------------------------------------------------------------- +int +wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) +{ + // 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; + + return DoWait(timeout, flags); +} -// -------------------------------------------------------------- -// --------- wxSocketServer CONSTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketServer::wxSocketServer(wxSockAddress& addr_man, - wxSockFlags flags) : - wxSocketBase(flags, SOCK_SERVER) +int +wxSocketBase::DoWait(long timeout, wxSocketEventFlags flags) { - m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0); + wxCHECK_MSG( m_impl, -1, "can't wait on invalid socket" ); + + // we're never going to become ready in a TCP client if we're not connected + // any more (OTOH a server can call this to precisely wait for a connection + // so do wait for it in this case and UDP client is never "connected") + if ( !m_impl->IsServer() && + m_impl->m_stream && !m_connected && !m_establishing ) + return -1; + + // This can be set to true from Interrupt() to exit this function a.s.a.p. + m_interrupt = false; - if (m_fd == INVALID_SOCKET) - return; - int flag = 1; - setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (char*)&flag, sizeof(int)); + const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout; - struct sockaddr *myaddr; - size_t len; + // Get the active event loop which we'll use for the message dispatching + // when running in the main thread unless this was explicitly disabled by + // setting wxSOCKET_BLOCK flag + wxEventLoopBase *eventLoop; + if ( !(m_flags & wxSOCKET_BLOCK) && wxIsMainThread() ) + { + eventLoop = wxEventLoop::GetActive(); + } + else // in worker thread + { + // We never dispatch messages from threads other than the main one. + eventLoop = NULL; + } - addr_man.Build(myaddr, len); - if (bind(m_fd, myaddr, addr_man.SockAddrLen()) < 0) - return; + // Make sure the events we're interested in are enabled before waiting for + // them: this is really necessary here as otherwise this could happen: + // 1. DoRead(wxSOCKET_WAITALL) is called + // 2. There is nothing to read so DoWait(wxSOCKET_INPUT_FLAG) is called + // 3. Some, but not all data appears, wxSocketImplUnix::OnReadWaiting() + // is called and wxSOCKET_INPUT_FLAG events are disabled in it + // 4. Because of wxSOCKET_WAITALL we call DoWait() again but the events + // are still disabled and we block forever + // + // More elegant solution would be nice but for now simply re-enabling the + // events here will do + m_impl->ReenableEvents(flags & (wxSOCKET_INPUT_FLAG | wxSOCKET_OUTPUT_FLAG)); + + + // Wait until we receive the event we're waiting for or the timeout expires + // (but note that we always execute the loop at least once, even if timeout + // is 0 as this is used for polling) + int rc = 0; + for ( bool firstTime = true; !m_interrupt; firstTime = false ) + { + long timeLeft = wxMilliClockToLong(timeEnd - wxGetLocalTimeMillis()); + if ( timeLeft < 0 ) + { + if ( !firstTime ) + break; // timed out + + timeLeft = 0; + } + + wxSocketEventFlags events; + if ( eventLoop ) + { + // reset them before starting to wait + m_eventsgot = 0; + + eventLoop->DispatchTimeout(timeLeft); + + events = m_eventsgot; + } + else // no event loop or waiting in another thread + { + // as explained below, we should always check for wxSOCKET_LOST_FLAG + timeval tv; + SetTimeValFromMS(tv, timeLeft); + events = m_impl->Select(flags | wxSOCKET_LOST_FLAG, &tv); + } + + // always check for wxSOCKET_LOST_FLAG, even if flags doesn't include + // it, as continuing to wait for anything else after getting it is + // pointless + if ( events & wxSOCKET_LOST_FLAG ) + { + m_connected = false; + m_establishing = false; + rc = -1; + break; + } + + // otherwise mask out the bits we're not interested in + events &= flags; + + // Incoming connection (server) or connection established (client)? + if ( events & wxSOCKET_CONNECTION_FLAG ) + { + m_connected = true; + m_establishing = false; + rc = true; + break; + } + + // Data available or output buffer ready? + if ( (events & wxSOCKET_INPUT_FLAG) || (events & wxSOCKET_OUTPUT_FLAG) ) + { + rc = true; + break; + } + } - if (listen(m_fd, 5) < 0) { - m_fd = INVALID_SOCKET; - return; - } + return rc; } -// -------------------------------------------------------------- -// --------- wxSocketServer Accept ------------------------------ -// -------------------------------------------------------------- -bool wxSocketServer::AcceptWith(wxSocketBase& sock) +bool wxSocketBase::Wait(long seconds, long milliseconds) { - int fd2; - - if ((fd2 = accept(m_fd, 0, 0)) < 0) - return FALSE; + return DoWait(seconds, milliseconds, + wxSOCKET_INPUT_FLAG | + wxSOCKET_OUTPUT_FLAG | + wxSOCKET_CONNECTION_FLAG) != 0; +} - struct linger linger; - linger.l_onoff = 0; - linger.l_linger = 1; +bool wxSocketBase::WaitForRead(long seconds, long milliseconds) +{ + // Check pushback buffer before entering DoWait + if ( m_unread ) + return true; - setsockopt(fd2, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger)); + // Check if the socket is not already ready for input, if it is, there is + // no need to start waiting for it (worse, we'll actually never get a + // notification about the socket becoming ready if it is already under + // Windows) + if ( m_impl->Select(wxSOCKET_INPUT_FLAG) ) + return true; - int flag = 0; - setsockopt(fd2, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int)); + return DoWait(seconds, milliseconds, wxSOCKET_INPUT_FLAG) != 0; +} - if (!(sock.m_flags & SPEED)) { - unsigned long flag2 = 1; - ioctl(fd2, FIONBIO, &flag2); - } - sock.m_type = SOCK_INTERNAL; - sock.m_fd = fd2; - sock.m_connected = TRUE; +bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) +{ + if ( m_impl->Select(wxSOCKET_OUTPUT_FLAG) ) + return true; - return TRUE; + return DoWait(seconds, milliseconds, wxSOCKET_OUTPUT_FLAG) != 0; } -wxSocketBase *wxSocketServer::Accept() +bool wxSocketBase::WaitForLost(long seconds, long milliseconds) { - wxSocketBase* sock = new wxSocketBase(); + return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG) == -1; +} - sock->SetFlags((wxSockFlags)m_flags); +// -------------------------------------------------------------------------- +// Miscellaneous +// -------------------------------------------------------------------------- - if (!AcceptWith(*sock)) - return NULL; +// +// Get local or peer address +// - if (m_handler) - m_handler->Register(sock); +bool wxSocketBase::GetPeer(wxSockAddress& addr) const +{ + wxCHECK_MSG( m_impl, false, "invalid socket" ); - return sock; + const wxSockAddressImpl& peer = m_impl->GetPeer(); + if ( !peer.IsOk() ) + return false; + + addr.SetAddress(peer); + + return true; } -// -------------------------------------------------------------- -// --------- wxSocketServer callbacks --------------------------- -// -------------------------------------------------------------- -void wxSocketServer::OnRequest(wxRequestEvent evt) +bool wxSocketBase::GetLocal(wxSockAddress& addr) const { - if (evt == EVT_ACCEPT) { - OldOnNotify(EVT_ACCEPT); - } + wxCHECK_MSG( m_impl, false, "invalid socket" ); + + const wxSockAddressImpl& local = m_impl->GetLocal(); + if ( !local.IsOk() ) + return false; + + addr.SetAddress(local); + + return true; } -// -------------------------------------------------------------- -// wxSocketClient /////////////////////////////////////////////// -// -------------------------------------------------------------- +// +// Save and restore socket state +// -// --------- wxSocketClient CONSTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) : - wxSocketBase(_flags, SOCK_CLIENT) +void wxSocketBase::SaveState() { + wxSocketState *state; + + state = new wxSocketState(); + + state->m_flags = m_flags; + state->m_notify = m_notify; + state->m_eventmask = m_eventmask; + state->m_clientData = m_clientData; + + m_states.Append(state); } -// -------------------------------------------------------------- -// --------- wxSocketClient DESTRUCTOR -------------------------- -// -------------------------------------------------------------- -wxSocketClient::~wxSocketClient() +void wxSocketBase::RestoreState() { + wxList::compatibility_iterator node; + wxSocketState *state; + + node = m_states.GetLast(); + if (!node) + return; + + state = (wxSocketState *)node->GetData(); + + m_flags = state->m_flags; + m_notify = state->m_notify; + m_eventmask = state->m_eventmask; + m_clientData = state->m_clientData; + + m_states.Erase(node); + delete state; } -// -------------------------------------------------------------- -// --------- wxSocketClient Connect functions ------------------- -// -------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) ) -{ - struct linger linger; +// +// Timeout and flags +// - if (IsConnected()) - Close(); +void wxSocketBase::SetTimeout(long seconds) +{ + m_timeout = seconds; - m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0); + if (m_impl) + m_impl->SetTimeout(m_timeout * 1000); +} - if (m_fd < 0) - return FALSE; +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_connected = FALSE; + m_flags = flags; +} - linger.l_onoff = 1; - linger.l_linger = 5; - setsockopt(m_fd, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger)); - // Stay in touch with the state of things... +// -------------------------------------------------------------------------- +// Event handling +// -------------------------------------------------------------------------- - unsigned long flag = 1; - setsockopt(m_fd, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int)); +void wxSocketBase::OnRequest(wxSocketNotify notification) +{ + wxSocketEventFlags flag = 0; + switch ( notification ) + { + case wxSOCKET_INPUT: + flag = wxSOCKET_INPUT_FLAG; + break; - // Disable the nagle algorithm, which delays sends till the - // buffer is full (or a certain time period has passed?)... + case wxSOCKET_OUTPUT: + flag = wxSOCKET_OUTPUT_FLAG; + break; -#if defined(__WINDOWS__) || (defined(IPPROTO_TCP) && defined(TCP_NODELAY)) - flag = 1; - setsockopt(m_fd, IPPROTO_TCP, TCP_NODELAY, (char*)&flag, sizeof(int)); -#endif + case wxSOCKET_CONNECTION: + flag = wxSOCKET_CONNECTION_FLAG; - struct sockaddr *remote; - size_t len; + // we're now successfully connected + m_connected = true; + m_establishing = false; - addr_man.Build(remote, len); + // error was previously set to wxSOCKET_WOULDBLOCK, but this is not + // the case any longer + SetError(wxSOCKET_NOERROR); + break; - if (connect(m_fd, remote, len) != 0) - return FALSE; + case wxSOCKET_LOST: + flag = wxSOCKET_LOST_FLAG; - if (!(m_flags & SPEED)) { - flag = 1; - ioctl(m_fd, FIONBIO, &flag); - } + // if we lost the connection the socket is now closed and not + // connected any more + m_connected = false; + m_closed = true; + break; - Notify(TRUE); + default: + wxFAIL_MSG( "unknown wxSocket notification" ); + } - m_connected = TRUE; - return TRUE; + // remember the events which were generated for this socket, we're going to + // use this in DoWait() + m_eventsgot |= flag; + + // send the wx event if enabled and we're interested in it + if ( m_notify && (m_eventmask & flag) && m_handler ) + { + // don't generate the events when we're inside DoWait() called from our + // own code as we are going to consume the data that has just become + // available ourselves and the user code won't see it at all + if ( (notification == wxSOCKET_INPUT && m_reading) || + (notification == wxSOCKET_OUTPUT && m_writing) ) + { + return; + } + + wxSocketEvent event(m_id); + event.m_event = notification; + event.m_clientData = m_clientData; + event.SetEventObject(this); + + m_handler->AddPendingEvent(event); + } } -bool wxSocketClient::WaitOnConnect(long seconds) +void wxSocketBase::Notify(bool notify) { - int ret = _Wait(seconds, 0, REQ_CONNECT | REQ_LOST); - - if (ret) - m_connected = TRUE; + m_notify = notify; +} - return m_connected; +void wxSocketBase::SetNotify(wxSocketEventFlags flags) +{ + m_eventmask = flags; } -void wxSocketClient::OnRequest(wxRequestEvent evt) +void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id) { - if (evt == EVT_CONNECT) { - if (m_connected) { - SetNotify(m_neededreq & ~REQ_CONNECT); - return; - } - m_waitflags = 0x40; - m_connected = TRUE; - OldOnNotify(EVT_CONNECT); - DestroyCallbacks(); - return; - } - wxSocketBase::OnRequest(evt); + m_handler = &handler; + m_id = id; } -///////////////////////////////////////////////////////////////// -// wxSocketHandler /////////////////////////////////////////////// -///////////////////////////////////////////////////////////////// +// -------------------------------------------------------------------------- +// Pushback buffer +// -------------------------------------------------------------------------- -wxSocketHandler *wxSocketHandler::master = NULL; -#if defined(__WINDOWS__) -static int win_initialized = 0; -#endif +void wxSocketBase::Pushback(const void *buffer, wxUint32 size) +{ + if (!size) return; + + if (m_unread == NULL) + m_unread = malloc(size); + else + { + void *tmp; + + tmp = malloc(m_unrd_size + size); + memcpy((char *)tmp + size, m_unread, m_unrd_size); + free(m_unread); -// -------------------------------------------------------------- -// --------- wxSocketHandler CONSTRUCTOR ------------------------ -// -------------------------------------------------------------- -#ifdef __WINDOWS__ + m_unread = tmp; + } + + m_unrd_size += size; -extern char wxPanelClassName[]; + memcpy(m_unread, buffer, size); +} -LRESULT APIENTRY _EXPORT wxSocketHandlerWndProc(HWND hWnd, UINT message, - WPARAM wParam, LPARAM lParam) +wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek) { - 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); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - if (!node) - return DefWindowProc(hWnd, message, wParam, lParam); + if (!m_unrd_size) + return 0; - sock = (wxSocketBase *)node->Data(); + if (size > (m_unrd_size-m_unrd_cur)) + size = m_unrd_size-m_unrd_cur; - 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; - } - sock->OnRequest(sk_req); + memcpy(buffer, (char *)m_unread + m_unrd_cur, size); - return (LRESULT)0; + if (!peek) + { + 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; + } + } + + return size; } -FARPROC wxSocketSubClassProc = NULL; -#endif +// ========================================================================== +// wxSocketServer +// ========================================================================== -wxSocketHandler::wxSocketHandler() +// -------------------------------------------------------------------------- +// Ctor +// -------------------------------------------------------------------------- + +wxSocketServer::wxSocketServer(const wxSockAddress& addr, + wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_SERVER) { -#if defined(__WINDOWS__) - if (!win_initialized) { - WSADATA wsaData; + wxLogTrace( wxTRACE_Socket, wxT("Opening wxSocketServer") ); - 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); + wxSocketManager * const manager = wxSocketManager::Get(); + m_impl = manager ? manager->CreateSocket(*this) : NULL; - // Subclass the window - if (!wxSocketSubClassProc) - wxSocketSubClassProc = MakeProcInstance((FARPROC) wxSocketHandlerWndProc, wxhInstance); - ::SetWindowLong(internal->sockWin, GWL_WNDPROC, (LONG) wxSocketSubClassProc); - ::SetWindowLong(internal->sockWin, GWL_USERDATA, (LONG) this); + if (!m_impl) + { + wxLogTrace( wxTRACE_Socket, wxT("*** Failed to create m_impl") ); + return; + } - internal->firstAvailableMsg = 5000; - smsg_list = new wxList(wxKEY_INTEGER); -#endif + // Setup the socket as server + m_impl->SetLocal(addr.GetAddress()); - socks = new wxList; + if (GetFlags() & wxSOCKET_REUSEADDR) { + m_impl->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) { + m_impl->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) { + m_impl->DontDoBind(); + } -#ifndef __WINDOWS__ - signal(SIGPIPE, SIG_IGN); -#endif + if (m_impl->CreateServer() != wxSOCKET_NOERROR) + { + wxDELETE(m_impl); + + wxLogTrace( wxTRACE_Socket, wxT("*** CreateServer() failed") ); + return; + } + + wxLogTrace( wxTRACE_Socket, wxT("wxSocketServer on fd %d"), m_impl->m_fd ); } -// -------------------------------------------------------------- -// --------- wxSocketHandler DESTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketHandler::~wxSocketHandler() +// -------------------------------------------------------------------------- +// Accept +// -------------------------------------------------------------------------- + +bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { - wxNode *next_node, *node = socks->First(); + if ( !m_impl || (m_impl->m_fd == INVALID_SOCKET) || !m_impl->IsServer() ) + { + wxFAIL_MSG( "can only be called for a valid server socket" ); - while (node) { - wxSocketBase* sock = (wxSocketBase*)node->Data(); + SetError(wxSOCKET_INVSOCK); - delete sock; - next_node = node->Next(); - delete node; - node = next_node; - } + return false; + } - delete socks; + if ( wait ) + { + // wait until we get a connection + if ( !m_impl->SelectWithTimeout(wxSOCKET_INPUT_FLAG) ) + { + SetError(wxSOCKET_TIMEDOUT); -#ifdef __WINDOWS__ - delete smsg_list; + return false; + } + } - ::DestroyWindow(internal->sockWin); - WSACleanup(); - win_initialized = 0; + sock.m_impl = m_impl->Accept(sock); - delete internal; -#endif + if ( !sock.m_impl ) + { + SetError(m_impl->GetLastError()); + + return false; + } + + sock.m_type = wxSOCKET_BASE; + sock.m_connected = true; + + return true; } -// -------------------------------------------------------------- -// --------- wxSocketHandler registering functions -------------- -// -------------------------------------------------------------- -void wxSocketHandler::Register(wxSocketBase* sock) +wxSocketBase *wxSocketServer::Accept(bool wait) { - wxNode *node; + wxSocketBase* sock = new wxSocketBase(); + + sock->SetFlags(m_flags); - for (node = socks->First(); node != NULL; node = node->Next()) { - wxSocketBase* s = (wxSocketBase*)node->Data(); + if (!AcceptWith(*sock, wait)) + { + sock->Destroy(); + sock = NULL; + } - if (s == sock) - return; - } + return sock; +} - if (sock) { - socks->Append(sock); - sock->SetHandler(this); - sock->SetupCallbacks(); - } +bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) +{ + return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) == 1; } -void wxSocketHandler::UnRegister(wxSocketBase* sock) +bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen) { - wxNode *node; + wxASSERT_MSG( m_impl, wxT("Socket not initialised") ); - for (node = socks->First(); node; node = node->Next()) { - wxSocketBase* s = (wxSocketBase*)node->Data(); + SOCKOPTLEN_T lenreal = *optlen; + if ( getsockopt(m_impl->m_fd, level, optname, + static_cast(optval), &lenreal) != 0 ) + return false; - if (s == sock) { - delete node; - sock->DestroyCallbacks(); - sock->SetHandler(NULL); - return; - } - } + *optlen = lenreal; + + return true; } -unsigned long wxSocketHandler::Count() const +bool +wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen) { - return socks->Number(); + wxASSERT_MSG( m_impl, wxT("Socket not initialised") ); + + return setsockopt(m_impl->m_fd, level, optname, + static_cast(optval), optlen) == 0; } -// -------------------------------------------------------------- -// --------- wxSocketHandler "big" wait functions --------------- -// -------------------------------------------------------------- -void handler_cbk(wxSocketBase& sock, - wxSocketBase::wxRequestEvent WXUNUSED(flags), - char *cdata) +bool wxSocketBase::SetLocal(const wxIPV4address& local) { - int *a_wait = (int *)cdata; + m_localAddress = local; - (*a_wait)++; - sock.Notify(FALSE); + return true; } -int wxSocketHandler::Wait(long seconds, long microseconds) +// ========================================================================== +// wxSocketClient +// ========================================================================== + +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- + +wxSocketClient::wxSocketClient(wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_CLIENT) { - int i; - int on_wait; - wxSockWakeUp s_wake(NULL, &on_wait, -2); - wxNode *node; + m_initialRecvBufferSize = + m_initialSendBufferSize = -1; +} - for (node = socks->First(), i=0; node; node = node->Next(), i++) { - wxSocketBase *sock = (wxSocketBase *)node->Data(); +// -------------------------------------------------------------------------- +// Connect +// -------------------------------------------------------------------------- - sock->SaveState(); +bool wxSocketClient::DoConnect(const wxSockAddress& remote, + const wxSockAddress* local, + bool wait) +{ + if ( m_impl ) + { + // Shutdown and destroy the old socket + Close(); + delete m_impl; + } - sock->SetupCallbacks(); + m_connected = false; + m_establishing = false; - sock->Callback(handler_cbk); - sock->CallbackData((char *)&on_wait); - } - on_wait = 0; - if (seconds != -1) - s_wake.Start((seconds*1000) + (microseconds/1000), TRUE); + // Create and set up the new one + wxSocketManager * const manager = wxSocketManager::Get(); + m_impl = manager ? manager->CreateSocket(*this) : NULL; + if ( !m_impl ) + return false; - 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(); + // Bind to the local IP address and port, when provided or if one had been + // set before + if ( !local && m_localAddress.GetAddress().IsOk() ) + local = &m_localAddress; - sock->RestoreState(); - } + if ( local ) + m_impl->SetLocal(local->GetAddress()); - if (on_wait == -2) - return 0; + m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); - return on_wait; -} + m_impl->SetPeer(remote.GetAddress()); -void wxSocketHandler::YieldSock() -{ - wxNode *node; + // Finally do create the socket and connect to the peer + const wxSocketError err = m_impl->CreateClient(wait); - for (node = socks->First(); node; node = node->Next() ) { - wxSocketBase *sock = (wxSocketBase *)node->Data(); + if ( err != wxSOCKET_NOERROR ) + { + if ( err == wxSOCKET_WOULDBLOCK ) + { + wxASSERT_MSG( !wait, "shouldn't get this for blocking connect" ); - sock->SaveState(); + 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& remote, bool wait) { - wxSocketServer *serv = new wxSocketServer(addr, flags); + return DoConnect(remote, NULL, wait); +} - Register(serv); - return serv; +bool wxSocketClient::Connect(const wxSockAddress& remote, + const wxSockAddress& local, + bool wait) +{ + return DoConnect(remote, &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; + // notice that we return true even if DoWait() returned -1, i.e. if an + // error occurred and connection was lost: this is intentional as we should + // return false only if timeout expired without anything happening + return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) != 0; } -#ifdef __WINDOWS__ -// -------------------------------------------------------------- -// --------- wxSocketHandler: Windows specific methods ---------- -// -------------------------------------------------------------- -UINT wxSocketHandler::NewMessage(wxSocketBase *sock) +// ========================================================================== +// wxDatagramSocket +// ========================================================================== + +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 + wxSocketManager * const manager = wxSocketManager::Get(); + m_impl = manager ? manager->CreateSocket(*this) : NULL; + + if (!m_impl) + return; + + // 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(); + } + + if ( m_impl->CreateUDP() != wxSOCKET_NOERROR ) + { + wxDELETE(m_impl); + return; + } + + // Initialize all stuff + m_connected = false; + m_establishing = false; } -void wxSocketHandler::DestroyMessage(UINT msg) +wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, + void* buf, + wxUint32 nBytes ) { - wxNode *node = smsg_list->Find(msg); - delete node; + Read(buf, nBytes); + GetPeer(addr); + return (*this); } -HWND wxSocketHandler::GetHWND() const +wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr, + const void* buf, + wxUint32 nBytes ) { - return internal->sockWin; + wxASSERT_MSG( m_impl, wxT("Socket not initialised") ); + + m_impl->SetPeer(addr.GetAddress()); + Write(buf, nBytes); + return (*this); } +// ========================================================================== +// wxSocketModule +// ========================================================================== + +class wxSocketModule : public wxModule +{ +public: + virtual bool OnInit() + { + // wxSocketBase will call Initialize() itself only if sockets are + // really used, don't do it from here + return true; + } + + virtual void OnExit() + { + if ( wxSocketBase::IsInitialized() ) + wxSocketBase::Shutdown(); + } + +private: + DECLARE_DYNAMIC_CLASS(wxSocketModule) +}; + +IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) + +#if defined(wxUSE_SELECT_DISPATCHER) && wxUSE_SELECT_DISPATCHER +// NOTE: we need to force linking against socketiohandler.cpp otherwise in +// static builds of wxWidgets the ManagerSetter::ManagerSetter ctor +// contained there wouldn't be ever called +wxFORCE_LINK_MODULE( socketiohandler ) #endif +// same for ManagerSetter in the MSW file +#ifdef __WXMSW__ + wxFORCE_LINK_MODULE( mswsocket ) #endif - // __WXSTUBS__ + +// and for OSXManagerSetter in the OS X one +#ifdef __WXOSX__ + wxFORCE_LINK_MODULE( osxsocket ) +#endif + +#endif // wxUSE_SOCKETS