X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ef57d8662f4a9838adad363d6d3cdf512a7e924f..0c14b6c3241d48d9cc36a2fd0aeab0ba330d96de:/src/common/socket.cpp?ds=inline diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 98ce67a4b9..88ad1f1548 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,57 +1,62 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: socket.cpp +// Name: src/common/socket.cpp // Purpose: Socket handler classes // Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia // Created: April 1997 // Copyright: (C) 1999-1997, Guilhem Lavaux // (C) 2000-1999, Guillermo Rodriguez Garcia // RCS_ID: $Id$ -// License: see wxWindows license +// License: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "socket.h" -#endif +// ========================================================================== +// Declarations +// ========================================================================== // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif #if wxUSE_SOCKETS -// ========================================================================== -// Headers and constants -// ========================================================================== +#include "wx/socket.h" -#include "wx/app.h" -#include "wx/defs.h" -#include "wx/object.h" -#include "wx/string.h" -#include "wx/timer.h" -#include "wx/utils.h" -#include "wx/module.h" -#include "wx/log.h" -#include "wx/intl.h" -#include "wx/gdicmn.h" // for wxPendingDelete +#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 +#include "wx/apptrait.h" #include "wx/sckaddr.h" -#include "wx/socket.h" +#include "wx/stopwatch.h" +#include "wx/thread.h" +#include "wx/evtloop.h" +// DLL options compatibility check: +#include "wx/build.h" +WX_CHECK_BUILD_OPTIONS("wxNet") + +// -------------------------------------------------------------------------- +// macros and constants +// -------------------------------------------------------------------------- // discard buffer #define MAX_DISCARD_SIZE (10 * 1024) -// what to do within waits -#define PROCESS_EVENTS() wxYield() - -// use wxPostEvent or not -#define USE_DELAYED_EVENTS 1 +#define wxTRACE_Socket _T("wxSocket") // -------------------------------------------------------------------------- -// ClassInfos +// wxWin macros // -------------------------------------------------------------------------- IMPLEMENT_CLASS(wxSocketBase, wxObject) @@ -60,86 +65,242 @@ IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase) IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) +// -------------------------------------------------------------------------- +// private classes +// -------------------------------------------------------------------------- + class wxSocketState : public wxObject { public: - bool m_notify_state; - wxSocketEventFlags m_neededreq; - wxSockFlags m_flags; - wxSocketBase::wxSockCbk m_cbk; - char *m_cdata; + wxSocketFlags m_flags; + wxSocketEventFlags m_eventmask; + bool m_notify; + void *m_clientData; public: - wxSocketState() : wxObject() {} + wxSocketState() : wxObject() {} + + DECLARE_NO_COPY_CLASS(wxSocketState) }; +// 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); + } + + ~wxSocketUnblocker() + { + if ( m_unblock ) + m_socket->SetNonBlocking(false); + } + +private: + GSocket * const m_socket; + bool m_unblock; + + DECLARE_NO_COPY_CLASS(wxSocketUnblocker) +}; + +// ============================================================================ +// GSocketManager +// ============================================================================ + +GSocketManager *GSocketManager::ms_manager = NULL; + +/* static */ +void GSocketManager::Set(GSocketManager *manager) +{ + wxASSERT_MSG( !ms_manager, "too late to set manager now" ); + + ms_manager = manager; +} + +/* 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(); +} // ========================================================================== // wxSocketBase // ========================================================================== +// -------------------------------------------------------------------------- +// Initialization and shutdown +// -------------------------------------------------------------------------- + +// FIXME-MT: all this is MT-unsafe, of course, we should protect all accesses +// to m_countInit with a crit section +size_t wxSocketBase::m_countInit = 0; + +bool wxSocketBase::IsInitialized() +{ + return m_countInit > 0; +} + +bool wxSocketBase::Initialize() +{ + if ( !m_countInit++ ) + { + if ( !GSocket_Init() ) + { + m_countInit--; + + return false; + } + } + + return true; +} + +void wxSocketBase::Shutdown() +{ + // we should be initialized + wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") ); + if ( --m_countInit == 0 ) + { + GSocket_Cleanup(); + } +} + // -------------------------------------------------------------------------- // Ctor and dtor // -------------------------------------------------------------------------- -wxSocketBase::wxSocketBase(wxSockFlags _flags, wxSockType _type) : - wxEvtHandler(), - m_socket(NULL), m_evt_handler(NULL), m_id(-1), - m_flags(_flags), m_type(_type), - m_neededreq(0), m_notify_state(FALSE), - m_connected(FALSE), m_establishing(FALSE), - m_reading(FALSE), m_writing(FALSE), - m_error(FALSE), m_lcount(0), m_timeout(600), m_states(), - m_unread(NULL), m_unrd_size(0), m_unrd_cur(0), - m_cbk(NULL), m_cdata(NULL) +void wxSocketBase::Init() { + 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() : - wxEvtHandler(), - m_socket(NULL), m_evt_handler(NULL), m_id(-1), - m_flags(NONE), m_type(SOCK_UNINIT), - m_neededreq(0), m_notify_state(FALSE), - m_connected(FALSE), m_establishing(FALSE), - m_reading(FALSE), m_writing(FALSE), - m_error(FALSE), m_lcount(0), m_timeout(600), m_states(), - m_unread(NULL), m_unrd_size(0), m_unrd_cur(0), - m_cbk(NULL), m_cdata(NULL) +wxSocketBase::wxSocketBase() { + Init(); } -wxSocketBase::~wxSocketBase() +wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type) { - if (m_unread) - free(m_unread); + Init(); - // Shutdown and close the socket - Close(); + SetFlags(flags); - // Destroy the GSocket object - if (m_socket) - GSocket_destroy(m_socket); + m_type = type; +} + +wxSocketBase::~wxSocketBase() +{ + // Just in case the app called Destroy() *and* then deleted the socket + // immediately: don't leave dangling pointers. + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) + traits->RemoveFromPendingDelete(this); + + // 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); } -/* bool wxSocketBase::Destroy() { - // Delayed destruction: the socket will be deleted during the next - // idle loop iteration. This ensures that all pending events have - // been processed. + // 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; - m_beingDeleted = TRUE; - Close(); + // Shutdown and close the socket + Close(); - if ( !wxPendingDelete.Member(this) ) - wxPendingDelete.Append(this); + // Supress events from now on + Notify(false); - return TRUE; + // 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 true; } -*/ // -------------------------------------------------------------------------- -// Basic IO operations +// Basic IO calls // -------------------------------------------------------------------------- // The following IO operations update m_error and m_lcount: @@ -149,393 +310,410 @@ bool wxSocketBase::Destroy() bool wxSocketBase::Close() { - // Interrupt pending waits - InterruptAllWaits(); - - if (m_socket) - { - // Disable callbacks - GSocket_UnsetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG); - - // Shutdown the connection - GSocket_Shutdown(m_socket); - } - - m_connected = FALSE; - m_establishing = FALSE; - return TRUE; + // Interrupt pending waits + InterruptWait(); + + 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(); + } + + m_connected = false; + m_establishing = false; + return true; } -wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { - // Mask read events - m_reading = TRUE; + // Mask read events + m_reading = true; - m_lcount = _Read(buffer, nbytes); + m_lcount = DoRead(buffer, nbytes); - // If in wxSOCKET_WAITALL mode, all bytes should have been read. - if (m_flags & wxSOCKET_WAITALL) - m_error = (m_lcount != nbytes); - else - m_error = (m_lcount == 0); + // If 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; + // Allow read events from now on + m_reading = false; - return *this; + return *this; } -wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes) +wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) { - int total; - int ret = 1; + // We use pointer arithmetic here which doesn't work with void pointers. + char *buffer = static_cast(buffer_); - // Try the pushback buffer first - total = GetPushback(buffer, nbytes, FALSE); - nbytes -= total; - buffer += total; + // Try the push back buffer first, even before checking whether the socket + // is valid to allow reading previously pushed back data from an already + // closed socket. + wxUint32 total = GetPushback(buffer, nbytes, false); + nbytes -= total; + buffer += total; - // If the socket is invalid or we got all the data, return now - if (!m_socket || !nbytes) - return total; + // If it's indeed closed or if read everything, there is nothing more to do. + if ( !m_socket || !nbytes ) + return total; - // Possible combinations (they are checked in this order) - // wxSOCKET_NOWAIT - // wxSOCKET_WAITALL | wxSOCKET_BLOCK - // wxSOCKET_WAITALL - // wxSOCKET_BLOCK - // wxSOCKET_NONE - // - if (m_flags & wxSOCKET_NOWAIT) - { - GSocket_SetNonBlocking(m_socket, TRUE); - ret = GSocket_Read(m_socket, buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); - - if (ret > 0) - total += ret; - } - else if (m_flags & wxSOCKET_WAITALL) - { - while (ret > 0 && nbytes > 0) - { - if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead()) - break; + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - ret = GSocket_Read(m_socket, buffer, nbytes); - if (ret > 0) - { - total += ret; - buffer += ret; - nbytes -= ret; - } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForRead()) + // 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 ) { - ret = GSocket_Read(m_socket, buffer, nbytes); + wxSocketUnblocker unblock(m_socket); + int ret = m_socket->Read(buffer, nbytes); + if ( ret < 0 ) + return 0; - if (ret > 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; + return total; } -wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) { - wxUint32 len, len2, sig, total; - bool error; - int old_flags; - struct - { - unsigned char sig[4]; - unsigned char len[4]; - } msg; - - // Mask read events - m_reading = TRUE; - - total = 0; - error = TRUE; - old_flags = m_flags; - SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); - - if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg)) - goto exit; - - sig = (wxUint32)msg.sig[0]; - sig |= (wxUint32)(msg.sig[1] << 8); - sig |= (wxUint32)(msg.sig[2] << 16); - sig |= (wxUint32)(msg.sig[3] << 24); - - if (sig != 0xfeeddead) - { - wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); - goto exit; - } - - len = (wxUint32)msg.len[0]; - len |= (wxUint32)(msg.len[1] << 8); - len |= (wxUint32)(msg.len[2] << 16); - len |= (wxUint32)(msg.len[3] << 24); - - if (len > nbytes) - { - len2 = len - nbytes; - len = nbytes; - } - else - len2 = 0; - - // Don't attemp to read if the msg was zero bytes long. - if (len) - { - total = _Read(buffer, len); - - if (total != len) - goto exit; - } - if (len2) - { - char *discard_buffer = new char[MAX_DISCARD_SIZE]; - long discard_len; - - // NOTE: discarded bytes don't add to m_lcount. - do + wxUint32 len, len2, sig, total; + bool error; + int old_flags; + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; + + // Mask read events + m_reading = true; + + total = 0; + error = true; + old_flags = m_flags; + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); + + if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) + goto exit; + + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); + + if (sig != 0xfeeddead) + { + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); + goto exit; + } + + len = (wxUint32)msg.len[0]; + len |= (wxUint32)(msg.len[1] << 8); + len |= (wxUint32)(msg.len[2] << 16); + len |= (wxUint32)(msg.len[3] << 24); + + if (len > nbytes) { - discard_len = ((len2 > MAX_DISCARD_SIZE)? MAX_DISCARD_SIZE : len2); - discard_len = _Read(discard_buffer, (wxUint32)discard_len); - len2 -= (wxUint32)discard_len; + len2 = len - nbytes; + len = nbytes; } - while ((discard_len > 0) && len2); + else + len2 = 0; + + // Don't attempt to read if the msg was zero bytes long. + if (len) + { + total = DoRead(buffer, len); - delete [] discard_buffer; + if (total != len) + goto exit; + } - if (len2 != 0) - goto exit; - } - if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg)) - goto exit; + 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; - sig = (wxUint32)msg.sig[0]; - sig |= (wxUint32)(msg.sig[1] << 8); - sig |= (wxUint32)(msg.sig[2] << 16); - sig |= (wxUint32)(msg.sig[3] << 24); + 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) - { - wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); - goto exit; - } + if (sig != 0xdeadfeed) + { + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); + goto exit; + } - // everything was OK - error = FALSE; + // everything was OK + error = false; exit: - m_error = error; - m_lcount = total; - m_reading = FALSE; - SetFlags(old_flags); + m_error = error; + m_lcount = total; + m_reading = false; + SetFlags(old_flags); - return *this; + return *this; } -wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) { - // Mask read events - m_reading = TRUE; + // Mask read events + m_reading = true; - m_lcount = _Read(buffer, nbytes); - Pushback(buffer, m_lcount); + m_lcount = DoRead(buffer, nbytes); + Pushback(buffer, m_lcount); - // If in wxSOCKET_WAITALL mode, all bytes should have been read. - if (m_flags & wxSOCKET_WAITALL) - m_error = (m_lcount != nbytes); - else - m_error = (m_lcount == 0); + // If in wxSOCKET_WAITALL mode, all bytes should have been read. + if (m_flags & wxSOCKET_WAITALL) + m_error = (m_lcount != nbytes); + else + m_error = (m_lcount == 0); - // Allow read events again - m_reading = FALSE; + // Allow read events again + m_reading = false; - return *this; + return *this; } -wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { - // Mask write events - m_writing = TRUE; + // Mask write events + m_writing = true; - m_lcount = _Write(buffer, nbytes); + m_lcount = DoWrite(buffer, nbytes); - // If in wxSOCKET_WAITALL mode, all bytes should have been written. - if (m_flags & wxSOCKET_WAITALL) - m_error = (m_lcount != nbytes); - else - m_error = (m_lcount == 0); + // If in wxSOCKET_WAITALL mode, all bytes should have been written. + if (m_flags & wxSOCKET_WAITALL) + m_error = (m_lcount != nbytes); + else + m_error = (m_lcount == 0); - // Allow write events again - m_writing = FALSE; + // Allow write events again + m_writing = false; - return *this; + return *this; } -wxUint32 wxSocketBase::_Write(const char *buffer, wxUint32 nbytes) +// 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) { - wxUint32 total = 0; - int ret = 1; - - // If the socket is invalid, return immediately - if (!m_socket) - return 0; - - // Possible combinations (they are checked in this order) - // wxSOCKET_NOWAIT - // wxSOCKET_WAITALL | wxSOCKET_BLOCK - // wxSOCKET_WAITALL - // wxSOCKET_BLOCK - // wxSOCKET_NONE - // - if (m_flags & wxSOCKET_NOWAIT) - { - GSocket_SetNonBlocking(m_socket, TRUE); - ret = GSocket_Write(m_socket, buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); - - if (ret > 0) - total = ret; - } - else if (m_flags & wxSOCKET_WAITALL) - { - while (ret > 0 && nbytes > 0) - { - if (!(m_flags & wxSOCKET_BLOCK) && !WaitForWrite()) - break; + const char *buffer = static_cast(buffer_); + + // Return if there is nothing to read or the socket is (already?) closed. + if ( !m_socket || !nbytes ) + return 0; - ret = GSocket_Write(m_socket, buffer, nbytes); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - if (ret > 0) - { - total += ret; - buffer += ret; - nbytes -= ret; - } + 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 - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite()) + else // blocking socket { - ret = GSocket_Write(m_socket, buffer, nbytes); - - if (ret > 0) - total = ret; + 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; + } } - } - return total; + return total; } -wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) { - wxUint32 total; - bool error; - int old_flags; - struct { - unsigned char sig[4]; - unsigned char len[4]; - } msg; + wxUint32 total; + bool error; + struct + { + unsigned char sig[4]; + unsigned char len[4]; + } msg; - // Mask write events - m_writing = TRUE; + // Mask write events + m_writing = true; - error = TRUE; - total = 0; - old_flags = m_flags; - SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); + 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.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); + 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 (_Write((char *)&msg, sizeof(msg)) < sizeof(msg)) - goto exit; + if (DoWrite(&msg, sizeof(msg)) < sizeof(msg)) + goto exit; - total = _Write(buffer, nbytes); + total = DoWrite(buffer, nbytes); - if (total < nbytes) - goto exit; + 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; + 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 ((_Write((char *)&msg, sizeof(msg))) < sizeof(msg)) - goto exit; + if ((DoWrite(&msg, sizeof(msg))) < sizeof(msg)) + goto exit; - // everything was OK - error = FALSE; + // everything was OK + error = false; exit: - m_error = error; - m_lcount = total; - m_writing = FALSE; + m_error = error; + m_lcount = total; + m_writing = false; - return *this; + return *this; } -wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) { - if (nbytes != 0) - Pushback(buffer, nbytes); + if (nbytes != 0) + Pushback(buffer, nbytes); - m_error = FALSE; - m_lcount = nbytes; + m_error = false; + m_lcount = nbytes; - return *this; + return *this; } wxSocketBase& wxSocketBase::Discard() { - int old_flags; - char *buffer = new char[MAX_DISCARD_SIZE]; - wxUint32 ret; - wxUint32 total = 0; + char *buffer = new char[MAX_DISCARD_SIZE]; + wxUint32 ret; + wxUint32 total = 0; - // Mask read events - m_reading = TRUE; + // Mask read events + m_reading = true; - old_flags = m_flags; - SetFlags(wxSOCKET_NOWAIT); + SetFlags(wxSOCKET_NOWAIT); - do - { - ret = _Read(buffer, MAX_DISCARD_SIZE); - total += ret; - } - while (ret == MAX_DISCARD_SIZE); + do + { + ret = DoRead(buffer, MAX_DISCARD_SIZE); + total += ret; + } + while (ret == MAX_DISCARD_SIZE); - delete[] buffer; - m_lcount = total; - m_error = FALSE; + delete[] buffer; + m_lcount = total; + m_error = false; - // Allow read events again - m_reading = FALSE; + // Allow read events again + m_reading = false; - return *this; + return *this; } // -------------------------------------------------------------------------- @@ -545,133 +723,143 @@ wxSocketBase& wxSocketBase::Discard() // 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 calls PROCESS_EVENTS(), so +// timeout elapses. The polling loop runs the event loop so that // this won't block the GUI. -class _wxSocketInternalTimer: public wxTimer +bool +wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) { -public: - int *m_state; - unsigned long m_new_val; + wxCHECK_MSG( m_socket, false, "can't wait on invalid socket" ); - void Notify() - { - *m_state = (int)m_new_val; // Change the value - } -}; + // This can be set to true from Interrupt() to exit this function a.s.a.p. + m_interrupt = false; -bool wxSocketBase::_Wait(long seconds, long milliseconds, - wxSocketEventFlags flags) -{ - GSocketEventFlags result; - _wxSocketInternalTimer timer; - long timeout; - int state = -1; - - // Set this to TRUE to interrupt ongoing waits - m_interrupt = FALSE; - - // Check for valid socket - if (!m_socket) - return FALSE; - - // Check for valid timeout value - if (seconds != -1) - timeout = seconds * 1000 + milliseconds; - else - timeout = m_timeout * 1000; - - // Activate timer - if (timeout) - { - timer.m_state = &state; - timer.m_new_val = 0; - timer.Start((int)timeout, TRUE); - } - - // Active polling (without using events) - // - // NOTE: this duplicates some of the code in OnRequest (lost - // connection and connection establishment handling) but - // this doesn't hurt. It has to be here because the event - // might be a bit delayed, and it has to be in OnRequest - // as well because maybe the Wait functions are not being - // used. - // - // Do this at least once (important if timeout == 0, when - // we are just polling). Also, if just polling, do not yield. - - while (state == -1) - { - result = GSocket_Select(m_socket, flags | GSOCK_LOST_FLAG); - - // Incoming connection (server) or connection established (client) - if (result & GSOCK_CONNECTION_FLAG) + + // 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() ) { - timer.Stop(); - m_connected = TRUE; - m_establishing = FALSE; - return TRUE; - } + eventLoop = wxEventLoop::GetActive(); - // Data available or output buffer ready - if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG)) +#ifdef __WXMSW__ + wxASSERT_MSG( eventLoop, + "Sockets won't work without a running event loop" ); +#endif // __WXMSW__ + } + else // in worker thread { - timer.Stop(); - return TRUE; + // We never dispatch messages from threads other than the main one. + eventLoop = NULL; } - // Connection lost - if (result & GSOCK_LOST_FLAG) + // 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 ( ;; ) { - timer.Stop(); - m_connected = FALSE; - m_establishing = FALSE; - return (flags & GSOCK_LOST_FLAG); + // 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 } - // Wait more? - if ((timeout == 0) || (m_interrupt)) - break; - else - PROCESS_EVENTS(); - } - - timer.Stop(); - return FALSE; + return gotEvent; } bool wxSocketBase::Wait(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | - GSOCK_OUTPUT_FLAG | - GSOCK_CONNECTION_FLAG | - GSOCK_LOST_FLAG); + return DoWait(seconds, milliseconds, + GSOCK_INPUT_FLAG | + GSOCK_OUTPUT_FLAG | + GSOCK_CONNECTION_FLAG | + GSOCK_LOST_FLAG + ); } bool wxSocketBase::WaitForRead(long seconds, long milliseconds) { - // Check pushback buffer before entering _Wait - if (m_unread) - return TRUE; - - // Note that GSOCK_INPUT_LOST has to be explicitly passed to - // _Wait becuase 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 _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | - GSOCK_LOST_FLAG); + // 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, GSOCK_OUTPUT_FLAG); + return DoWait(seconds, milliseconds, GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG); } bool wxSocketBase::WaitForLost(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG); + return DoWait(seconds, milliseconds, GSOCK_LOST_FLAG); } // -------------------------------------------------------------------------- @@ -684,30 +872,36 @@ bool wxSocketBase::WaitForLost(long seconds, long milliseconds) bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const { - GAddress *peer; + GAddress *peer; - if (!m_socket) - return FALSE; + if (!m_socket) + return false; - peer = GSocket_GetPeer(m_socket); - addr_man.SetAddress(peer); - GAddress_destroy(peer); + peer = m_socket->GetPeer(); - return TRUE; + // copying a null address would just trigger an assert anyway + + if (!peer) + return false; + + addr_man.SetAddress(peer); + GAddress_destroy(peer); + + return true; } bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const { - GAddress *local; + GAddress *local; - if (!m_socket) - return FALSE; + if (!m_socket) + return false; - local = GSocket_GetLocal(m_socket); - addr_man.SetAddress(local); - GAddress_destroy(local); + local = m_socket->GetLocal(); + addr_man.SetAddress(local); + GAddress_destroy(local); - return TRUE; + return true; } // @@ -716,38 +910,36 @@ bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const void wxSocketBase::SaveState() { - wxSocketState *state; + wxSocketState *state; - state = new wxSocketState(); + state = new wxSocketState(); - state->m_notify_state = m_notify_state; - state->m_neededreq = m_neededreq; - state->m_flags = m_flags; - state->m_cbk = m_cbk; - state->m_cdata = m_cdata; + state->m_flags = m_flags; + state->m_notify = m_notify; + state->m_eventmask = m_eventmask; + state->m_clientData = m_clientData; - m_states.Append(state); + m_states.Append(state); } void wxSocketBase::RestoreState() { - wxNode *node; - wxSocketState *state; + wxList::compatibility_iterator node; + wxSocketState *state; - node = m_states.Last(); - if (!node) - return; + node = m_states.GetLast(); + if (!node) + return; - state = (wxSocketState *)node->Data(); + state = (wxSocketState *)node->GetData(); - SetFlags(state->m_flags); - m_cbk = state->m_cbk; - m_cdata = state->m_cdata; - m_neededreq = state->m_neededreq; - Notify(state->m_notify_state); + m_flags = state->m_flags; + m_notify = state->m_notify; + m_eventmask = state->m_eventmask; + m_clientData = state->m_clientData; - delete node; - delete state; + m_states.Erase(node); + delete state; } // @@ -756,197 +948,187 @@ void wxSocketBase::RestoreState() void wxSocketBase::SetTimeout(long seconds) { - m_timeout = seconds; + m_timeout = seconds; - if (m_socket) - GSocket_SetTimeout(m_socket, m_timeout * 1000); + if (m_socket) + m_socket->SetTimeout(m_timeout * 1000); } -void wxSocketBase::SetFlags(wxSockFlags _flags) +void wxSocketBase::SetFlags(wxSocketFlags flags) { - m_flags = _flags; + // Do some sanity checking on the flags used: not all values can be used + // together. + wxASSERT_MSG( !(flags & wxSOCKET_NOWAIT) || + !(flags & (wxSOCKET_WAITALL | wxSOCKET_BLOCK)), + "Using wxSOCKET_WAITALL or wxSOCKET_BLOCK with " + "wxSOCKET_NOWAIT doesn't make sense" ); + + m_flags = flags; } + // -------------------------------------------------------------------------- -// Callbacks (now obsolete - use events instead) +// Event handling // -------------------------------------------------------------------------- -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) -{ - wxSockCbk old_cbk = cbk_; - - m_cbk = cbk_; - return old_cbk; -} - -char *wxSocketBase::CallbackData(char *data) +// 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) { - char *old_data = m_cdata; + wxSocketBase *sckobj = (wxSocketBase *)cdata; - m_cdata = data; - return old_data; + sckobj->OnRequest((wxSocketNotify) notification); } -// -------------------------------------------------------------------------- -// Event system -// -------------------------------------------------------------------------- - -// All events (INPUT, OUTPUT, CONNECTION, LOST) are now always -// internally watched; but users will only be notified of those -// events they are interested in. - -static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), - GSocketEvent event, - char *cdata) +void wxSocketBase::OnRequest(wxSocketNotify notification) { - wxSocketBase *sckobj = (wxSocketBase *)cdata; + 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; + } - sckobj->OnRequest((wxSocketNotify)event); -} + // Schedule the event -wxSocketEventFlags wxSocketBase::EventToNotify(wxSocketNotify evt) -{ - switch (evt) - { - case GSOCK_INPUT: return GSOCK_INPUT_FLAG; - case GSOCK_OUTPUT: return GSOCK_OUTPUT_FLAG; - case GSOCK_CONNECTION: return GSOCK_CONNECTION_FLAG; - case GSOCK_LOST: return GSOCK_LOST_FLAG; - } - return 0; -} + 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; + } -void wxSocketBase::SetNotify(wxSocketEventFlags flags) -{ - m_neededreq = flags; + 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); + } + } } void wxSocketBase::Notify(bool notify) { - m_notify_state = notify; -} - -void wxSocketBase::OnRequest(wxSocketNotify req_evt) -{ - wxSocketEvent event(m_id); - wxSocketEventFlags flag = EventToNotify(req_evt); - - // This duplicates some code in _Wait, but this doesn't - // hurt. It has to be here because we don't know whether - // the Wait functions will be used, and it has to be in - // _Wait as well because the event might be a bit delayed. - - switch(req_evt) - { - 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 || !GSocket_Select(m_socket, GSOCK_INPUT_FLAG)) - return; - break; - - case wxSOCKET_OUTPUT: - if (m_writing || !GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG)) - return; - break; - - case wxSOCKET_LOST: - m_connected = FALSE; - m_establishing = FALSE; - break; - - default: - break; - } - - if (((m_neededreq & flag) == flag) && m_notify_state) - { - event.m_socket = this; - event.m_skevt = req_evt; - - if (m_evt_handler) -#if USE_DELAYED_EVENTS - wxPostEvent(m_evt_handler, event); -#else - ProcessEvent(event); -#endif - - OldOnNotify(req_evt); - if (m_cbk) - m_cbk(*this, req_evt, m_cdata); - } + m_notify = notify; + if (m_socket) + m_socket->Notify(notify); } -void wxSocketBase::OldOnNotify(wxSocketNotify WXUNUSED(evt)) +void wxSocketBase::SetNotify(wxSocketEventFlags flags) { + m_eventmask = flags; } -void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id) +void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id) { - m_evt_handler = &h_evt; - m_id = id; - - SetNextHandler(&h_evt); + m_handler = &handler; + m_id = id; } // -------------------------------------------------------------------------- // Pushback buffer // -------------------------------------------------------------------------- -void wxSocketBase::Pushback(const char *buffer, wxUint32 size) +void wxSocketBase::Pushback(const void *buffer, wxUint32 size) { - if (!size) return; + if (!size) return; - if (m_unread == NULL) - m_unread = (char *)malloc(size); - else - { - char *tmp; + if (m_unread == NULL) + m_unread = malloc(size); + else + { + void *tmp; - tmp = (char *)malloc(m_unrd_size + size); - memcpy(tmp+size, m_unread, m_unrd_size); - free(m_unread); + tmp = malloc(m_unrd_size + size); + memcpy((char *)tmp + size, m_unread, m_unrd_size); + free(m_unread); - m_unread = tmp; - } + m_unread = tmp; + } - m_unrd_size += size; + m_unrd_size += size; - memcpy(m_unread, buffer, size); + memcpy(m_unread, buffer, size); } -wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek) +wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek) { - if (!m_unrd_size) - return 0; + wxCHECK_MSG( buffer, 0, "NULL buffer" ); - if (size > (m_unrd_size-m_unrd_cur)) - size = m_unrd_size-m_unrd_cur; + if (!m_unrd_size) + return 0; - memcpy(buffer, (m_unread+m_unrd_cur), size); + if (size > (m_unrd_size-m_unrd_cur)) + size = m_unrd_size-m_unrd_cur; - if (!peek) - { - m_unrd_cur += size; - if (m_unrd_size == m_unrd_cur) + memcpy(buffer, (char *)m_unread + m_unrd_cur, size); + + if (!peek) { - free(m_unread); - m_unread = NULL; - m_unrd_size = 0; - m_unrd_cur = 0; + 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; + return size; } + // ========================================================================== // wxSocketServer // ========================================================================== @@ -955,30 +1137,49 @@ wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek) // Ctor // -------------------------------------------------------------------------- -wxSocketServer::wxSocketServer(wxSockAddress& addr_man, - wxSockFlags flags) - : wxSocketBase(flags, SOCK_SERVER) +wxSocketServer::wxSocketServer(const wxSockAddress& addr_man, + wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_SERVER) { - // Create the socket - m_socket = GSocket_new(); - - if (!m_socket) - return; - - // Setup the socket as server - GSocket_SetLocal(m_socket, addr_man.GetAddress()); - if (GSocket_SetServer(m_socket) != GSOCK_NOERROR) - { - GSocket_destroy(m_socket); - m_socket = NULL; - return; - } - - GSocket_SetTimeout(m_socket, m_timeout * 1000); - GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char *)this); + wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") ); + m_socket = GSocket_new(); + + if (!m_socket) + { + wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") ); + return; + } + + // Setup the socket as server + m_socket->Notify(m_notify); + m_socket->SetLocal(addr_man.GetAddress()); + + if (GetFlags() & wxSOCKET_REUSEADDR) { + m_socket->SetReusable(); + } + if (GetFlags() & wxSOCKET_BROADCAST) { + m_socket->SetBroadcast(); + } + if (GetFlags() & wxSOCKET_NOBIND) { + m_socket->DontDoBind(); + } + + if (m_socket->SetServer() != GSOCK_NOERROR) + { + delete m_socket; + m_socket = NULL; + + wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") ); + return; + } + + 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); + + wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_socket->m_fd ); } // -------------------------------------------------------------------------- @@ -987,53 +1188,88 @@ wxSocketServer::wxSocketServer(wxSockAddress& addr_man, bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { - GSocket *child_socket; + if (!m_socket) + return false; - 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(); - // If wait == FALSE, then the call should be nonblocking. - // When we are finished, we put the socket to blocking mode - // again. + if (!child_socket) + return false; - if (!wait) - GSocket_SetNonBlocking(m_socket, TRUE); + sock.m_type = wxSOCKET_BASE; + sock.m_socket = child_socket; + sock.m_connected = true; - child_socket = GSocket_WaitConnection(m_socket); + 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); - if (!wait) - GSocket_SetNonBlocking(m_socket, FALSE); + return true; +} - if (!child_socket) - return FALSE; +wxSocketBase *wxSocketServer::Accept(bool wait) +{ + wxSocketBase* sock = new wxSocketBase(); - sock.m_type = SOCK_INTERNAL; - sock.m_socket = child_socket; - sock.m_connected = TRUE; + sock->SetFlags(m_flags); - GSocket_SetTimeout(sock.m_socket, sock.m_timeout * 1000); - GSocket_SetCallback(sock.m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char *)&sock); + if (!AcceptWith(*sock, wait)) + { + sock->Destroy(); + sock = NULL; + } - return TRUE; + return sock; } -wxSocketBase *wxSocketServer::Accept(bool wait) +bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) +{ + return DoWait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); +} + +bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen) { - wxSocketBase* sock = new wxSocketBase(); + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); - sock->SetFlags((wxSockFlags)m_flags); + if (m_socket->GetSockOpt(level, optname, optval, optlen) + != GSOCK_NOERROR) + { + return false; + } + return true; +} - if (!AcceptWith(*sock, wait)) - return NULL; +bool wxSocketBase::SetOption(int level, int optname, const void *optval, + int optlen) +{ + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); - return sock; + if (m_socket->SetSockOpt(level, optname, optval, optlen) + != GSOCK_NOERROR) + { + return false; + } + return true; } -bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) +bool wxSocketBase::SetLocal(const wxIPV4address& local) { - return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); + GAddress* la = local.GetAddress(); + + // If the address is valid, save it for use when we call Connect + if (la && la->m_addr) + { + m_localAddress = local; + + return true; + } + + return false; } // ========================================================================== @@ -1044,12 +1280,13 @@ bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) // Ctor and dtor // -------------------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) - : wxSocketBase(_flags, SOCK_CLIENT) +wxSocketClient::wxSocketClient(wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_CLIENT) { + m_initialRecvBufferSize = + m_initialSendBufferSize = -1; } -// XXX: What is this for ? wxSocketClient::~wxSocketClient() { } @@ -1058,63 +1295,119 @@ wxSocketClient::~wxSocketClient() // Connect // -------------------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) +bool wxSocketClient::DoConnect(const wxSockAddress& addr_man, + const wxSockAddress* local, + bool wait) { - GSocketError err; + if (m_socket) + { + // Shutdown and destroy the socket + Close(); + delete m_socket; + } - if (m_socket) - { - // Shutdown and destroy the socket - Close(); - GSocket_destroy(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(); + } + + // 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; + } - m_socket = GSocket_new(); - m_connected = FALSE; - m_establishing = FALSE; + // Bind to the local IP address and port, when provided + if (local) + { + GAddress* la = local->GetAddress(); - if (!m_socket) - return FALSE; + if (la && la->m_addr) + m_socket->SetLocal(la); + } - GSocket_SetTimeout(m_socket, m_timeout * 1000); - GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char *)this); +#if defined(__WXMSW__) || defined(__WXGTK__) + m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); +#endif - // If wait == FALSE, then the call should be nonblocking. - // When we are finished, we put the socket to blocking mode - // again. + m_socket->SetPeer(addr_man.GetAddress()); + const GSocketError err = m_socket->Connect(GSOCK_STREAMED); - if (!wait) - GSocket_SetNonBlocking(m_socket, TRUE); + //this will register for callbacks - must be called after m_socket->m_fd was initialized + m_socket->Notify(m_notify); - GSocket_SetPeer(m_socket, addr_man.GetAddress()); - err = GSocket_Connect(m_socket, GSOCK_STREAMED); + if (err != GSOCK_NOERROR) + { + if (err == GSOCK_WOULDBLOCK) + m_establishing = true; - if (!wait) - GSocket_SetNonBlocking(m_socket, FALSE); + return false; + } - if (err != GSOCK_NOERROR) - { - if (err == GSOCK_WOULDBLOCK) - m_establishing = TRUE; + m_connected = true; + return true; +} - return FALSE; - } +bool wxSocketClient::Connect(const wxSockAddress& addr_man, bool wait) +{ + return DoConnect(addr_man, NULL, wait); +} - m_connected = TRUE; - return TRUE; +bool wxSocketClient::Connect(const wxSockAddress& addr_man, + const wxSockAddress& local, + bool wait) +{ + return DoConnect(addr_man, &local, wait); } bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) { - if (m_connected) // Already connected - return TRUE; + if ( m_connected ) + { + // this happens if the initial attempt to connect succeeded without + // blocking + return true; + } - if (!m_establishing || !m_socket) // No connection in progress - return FALSE; + wxCHECK_MSG( m_establishing && m_socket, false, + "No connection establishment attempt in progress" ); - return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); + // 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); } // ========================================================================== @@ -1123,36 +1416,51 @@ bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) /* NOTE: experimental stuff - might change */ -wxDatagramSocket::wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags ) - : wxSocketBase( flags, SOCK_DATAGRAM ) +wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr, + wxSocketFlags flags ) + : wxSocketBase( flags, wxSOCKET_DATAGRAM ) { - // Create the socket - m_socket = GSocket_new(); - - if(!m_socket) - return; - - // Setup the socket as non connection oriented - GSocket_SetLocal(m_socket, addr.GetAddress()); - if( GSocket_SetNonOriented(m_socket) != GSOCK_NOERROR ) - { - GSocket_destroy(m_socket); - m_socket = NULL; - return; - } - - // Initialize all stuff - m_connected = FALSE; - m_establishing = FALSE; - GSocket_SetTimeout( m_socket, m_timeout ); - GSocket_SetCallback( m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char*)this ); + // 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; + } + // 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 ); } wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, - char* buf, + void* buf, wxUint32 nBytes ) { Read(buf, nBytes); @@ -1160,53 +1468,40 @@ wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, return (*this); } -wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr, - const char* buf, +wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr, + const void* buf, wxUint32 nBytes ) { - GSocket_SetPeer(m_socket, addr.GetAddress()); + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); + + m_socket->SetPeer(addr.GetAddress()); Write(buf, nBytes); return (*this); } -// ========================================================================== -// wxSocketEvent -// ========================================================================== - -// XXX: Should be moved to event.cpp ? - -wxSocketEvent::wxSocketEvent(int id) - : wxEvent(id) -{ - wxEventType type = (wxEventType)wxEVT_SOCKET; - - SetEventType(type); -} - -void wxSocketEvent::CopyObject(wxObject& obj_d) const -{ - wxSocketEvent *event = (wxSocketEvent *)&obj_d; - - wxEvent::CopyObject(obj_d); - - event->m_skevt = m_skevt; - event->m_socket = m_socket; -} - // ========================================================================== // wxSocketModule // ========================================================================== -class WXDLLEXPORT wxSocketModule: public wxModule +class wxSocketModule : public wxModule { - DECLARE_DYNAMIC_CLASS(wxSocketModule) - public: - bool OnInit() { return GSocket_Init(); } - void OnExit() { GSocket_Cleanup(); } + 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 +#endif // wxUSE_SOCKETS