X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2a4f27f2094c466e5c78a57958fe9d186de43d76..4c1d5d5ae212f255662264677d21c7139f4c939d:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 2372865175..88ad1f1548 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,1079 +1,1507 @@ -//////////////////////////////////////////////////////////////////////////////// -// 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: April 1999 -// Copyright: (C) 1999 1998, 1997, Guilhem Lavaux +// Copyright: (C) 1999-1997, Guilhem Lavaux +// (C) 2000-1999, Guillermo Rodriguez Garcia // RCS_ID: $Id$ -// License: see wxWindows license -//////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "socket.h" -#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 + #pragma hdrstop #endif #if wxUSE_SOCKETS -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// -#include -#include -#include -#include -#include +#include "wx/socket.h" + +#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 -// Not enough OS behaviour defined for wxStubs -#ifndef __WXSTUBS__ +#include "wx/apptrait.h" +#include "wx/sckaddr.h" +#include "wx/stopwatch.h" +#include "wx/thread.h" +#include "wx/evtloop.h" -#include -#include -#include +// DLL options compatibility check: +#include "wx/build.h" +WX_CHECK_BUILD_OPTIONS("wxNet") -///////////////////////////////////////////////////////////////////////////// -// System specific headers -///////////////////////////////////////////////////////////////////////////// -#ifdef __WXMAC__ -// in order to avoid problems with our c library and double definitions -#define close closesocket -#define ioctl ioctlsocket +// -------------------------------------------------------------------------- +// macros and constants +// -------------------------------------------------------------------------- -#include +// discard buffer +#define MAX_DISCARD_SIZE (10 * 1024) -#endif +#define wxTRACE_Socket _T("wxSocket") -#if defined(__WINDOWS__) -#include -#endif // __WINDOWS__ +// -------------------------------------------------------------------------- +// wxWin macros +// -------------------------------------------------------------------------- -#if defined(__UNIX__) +IMPLEMENT_CLASS(wxSocketBase, wxObject) +IMPLEMENT_CLASS(wxSocketServer, wxSocketBase) +IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) +IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase) +IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) -#ifdef VMS -#include -#else -#include -#endif -#include +// -------------------------------------------------------------------------- +// private classes +// -------------------------------------------------------------------------- -#include -#include +class wxSocketState : public wxObject +{ +public: + wxSocketFlags m_flags; + wxSocketEventFlags m_eventmask; + bool m_notify; + void *m_clientData; -#ifdef sun -#include -#endif +public: + wxSocketState() : wxObject() {} + + DECLARE_NO_COPY_CLASS(wxSocketState) +}; -#endif // __UNIX__ +// Conditionally make the socket non-blocking for the lifetime of this object. +class wxSocketUnblocker +{ +public: + wxSocketUnblocker(GSocket *socket, bool unblock = true) + : m_socket(socket), + m_unblock(unblock) + { + if ( m_unblock ) + m_socket->SetNonBlocking(true); + } -#include -#include + ~wxSocketUnblocker() + { + if ( m_unblock ) + m_socket->SetNonBlocking(false); + } -#ifdef __VISUALC__ -#include -#endif +private: + GSocket * const m_socket; + bool m_unblock; -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// -#include -#define WXSOCK_INTERNAL -#include -#include -#include - -// ---------------------- -// 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 + DECLARE_NO_COPY_CLASS(wxSocketUnblocker) +}; -#ifndef __WINDOWS__ -#define INVALID_SOCKET -1 -#endif +// ============================================================================ +// GSocketManager +// ============================================================================ -#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). +GSocketManager *GSocketManager::ms_manager = NULL; -#if defined( NEED_WSAFDIsSet ) || defined( __VISUALC__ ) -int PASCAL FAR __WSAFDIsSet(SOCKET fd, fd_set FAR *set) +/* static */ +void GSocketManager::Set(GSocketManager *manager) { - int i = set->fd_count; + wxASSERT_MSG( !ms_manager, "too late to set manager now" ); - while (i--) - { - if (set->fd_array[i] == fd) - return 1; - } + ms_manager = manager; +} - return 0; +/* static */ +void GSocketManager::Init() +{ + wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" ); + + /* + 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" ); + + wxAppConsole * const app = wxAppConsole::GetInstance(); + wxCHECK_RET( app, "sockets can't be initialized without wxApp" ); + + ms_manager = app->GetTraits()->GetSocketManager(); } -#endif -#endif -// ------------------- -// Some patch ---- END -// ------------------- +// ========================================================================== +// wxSocketBase +// ========================================================================== + +// -------------------------------------------------------------------------- +// Initialization and shutdown +// -------------------------------------------------------------------------- -#ifdef GetClassInfo -#undef GetClassInfo -#endif +// 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; -// -------------------------------------------------------------- -// Module -// -------------------------------------------------------------- -class wxSocketModule: public wxModule +bool wxSocketBase::IsInitialized() { - DECLARE_DYNAMIC_CLASS(wxSocketModule) -public: - wxSocketModule() {} - bool OnInit(); - void OnExit(); -}; - -// -------------------------------------------------------------- -// 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) -IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) -#endif + return m_countInit > 0; +} -// -------------------------------------------------------------- -// --------- 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_id(-1), - m_handler(0), - m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)), - m_timeout(3600), - m_unread(NULL), m_unrd_size(0), - m_cbk(NULL), m_cdata(NULL), - m_notify_state(FALSE) +bool wxSocketBase::Initialize() { - m_internal = new wxSocketInternal(this); + if ( !m_countInit++ ) + { + if ( !GSocket_Init() ) + { + m_countInit--; + + return false; + } + } + + return true; } -wxSocketBase::wxSocketBase() : - wxEvtHandler(), - m_flags(WAITALL), m_type(SOCK_UNINIT), m_connected(FALSE), - m_connecting(FALSE), m_fd(INVALID_SOCKET), - m_id(-1), m_handler(0), - m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)), - m_timeout(3600), - m_unread(NULL), m_unrd_size(0), - m_cbk(NULL), m_cdata(NULL), - m_notify_state(FALSE) +void wxSocketBase::Shutdown() { - m_internal = new wxSocketInternal(this); + // we should be initialized + wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") ); + if ( --m_countInit == 0 ) + { + GSocket_Cleanup(); + } } -// -------------------------------------------------------------- -// wxSocketBase -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- -wxSocketBase::~wxSocketBase() +void wxSocketBase::Init() { - // First, close the file descriptor. - Close(); + m_socket = 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() ) + { + // this Initialize() will be undone by wxSocketModule::OnExit(), all + // the other calls to it should be matched by a call to Shutdown() + Initialize(); + } +} + +wxSocketBase::wxSocketBase() +{ + Init(); +} - if (m_unread) - free(m_unread); - // Unregister from the handler database. - if (m_handler) - m_handler->UnRegister(this); +wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type) +{ + Init(); - // Destroy all saved states. - m_states.DeleteContents(TRUE); + SetFlags(flags); - // Destroy the socket manager. - delete m_internal; + m_type = type; } -bool wxSocketBase::Close() +wxSocketBase::~wxSocketBase() { - if (m_fd != INVALID_SOCKET) - { - if (m_notify_state == TRUE) - Notify(FALSE); - - // Shutdown the connection. - shutdown(m_fd, 2); - close(m_fd); - m_fd = INVALID_SOCKET; - m_connected = FALSE; - } - - return TRUE; + // 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); + + // Shutdown and close the socket + if (!m_beingDeleted) + Close(); + + // Destroy the GSocket object + if (m_socket) + delete m_socket; + + // Free the pushback buffer + if (m_unread) + free(m_unread); } -// -------------------------------------------------------------- -// wxSocketBase base IO function -// -------------------------------------------------------------- - -wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes) +bool wxSocketBase::Destroy() { - m_lcount = GetPushback(buffer, nbytes, FALSE); - nbytes -= m_lcount; - buffer += m_lcount; + // 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 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; - } + // Shutdown and close the socket + Close(); + + // Supress events from now on + Notify(false); - WantBuffer(buffer, nbytes, EVT_READ); + // 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 *this; + return true; } -wxSocketBase& wxSocketBase::Peek(char* buffer, size_t nbytes) +// -------------------------------------------------------------------------- +// 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_lcount = GetPushback(buffer, nbytes, TRUE); - if (nbytes-m_lcount == 0) - { - return *this; - } - buffer += m_lcount; - nbytes -= m_lcount; + // Interrupt pending waits + InterruptWait(); - WantBuffer(buffer, nbytes, EVT_PEEK); + if (m_socket) + { + // Disable callbacks + m_socket->UnsetCallback( + GSOCK_INPUT_FLAG | + GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | + GSOCK_CONNECTION_FLAG + ); + + // Shutdown the connection + m_socket->Shutdown(); + } - return *this; + m_connected = false; + m_establishing = false; + return true; } -wxSocketBase& wxSocketBase::Write(const char *buffer, size_t nbytes) +wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { - m_lcount = 0; - WantBuffer((char *)buffer, nbytes, EVT_WRITE); - return *this; -} + // Mask read events + m_reading = true; -wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes) -{ - CreatePushbackAfter(buffer, nbytes); - return *this; + 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); + + // Allow read events from now on + m_reading = false; + + return *this; } -bool wxSocketBase::IsData() const +wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) { - struct timeval tv; - fd_set sock_set; + // We use pointer arithmetic here which doesn't work with void pointers. + char *buffer = static_cast(buffer_); - if (m_fd < 0) - return FALSE; - if (m_unrd_size > 0) - return TRUE; + // 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; - m_internal->AcquireFD(); + // If it's indeed closed or if read everything, there is nothing more to do. + if ( !m_socket || !nbytes ) + return total; - 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); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - m_internal->ReleaseFD(); - return (FD_ISSET(m_fd, &sock_set) != 0); + // 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 ) + { + wxSocketUnblocker unblock(m_socket); + int ret = m_socket->Read(buffer, nbytes); + if ( ret < 0 ) + return 0; + + total += ret; + } + else // blocking socket + { + 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_socket->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; + } + } + + return total; } -// --------------------------------------------------------------------- -// --------- wxSocketBase Discard(): deletes all byte in the input queue -// --------------------------------------------------------------------- -void wxSocketBase::Discard() +wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) { -#define MAX_BUFSIZE (10*1024) - char *my_data = new char[MAX_BUFSIZE]; - size_t recv_size = MAX_BUFSIZE; + wxUint32 len, len2, sig, total; + bool error; + int old_flags; + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; - SaveState(); - SetFlags((wxSockFlags)(NOWAIT | SPEED)); + // Mask read events + m_reading = true; - while (recv_size == MAX_BUFSIZE) - { - recv_size = Read(my_data, MAX_BUFSIZE).LastCount(); - } + total = 0; + error = true; + old_flags = m_flags; + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); - RestoreState(); - delete [] my_data; + if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) + goto exit; -#undef MAX_BUFSIZE -} + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); -// 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. + if (sig != 0xfeeddead) + { + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); + goto exit; + } -// JACS - How can we detect this? -// Meanwhile, if your compiler complains about socklen_t, -// switch lines below. + len = (wxUint32)msg.len[0]; + len |= (wxUint32)(msg.len[1] << 8); + len |= (wxUint32)(msg.len[2] << 16); + len |= (wxUint32)(msg.len[3] << 24); -#if wxHAVE_GLIBC2 -# define wxSOCKET_INT socklen_t -#else -# define wxSOCKET_INT int -#endif + if (len > nbytes) + { + len2 = len - nbytes; + len = nbytes; + } + else + len2 = 0; + + // Don't attempt to read if the msg was zero bytes long. + if (len) + { + total = DoRead(buffer, len); -// -------------------------------------------------------------- -// wxSocketBase socket info functions -// -------------------------------------------------------------- + if (total != len) + goto exit; + } -bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const -{ - struct sockaddr my_addr; - wxSOCKET_INT len_addr = sizeof(my_addr); + if (len2) + { + 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; + } + if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) + goto exit; - if (m_fd < 0) - return FALSE; + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); - m_internal->AcquireFD(); + if (sig != 0xdeadfeed) + { + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); + goto exit; + } - if (getpeername(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) { - m_internal->ReleaseFD(); - return FALSE; - } + // everything was OK + error = false; - m_internal->ReleaseFD(); - addr_man.Disassemble(&my_addr, len_addr); - return TRUE; +exit: + m_error = error; + m_lcount = total; + m_reading = false; + SetFlags(old_flags); + + return *this; } -bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const +wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) { - struct sockaddr my_addr; - wxSOCKET_INT len_addr = sizeof(my_addr); + // Mask read events + m_reading = true; - if (m_fd < 0) - return FALSE; + m_lcount = DoRead(buffer, nbytes); + Pushback(buffer, m_lcount); - m_internal->AcquireFD(); + // 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 (getsockname(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) { - m_internal->ReleaseFD(); - return FALSE; - } - m_internal->ReleaseFD(); + // Allow read events again + m_reading = false; - addr_man.Disassemble(&my_addr, len_addr); - return TRUE; + return *this; } -// -------------------------------------------------------------- -// wxSocketBase wait functions -// -------------------------------------------------------------- - -void wxSocketBase::SaveState() +wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { - SocketState *state = new SocketState; + // Mask write events + m_writing = true; + + m_lcount = DoWrite(buffer, nbytes); - state->notify_state = m_notify_state; - state->evt_notify_state = m_neededreq; - state->socket_flags = m_flags; - state->c_callback = m_cbk; - state->c_callback_data = m_cdata; + // 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); - m_states.Append((wxObject *)state); + // Allow write events again + m_writing = false; + + return *this; } -void wxSocketBase::RestoreState() +// 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) { - wxNode *node; - SocketState *state; + const char *buffer = static_cast(buffer_); - node = m_states.Last(); - if (!node) - return; + // Return if there is nothing to read or the socket is (already?) closed. + if ( !m_socket || !nbytes ) + return 0; - state = (SocketState *)node->Data(); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - SetFlags(state->socket_flags); - m_neededreq = state->evt_notify_state; - m_cbk = state->c_callback; - m_cdata = state->c_callback_data; - Notify(state->notify_state); + wxUint32 total = 0; + if ( m_flags & wxSOCKET_NOWAIT ) + { + wxSocketUnblocker unblock(m_socket); + const int ret = m_socket->Write(buffer, nbytes); + if ( ret > 0 ) + total += ret; + } + else // blocking socket + { + for ( ;; ) + { + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() ) + break; + + const int ret = m_socket->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; + } + } - delete node; - delete state; + return total; } -// -------------------------------------------------------------- -// --------- wxSocketBase callback functions -------------------- -// -------------------------------------------------------------- +wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) +{ + wxUint32 total; + bool error; + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; + + // Mask write events + m_writing = true; + + error = true; + total = 0; + SetFlags((m_flags & wxSOCKET_BLOCK) | 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); + + if (DoWrite(&msg, sizeof(msg)) < sizeof(msg)) + goto exit; + + total = DoWrite(buffer, nbytes); + + if (total < nbytes) + goto exit; + + 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)) + goto exit; + + // everything was OK + error = false; + +exit: + m_error = error; + m_lcount = total; + m_writing = false; -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) + return *this; +} + +wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) { - wxSockCbk old_cbk = cbk_; + if (nbytes != 0) + Pushback(buffer, nbytes); - m_cbk = cbk_; - return old_cbk; + m_error = false; + m_lcount = nbytes; + + return *this; } -char *wxSocketBase::CallbackData(char *data) +wxSocketBase& wxSocketBase::Discard() { - char *old_data = m_cdata; + char *buffer = new char[MAX_DISCARD_SIZE]; + wxUint32 ret; + wxUint32 total = 0; + + // Mask read events + m_reading = true; + + SetFlags(wxSOCKET_NOWAIT); + + do + { + ret = DoRead(buffer, MAX_DISCARD_SIZE); + total += ret; + } + while (ret == MAX_DISCARD_SIZE); - m_cdata = data; - return old_data; + delete[] buffer; + m_lcount = total; + m_error = false; + + // Allow read events again + m_reading = false; + + return *this; } -// -------------------------------------------------------------- -// --------- wxSocketBase wait functions ------------------------ -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Wait functions +// -------------------------------------------------------------------------- -bool wxSocketBase::_Wait(long seconds, long milliseconds, int type) +// All Wait functions poll the socket using GSocket_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::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) { - SockRequest *req; + wxCHECK_MSG( m_socket, false, "can't wait on invalid socket" ); + + // This can be set to true from Interrupt() to exit this function a.s.a.p. + m_interrupt = false; - if ((!m_connected && !m_connecting) || m_fd < 0) - return FALSE; - req = new SockRequest; + // 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; + + // Get the active event loop which we'll use for the message dispatching + // when running in the main thread + wxEventLoopBase *eventLoop; + if ( wxIsMainThread() ) + { + eventLoop = wxEventLoop::GetActive(); + +#ifdef __WXMSW__ + wxASSERT_MSG( eventLoop, + "Sockets won't work without a running event loop" ); +#endif // __WXMSW__ + } + else // in worker thread + { + // We never dispatch messages from threads other than the main one. + eventLoop = NULL; + } - req->type = REQ_WAIT | type; - req->timeout = seconds * 1000 + milliseconds; - req->done = FALSE; - req->buffer = NULL; - req->size = 0; - req->error = 0; - req->wait = TRUE; - m_internal->QueueRequest(req, TRUE); + // 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 ( ;; ) + { + // We always stop waiting when the connection is lost as it doesn't + // make sense to continue further, even if GSOCK_LOST_FLAG is not + // specified in flags to wait for. + const GSocketEventFlags + result = m_socket->Select(flags | GSOCK_LOST_FLAG); + + // Incoming connection (server) or connection established (client)? + if ( result & GSOCK_CONNECTION_FLAG ) + { + m_connected = true; + m_establishing = false; + gotEvent = true; + break; + } + + // Data available or output buffer ready? + if ( (result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG) ) + { + gotEvent = true; + break; + } + + // Connection lost + if ( result & GSOCK_LOST_FLAG ) + { + m_connected = false; + m_establishing = false; + if ( flags & GSOCK_LOST_FLAG ) + gotEvent = true; + break; + } + + if ( m_interrupt ) + break; + + // Wait more? + const wxMilliClock_t timeNow = wxGetLocalTimeMillis(); + if ( timeNow >= timeEnd ) + break; + + if ( eventLoop ) + { + // Dispatch the events when we run in the main thread and have an + // active event loop: without this sockets don't work at all under + // MSW as socket flags are only updated when socket messages are + // processed. + 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 + } - return (req->io_nbytes != 0); + return gotEvent; } bool wxSocketBase::Wait(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, REQ_ACCEPT | REQ_CONNECT | - REQ_READ | REQ_WRITE | REQ_LOST); + return DoWait(seconds, milliseconds, + GSOCK_INPUT_FLAG | + GSOCK_OUTPUT_FLAG | + GSOCK_CONNECTION_FLAG | + GSOCK_LOST_FLAG + ); } bool wxSocketBase::WaitForRead(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, REQ_READ | REQ_LOST); + // Check pushback buffer before entering DoWait + if ( m_unread ) + return true; + + // Note that GSOCK_INPUT_LOST has to be explicitly passed to DoWait + // because of the semantics of WaitForRead: a return value of true means + // that a GSocket_Read call will return immediately, not that there is + // actually data to read. + return DoWait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG); } + bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, REQ_WRITE); + return DoWait(seconds, milliseconds, GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG); } bool wxSocketBase::WaitForLost(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, REQ_LOST); + return DoWait(seconds, milliseconds, GSOCK_LOST_FLAG); } -// -------------------------------------------------------------- -// --------- wxSocketBase callback management ------------------- -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Miscellaneous +// -------------------------------------------------------------------------- -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; -} +// +// Get local or peer address +// -void wxSocketBase::SetFlags(wxSockFlags _flags) +bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const { - m_flags = _flags; - if (_flags & SPEED) { - // SPEED and WAITALL are antagonists. - m_flags = (wxSockFlags)(m_flags & ~WAITALL); - } -} + GAddress *peer; -wxSocketBase::wxSockFlags wxSocketBase::GetFlags() const -{ - return m_flags; -} + if (!m_socket) + return false; -void wxSocketBase::SetNotify(wxRequestNotify flags) -{ - /* Check if server */ - if (m_type != SOCK_SERVER) - flags &= ~REQ_ACCEPT; - - m_neededreq = flags; - if (m_neededreq == 0) - m_internal->StopWaiter(); - else - Notify(m_notify_state); -} + peer = m_socket->GetPeer(); -void wxSocketBase::Notify(bool notify) -{ - m_notify_state = notify; - if (m_fd == INVALID_SOCKET) - return; - - if (notify) - m_internal->ResumeWaiter(); - else - m_internal->StopWaiter(); -} + // copying a null address would just trigger an assert anyway -void wxSocketBase::OnRequest(wxRequestEvent req_evt) -{ - wxSocketEvent event(m_id); - wxRequestNotify notify = EventToNotify(req_evt); - - if ((m_neededreq & notify) == notify) { - event.m_socket = this; - event.m_skevt = req_evt; - ProcessEvent(event); - // TODOTODO - // OldOnNotify(req_evt); - - // We disable the event reporting. - m_neededreq &= ~notify; - } -} + if (!peer) + return false; -wxSocketEvent::wxSocketEvent(int id) - : wxEvent(id) -{ - wxEventType type = (wxEventType)wxEVT_SOCKET; + addr_man.SetAddress(peer); + GAddress_destroy(peer); - SetEventType(type); + return true; } -void wxSocketEvent::CopyObject(wxObject& obj_d) const +bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const { - wxSocketEvent *event = (wxSocketEvent *)&obj_d; + GAddress *local; - wxEvent::CopyObject(obj_d); + if (!m_socket) + return false; - event->m_skevt = m_skevt; - event->m_socket = m_socket; -} + local = m_socket->GetLocal(); + addr_man.SetAddress(local); + GAddress_destroy(local); -void wxSocketBase::OldOnNotify(wxRequestEvent evt) -{ + return true; } -// -------------------------------------------------------------- -// --------- wxSocketBase functions [Callback, CallbackData] ---- -// -------------------------------------------------------------- +// +// Save and restore socket state +// -void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id) +void wxSocketBase::SaveState() { - SetNextHandler(&h_evt); - m_id = id; -} + wxSocketState *state; -// -------------------------------------------------------------- -// --------- wxSocketBase pushback library ---------------------- -// -------------------------------------------------------------- + state = new wxSocketState(); -void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size) -{ - char *curr_pos; + state->m_flags = m_flags; + state->m_notify = m_notify; + state->m_eventmask = m_eventmask; + state->m_clientData = m_clientData; - if (m_unread != NULL) - m_unread = (char *) realloc(m_unread, m_unrd_size+size); - else - m_unread = (char *) malloc(size); - curr_pos = m_unread + m_unrd_size; - - memcpy(curr_pos, buffer, size); - m_unrd_size += size; + m_states.Append(state); } -void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size) +void wxSocketBase::RestoreState() { - char *curr_pos, *new_buf; - - new_buf = (char *) malloc(m_unrd_size+size); - curr_pos = new_buf + size; - - memcpy(new_buf, buffer, size); - if (m_unrd_size != 0) { - memcpy(curr_pos, m_unread, m_unrd_size); - free(m_unread); - } - m_unread = new_buf; - m_unrd_size += size; + 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; } -size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek) +// +// Timeout and flags +// + +void wxSocketBase::SetTimeout(long seconds) { - if (!m_unrd_size) - return 0; - - if (size > m_unrd_size) - size = m_unrd_size; - memcpy(buffer, m_unread, size); - - if (!peek) { - m_unrd_size -= size; - if (m_unrd_size == 0) { - free(m_unread); - m_unread = NULL; - } - } + m_timeout = seconds; - return size; + if (m_socket) + m_socket->SetTimeout(m_timeout * 1000); } -// -------------------------------------------------------------- -// --------- wxSocketBase buffer core requester ----------------- -// -------------------------------------------------------------- - -void wxSocketBase::WantBuffer(char *buffer, size_t nbytes, - wxRequestEvent evt) +void wxSocketBase::SetFlags(wxSocketFlags flags) { - bool buf_timed_out; - - if (m_fd == INVALID_SOCKET || !m_handler || !m_connected) - return; - - SockRequest *buf = new SockRequest; - - SaveState(); - m_internal->StopWaiter(); - buf->buffer = buffer; - buf->size = nbytes; - buf->done = FALSE; - buf->type = EventToNotify(evt); - buf->io_nbytes = 0; - buf->error = 0; - buf->wait = TRUE; - buf->timeout = 1000; - buf_timed_out = FALSE; - - if (m_flags & SPEED) - m_internal->QueueRequest(buf, FALSE); - else - if (m_flags & NOWAIT) - m_internal->QueueRequest(buf, TRUE); - else - m_internal->QueueRequest(buf, TRUE); - m_lcount += buf->io_nbytes; - if (buf_timed_out) - m_error = ETIMEDOUT; - else - m_error = buf->error; - - delete buf; - RestoreState(); + // 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; } -// -------------------------------------------------------------- -// wxSocketServer -// -------------------------------------------------------------- -wxSocketServer::wxSocketServer(wxSockAddress& addr_man, - wxSockFlags flags) : - wxSocketBase(flags, SOCK_SERVER) +// -------------------------------------------------------------------------- +// Event handling +// -------------------------------------------------------------------------- + +// A note on how events are processed, which is probably the most +// difficult thing to get working right while keeping the same API +// and functionality for all platforms. +// +// When GSocket detects an event, it calls wx_socket_callback, which in +// turn just calls wxSocketBase::OnRequest in the corresponding wxSocket +// object. OnRequest does some housekeeping, and if the event is to be +// propagated to the user, it creates a new wxSocketEvent object and +// posts it. The event is not processed immediately, but delayed with +// AddPendingEvent instead. This is necessary in order to decouple the +// event processing from wx_socket_callback; otherwise, subsequent IO +// calls made from the user event handler would fail, as gtk callbacks +// are not reentrant. +// +// Note that, unlike events, user callbacks (now deprecated) are _not_ +// decoupled from wx_socket_callback and thus they suffer from a variety +// of problems. Avoid them where possible and use events instead. + +extern "C" +void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), + GSocketEvent notification, + char *cdata) { - m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0); + wxSocketBase *sckobj = (wxSocketBase *)cdata; - if (m_fd == INVALID_SOCKET) - return; + sckobj->OnRequest((wxSocketNotify) notification); +} - int flag = 1; - setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (char*)&flag, sizeof(int)); +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_socket->Select(GSOCK_INPUT_FLAG)) + return; + break; + + case wxSOCKET_OUTPUT: + if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG)) + return; + break; + + case wxSOCKET_LOST: + m_connected = false; + m_establishing = false; + break; + } - struct sockaddr *myaddr; - size_t len; + // Schedule the event - addr_man.Build(myaddr, len); - if (bind(m_fd, myaddr, addr_man.SockAddrLen()) < 0) - return; + wxSocketEventFlags flag = 0; + wxUnusedVar(flag); + switch (notification) + { + case GSOCK_INPUT: flag = GSOCK_INPUT_FLAG; break; + case GSOCK_OUTPUT: flag = GSOCK_OUTPUT_FLAG; break; + case GSOCK_CONNECTION: flag = GSOCK_CONNECTION_FLAG; break; + case GSOCK_LOST: flag = GSOCK_LOST_FLAG; break; + default: + wxLogWarning(_("wxSocket: unknown event!.")); + return; + } - if (listen(m_fd, 5) < 0) { - m_fd = INVALID_SOCKET; - return; - } + 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); + } + } +} - Notify(TRUE); +void wxSocketBase::Notify(bool notify) +{ + m_notify = notify; + if (m_socket) + m_socket->Notify(notify); } -// -------------------------------------------------------------- -// wxSocketServer Accept -// -------------------------------------------------------------- +void wxSocketBase::SetNotify(wxSocketEventFlags flags) +{ + m_eventmask = flags; +} -bool wxSocketServer::AcceptWith(wxSocketBase& sock) +void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id) { - int fd2; + m_handler = &handler; + m_id = id; +} - m_internal->AcquireFD(); - if ((fd2 = accept(m_fd, 0, 0)) < 0) { - m_internal->ReleaseFD(); - return FALSE; - } - m_internal->ReleaseFD(); +// -------------------------------------------------------------------------- +// Pushback buffer +// -------------------------------------------------------------------------- - struct linger linger; - linger.l_onoff = 0; - linger.l_linger = 1; +void wxSocketBase::Pushback(const void *buffer, wxUint32 size) +{ + if (!size) return; - setsockopt(fd2, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger)); + if (m_unread == NULL) + m_unread = malloc(size); + else + { + void *tmp; - int flag = 0; - setsockopt(fd2, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int)); + tmp = malloc(m_unrd_size + size); + memcpy((char *)tmp + size, m_unread, m_unrd_size); + free(m_unread); - sock.m_type = SOCK_INTERNAL; - sock.m_fd = fd2; - sock.m_connected = TRUE; + m_unread = tmp; + } - sock.m_internal->ResumeWaiter(); + m_unrd_size += size; - return TRUE; + memcpy(m_unread, buffer, size); } -wxSocketBase *wxSocketServer::Accept() +wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek) { - wxSocketBase* sock = new wxSocketBase(); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - sock->SetFlags((wxSockFlags)m_flags); + if (!m_unrd_size) + return 0; - if (!AcceptWith(*sock)) - return NULL; + if (size > (m_unrd_size-m_unrd_cur)) + size = m_unrd_size-m_unrd_cur; - if (m_handler) - m_handler->Register(sock); + memcpy(buffer, (char *)m_unread + m_unrd_cur, size); - return sock; + 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; } -// -------------------------------------------------------------- -// wxSocketClient -// -------------------------------------------------------------- -// --------- wxSocketClient CONSTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) : - wxSocketBase(_flags, SOCK_CLIENT) -{ -} +// ========================================================================== +// wxSocketServer +// ========================================================================== -// -------------------------------------------------------------- -// --------- wxSocketClient DESTRUCTOR -------------------------- -// -------------------------------------------------------------- -wxSocketClient::~wxSocketClient() -{ -} +// -------------------------------------------------------------------------- +// Ctor +// -------------------------------------------------------------------------- -// -------------------------------------------------------------- -// --------- wxSocketClient Connect functions ------------------- -// -------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) ) +wxSocketServer::wxSocketServer(const wxSockAddress& addr_man, + wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_SERVER) { - struct linger linger; + wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") ); - if (IsConnected()) - Close(); + m_socket = GSocket_new(); - // Initializes all socket stuff ... - // -------------------------------- - m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0); + if (!m_socket) + { + wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") ); + return; + } - if (m_fd < 0) - return FALSE; + // Setup the socket as server + m_socket->Notify(m_notify); + m_socket->SetLocal(addr_man.GetAddress()); - m_connected = FALSE; + if (GetFlags() & wxSOCKET_REUSEADDR) { + m_socket->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) { + m_socket->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) { + m_socket->DontDoBind(); + } - linger.l_onoff = 1; - linger.l_linger = 5; - setsockopt(m_fd, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger)); + if (m_socket->SetServer() != GSOCK_NOERROR) + { + delete m_socket; + m_socket = NULL; - // Stay in touch with the state of things... + wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") ); + return; + } - unsigned long flag = 1; - setsockopt(m_fd, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int)); + m_socket->SetTimeout(m_timeout * 1000); + m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, + wx_socket_callback, (char *)this); - // Disable the nagle algorithm, which delays sends till the - // buffer is full (or a certain time period has passed?)... + wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_socket->m_fd ); +} -#if defined(__WINDOWS__) || (defined(IPPROTO_TCP) && defined(TCP_NODELAY)) - flag = 1; - setsockopt(m_fd, IPPROTO_TCP, TCP_NODELAY, (char*)&flag, sizeof(int)); -#endif +// -------------------------------------------------------------------------- +// Accept +// -------------------------------------------------------------------------- - struct sockaddr *remote; - size_t len; +bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) +{ + if (!m_socket) + return false; + + // If wait == false, then the call should be nonblocking. + // When we are finished, we put the socket to blocking mode + // again. + wxSocketUnblocker unblock(m_socket, !wait); + GSocket * const child_socket = m_socket->WaitConnection(); - addr_man.Build(remote, len); + if (!child_socket) + return false; - if (connect(m_fd, remote, len) != 0) - return FALSE; + sock.m_type = wxSOCKET_BASE; + sock.m_socket = child_socket; + sock.m_connected = true; - // Enables bg events. - // ------------------ - Notify(TRUE); + sock.m_socket->SetTimeout(sock.m_timeout * 1000); + sock.m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, + wx_socket_callback, (char *)&sock); - m_connected = TRUE; - return TRUE; + return true; } -bool wxSocketClient::WaitOnConnect(long seconds, long microseconds) +wxSocketBase *wxSocketServer::Accept(bool wait) { - int ret = _Wait(seconds, microseconds, REQ_CONNECT | REQ_LOST); + wxSocketBase* sock = new wxSocketBase(); - if (ret) - m_connected = TRUE; + sock->SetFlags(m_flags); - return m_connected; -} - -void wxSocketClient::OnRequest(wxRequestEvent evt) -{ - if (evt == EVT_CONNECT) - { - if (m_connected) + if (!AcceptWith(*sock, wait)) { - m_neededreq &= ~REQ_CONNECT; - return; + sock->Destroy(); + sock = NULL; } - m_connected = TRUE; - return; - } - wxSocketBase::OnRequest(evt); -} - -///////////////////////////////////////////////////////////////// -// wxSocketHandler /////////////////////////////////////////////// -///////////////////////////////////////////////////////////////// -wxSocketHandler *wxSocketHandler::master = NULL; -#if defined(__WINDOWS__) -static int win_initialized = 0; -#endif + return sock; +} -// -------------------------------------------------------------- -// --------- wxSocketHandler CONSTRUCTOR ------------------------ -// -------------------------------------------------------------- -wxSocketHandler::wxSocketHandler() +bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) { -#if defined(__WINDOWS__) - if (!win_initialized) - { - WSADATA wsaData; - - WSAStartup((1 << 8) | 1, &wsaData); - win_initialized = 1; - } -#endif - - socks = new wxList; - -#ifndef __WINDOWS__ - signal(SIGPIPE, SIG_IGN); -#endif + return DoWait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); } -// -------------------------------------------------------------- -// --------- wxSocketHandler DESTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketHandler::~wxSocketHandler() +bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen) { - wxNode *next_node, *node = socks->First(); + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); - while (node) - { - wxSocketBase* sock = (wxSocketBase*)node->Data(); - - delete sock; - next_node = node->Next(); - delete node; - node = next_node; - } + if (m_socket->GetSockOpt(level, optname, optval, optlen) + != GSOCK_NOERROR) + { + return false; + } + return true; +} - delete socks; +bool wxSocketBase::SetOption(int level, int optname, const void *optval, + int optlen) +{ + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); -#ifdef __WINDOWS__ - WSACleanup(); - win_initialized = 0; -#endif + if (m_socket->SetSockOpt(level, optname, optval, optlen) + != GSOCK_NOERROR) + { + return false; + } + return true; } -// -------------------------------------------------------------- -// --------- wxSocketHandler registering functions -------------- -// -------------------------------------------------------------- - -void wxSocketHandler::Register(wxSocketBase* sock) +bool wxSocketBase::SetLocal(const wxIPV4address& local) { - wxNode *node; + GAddress* la = local.GetAddress(); - for (node = socks->First(); node != NULL; node = node->Next()) - { - wxSocketBase* s = (wxSocketBase*)node->Data(); + // If the address is valid, save it for use when we call Connect + if (la && la->m_addr) + { + m_localAddress = local; - if (s == sock) - return; - } + return true; + } - if (sock) - { - socks->Append(sock); - sock->SetHandler(this); - } + return false; } -void wxSocketHandler::UnRegister(wxSocketBase* sock) -{ - wxNode *node; +// ========================================================================== +// wxSocketClient +// ========================================================================== - for (node = socks->First(); node; node = node->Next()) - { - wxSocketBase* s = (wxSocketBase*)node->Data(); +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- - if (s == sock) - { - delete node; - sock->SetHandler(NULL); - return; - } - } +wxSocketClient::wxSocketClient(wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_CLIENT) +{ + m_initialRecvBufferSize = + m_initialSendBufferSize = -1; } -unsigned long wxSocketHandler::Count() const +wxSocketClient::~wxSocketClient() { - return socks->Number(); } -// -------------------------------------------------------------- -// --------- wxSocketHandler "big" wait functions --------------- -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Connect +// -------------------------------------------------------------------------- -int wxSocketHandler::Wait(long seconds, long microseconds) +bool wxSocketClient::DoConnect(const wxSockAddress& addr_man, + const wxSockAddress* local, + bool wait) { - // TODO Needs the completely asynchronous notifier. + if (m_socket) + { + // Shutdown and destroy the socket + Close(); + delete m_socket; + } + + m_socket = GSocket_new(); + m_connected = false; + m_establishing = false; + + if (!m_socket) + return false; + + m_socket->SetTimeout(m_timeout * 1000); + m_socket->SetCallback( + GSOCK_INPUT_FLAG | + GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | + GSOCK_CONNECTION_FLAG, + wx_socket_callback, + (char *)this + ); + + // If wait == false, then the call should be nonblocking. When we are + // finished, we put the socket to blocking mode again. + wxSocketUnblocker unblock(m_socket, !wait); + + // Reuse makes sense for clients too, if we are trying to rebind to the same port + if (GetFlags() & wxSOCKET_REUSEADDR) + { + m_socket->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) + { + m_socket->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) + { + m_socket->DontDoBind(); + } - /* - int i; - int on_wait; - wxNode *node; - 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->SaveState(); + // Bind to the local IP address and port, when provided + if (local) + { + GAddress* la = local->GetAddress(); - sock->SetupCallbacks(); + if (la && la->m_addr) + m_socket->SetLocal(la); + } - sock->Callback(handler_cbk); - sock->CallbackData((char *)&on_wait); - } - on_wait = 0; - if (seconds != -1) - s_wake.Start((seconds*1000) + (microseconds/1000), TRUE); +#if defined(__WXMSW__) || defined(__WXGTK__) + m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); +#endif - while (!on_wait) - PROCESS_EVENTS(); + m_socket->SetPeer(addr_man.GetAddress()); + const GSocketError err = m_socket->Connect(GSOCK_STREAMED); - for (node = socks->First(), i=0; node; node = node->Next(), i++) - { - wxSocketBase *sock = (wxSocketBase *)node->Data(); + //this will register for callbacks - must be called after m_socket->m_fd was initialized + m_socket->Notify(m_notify); - sock->RestoreState(); - } + if (err != GSOCK_NOERROR) + { + if (err == GSOCK_WOULDBLOCK) + m_establishing = true; - if (on_wait == -2) - return 0; + return false; + } - return on_wait; - */ - return 0; + m_connected = true; + return true; } -void wxSocketHandler::YieldSock() +bool wxSocketClient::Connect(const wxSockAddress& addr_man, bool wait) { - wxNode *node; - - // Nothing to do anymore here except waiting for the queue emptying. - for (node = socks->First(); node; node=node->Next()) { - wxSocketBase *sock = (wxSocketBase *)node->Data(); + return DoConnect(addr_man, NULL, wait); +} - sock->m_internal->WaitForEnd(NULL); - } +bool wxSocketClient::Connect(const wxSockAddress& addr_man, + const wxSockAddress& local, + bool wait) +{ + return DoConnect(addr_man, &local, wait); } -// -------------------------------------------------------------- -// --------- wxSocketHandler: create and register the socket ---- -// -------------------------------------------------------------- -wxSocketServer *wxSocketHandler::CreateServer(wxSockAddress& addr, - wxSocketBase::wxSockFlags flags) +bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) { - wxSocketServer *serv = new wxSocketServer(addr, flags); + if ( m_connected ) + { + // this happens if the initial attempt to connect succeeded without + // blocking + return true; + } + + wxCHECK_MSG( m_establishing && m_socket, false, + "No connection establishment attempt in progress" ); - Register(serv); - return serv; + // we must specify GSOCK_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, + GSOCK_CONNECTION_FLAG | GSOCK_LOST_FLAG); } -wxSocketClient *wxSocketHandler::CreateClient(wxSocketBase::wxSockFlags flags) +// ========================================================================== +// wxDatagramSocket +// ========================================================================== + +/* NOTE: experimental stuff - might change */ + +wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr, + wxSocketFlags flags ) + : wxSocketBase( flags, wxSOCKET_DATAGRAM ) { - wxSocketClient *client = new wxSocketClient(flags); + // Create the socket + m_socket = GSocket_new(); + + if (!m_socket) + { + wxFAIL_MSG( _T("datagram socket not new'd") ); + return; + } + m_socket->Notify(m_notify); + // Setup the socket as non connection oriented + m_socket->SetLocal(addr.GetAddress()); + if (flags & wxSOCKET_REUSEADDR) + { + m_socket->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) + { + m_socket->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) + { + m_socket->DontDoBind(); + } + if ( m_socket->SetNonOriented() != GSOCK_NOERROR ) + { + delete m_socket; + m_socket = NULL; + return; + } - Register(client); - return client; + // Initialize all stuff + m_connected = false; + m_establishing = false; + m_socket->SetTimeout( m_timeout ); + m_socket->SetCallback( GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, + wx_socket_callback, (char*)this ); } -bool wxSocketModule::OnInit() +wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, + void* buf, + wxUint32 nBytes ) { - wxSocketHandler::master = new wxSocketHandler(); - return TRUE; + Read(buf, nBytes); + GetPeer(addr); + return (*this); } -void wxSocketModule::OnExit() +wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr, + const void* buf, + wxUint32 nBytes ) { - delete wxSocketHandler::master; - wxSocketHandler::master = NULL; + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); + + m_socket->SetPeer(addr.GetAddress()); + Write(buf, nBytes); + return (*this); } -#endif - // __WXSTUBS__ +// ========================================================================== +// wxSocketModule +// ========================================================================== -#endif - // wxUSE_SOCKETS +class wxSocketModule : public wxModule +{ +public: + virtual bool OnInit() + { + // wxSocketBase will call GSocket_Init() itself when/if needed + return true; + } + + virtual void OnExit() + { + if ( wxSocketBase::IsInitialized() ) + wxSocketBase::Shutdown(); + } + +private: + DECLARE_DYNAMIC_CLASS(wxSocketModule) +}; + +IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) + +#endif // wxUSE_SOCKETS