X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f187448d851291f80c1c9d972471949e788ddcf9..4e2a3778386d60356dab319afa2d3f987f86d6b2:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index ffa094fcb5..a53ae44d63 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,66 +1,81 @@ ///////////////////////////////////////////////////////////////////////////// -// 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/event.h" - -#if wxUSE_GUI - #include "wx/gdicmn.h" // for wxPendingDelete -#endif // wxUSE_GUI +#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 -#if wxUSE_GUI - #define PROCESS_EVENTS() wxYield() -#else - #define PROCESS_EVENTS() -#endif - -// use wxPostEvent or not -#define USE_DELAYED_EVENTS 1 +// what to do within waits: we have 2 cases: from the main thread itself we +// have to call wxYield() to let the events (including the GUI events and the +// low-level (not wxWidgets) events from GSocket) be processed. From another +// thread it is enough to just call wxThread::Yield() which will give away the +// rest of our time slice: the explanation is that the events will be processed +// by the main thread anyhow, without calling wxYield(), but we don't want to +// eat the CPU time uselessly while sitting in the loop waiting for the data +#if wxUSE_THREADS + #define PROCESS_EVENTS() \ + { \ + if ( wxThread::IsMain() ) \ + wxYield(); \ + else \ + wxThread::Yield(); \ + } +#else // !wxUSE_THREADS + #define PROCESS_EVENTS() wxYield() +#endif // wxUSE_THREADS/!wxUSE_THREADS +#define wxTRACE_Socket _T("wxSocket") // -------------------------------------------------------------------------- -// ClassInfos +// wxWin macros // -------------------------------------------------------------------------- IMPLEMENT_CLASS(wxSocketBase, wxObject) @@ -69,24 +84,110 @@ 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; wxSocketFlags m_flags; - wxSocketBase::wxSockCbk m_cbk; - char *m_cdata; + wxSocketEventFlags m_eventmask; + bool m_notify; + void *m_clientData; public: wxSocketState() : wxObject() {} + + DECLARE_NO_COPY_CLASS(wxSocketState) }; +// ============================================================================ +// 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 // -------------------------------------------------------------------------- @@ -102,10 +203,10 @@ void wxSocketBase::Init() m_establishing = m_reading = m_writing = - m_error = FALSE; + m_error = false; m_lcount = 0; m_timeout = 600; - m_beingDeleted = FALSE; + m_beingDeleted = false; // pushback buffer m_unread = NULL; @@ -113,13 +214,18 @@ void wxSocketBase::Init() m_unrd_cur = 0; // events - m_id = -1; + m_id = wxID_ANY; m_handler = NULL; m_clientData = NULL; - m_notify_state = FALSE; - m_neededreq = 0; - m_cbk = NULL; - m_cdata = 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() @@ -139,9 +245,9 @@ wxSocketBase::~wxSocketBase() { // Just in case the app called Destroy() *and* then deleted // the socket immediately: don't leave dangling pointers. -#if wxUSE_GUI - wxPendingDelete.DeleteObject(this); -#endif + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) + traits->RemoveFromPendingDelete(this); // Shutdown and close the socket if (!m_beingDeleted) @@ -149,7 +255,7 @@ wxSocketBase::~wxSocketBase() // Destroy the GSocket object if (m_socket) - GSocket_destroy(m_socket); + delete m_socket; // Free the pushback buffer if (m_unread) @@ -161,24 +267,32 @@ 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. - m_beingDeleted = TRUE; + m_beingDeleted = true; // Shutdown and close the socket Close(); -#if wxUSE_GUI - if ( wxPendingDelete.Member(this) ) - wxPendingDelete.Append(this); -#else - delete this; -#endif + // 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: @@ -189,27 +303,27 @@ bool wxSocketBase::Destroy() bool wxSocketBase::Close() { // Interrupt pending waits - InterruptAllWaits(); + InterruptWait(); if (m_socket) { // Disable callbacks - GSocket_UnsetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + m_socket->UnsetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG); // Shutdown the connection - GSocket_Shutdown(m_socket); + m_socket->Shutdown(); } - m_connected = FALSE; - m_establishing = FALSE; - return TRUE; + m_connected = false; + m_establishing = false; + return true; } wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { // Mask read events - m_reading = TRUE; + m_reading = true; m_lcount = _Read(buffer, nbytes); @@ -220,7 +334,7 @@ wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) m_error = (m_lcount == 0); // Allow read events from now on - m_reading = FALSE; + m_reading = false; return *this; } @@ -228,41 +342,45 @@ wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes) { int total; - int ret = 1; // Try the pushback buffer first - total = GetPushback(buffer, nbytes, FALSE); + total = GetPushback(buffer, nbytes, false); nbytes -= total; buffer = (char *)buffer + total; - // If the socket is invalid or we got all the data, return now - if (!m_socket || !nbytes) + // Return now in one of the following cases: + // - the socket is invalid, + // - we got all the data + if ( !m_socket || + !nbytes ) return total; // Possible combinations (they are checked in this order) // wxSOCKET_NOWAIT - // wxSOCKET_WAITALL | wxSOCKET_BLOCK - // wxSOCKET_WAITALL + // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK) // wxSOCKET_BLOCK // wxSOCKET_NONE // + int ret; if (m_flags & wxSOCKET_NOWAIT) { - GSocket_SetNonBlocking(m_socket, TRUE); - ret = GSocket_Read(m_socket, (char *)buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); + m_socket->SetNonBlocking(1); + ret = m_socket->Read((char *)buffer, nbytes); + m_socket->SetNonBlocking(0); if (ret > 0) total += ret; } - else if (m_flags & wxSOCKET_WAITALL) + else { - while (ret > 0 && nbytes > 0) + bool more = true; + + while (more) { - if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead()) - break; + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() ) + break; - ret = GSocket_Read(m_socket, (char *)buffer, nbytes); + ret = m_socket->Read((char *)buffer, nbytes); if (ret > 0) { @@ -270,16 +388,12 @@ wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes) nbytes -= ret; buffer = (char *)buffer + ret; } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForRead()) - { - ret = GSocket_Read(m_socket, (char *)buffer, nbytes); - if (ret > 0) - total += ret; + // If we got here and wxSOCKET_WAITALL is not set, we can leave + // now. Otherwise, wait until we recv all the data or until there + // is an error. + // + more = (ret > 0 && nbytes > 0 && (m_flags & wxSOCKET_WAITALL)); } } @@ -298,10 +412,10 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) } msg; // Mask read events - m_reading = TRUE; + m_reading = true; total = 0; - error = TRUE; + error = true; old_flags = m_flags; SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); @@ -315,7 +429,7 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) if (sig != 0xfeeddead) { - wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); goto exit; } @@ -369,17 +483,17 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) if (sig != 0xdeadfeed) { - wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); goto exit; } // everything was OK - error = FALSE; + error = false; exit: m_error = error; m_lcount = total; - m_reading = FALSE; + m_reading = false; SetFlags(old_flags); return *this; @@ -388,7 +502,7 @@ exit: wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) { // Mask read events - m_reading = TRUE; + m_reading = true; m_lcount = _Read(buffer, nbytes); Pushback(buffer, m_lcount); @@ -400,7 +514,7 @@ wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) m_error = (m_lcount == 0); // Allow read events again - m_reading = FALSE; + m_reading = false; return *this; } @@ -408,7 +522,7 @@ wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { // Mask write events - m_writing = TRUE; + m_writing = true; m_lcount = _Write(buffer, nbytes); @@ -419,7 +533,7 @@ wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) m_error = (m_lcount == 0); // Allow write events again - m_writing = FALSE; + m_writing = false; return *this; } @@ -427,36 +541,37 @@ wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes) { wxUint32 total = 0; - int ret = 1; - // If the socket is invalid, return immediately - if (!m_socket) + // If the socket is invalid or parameters are ill, return immediately + if (!m_socket || !buffer || !nbytes) return 0; // Possible combinations (they are checked in this order) // wxSOCKET_NOWAIT - // wxSOCKET_WAITALL | wxSOCKET_BLOCK - // wxSOCKET_WAITALL + // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK) // wxSOCKET_BLOCK // wxSOCKET_NONE // + int ret; if (m_flags & wxSOCKET_NOWAIT) { - GSocket_SetNonBlocking(m_socket, TRUE); - ret = GSocket_Write(m_socket, (const char *)buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); + m_socket->SetNonBlocking(1); + ret = m_socket->Write((const char *)buffer, nbytes); + m_socket->SetNonBlocking(0); if (ret > 0) total = ret; } - else if (m_flags & wxSOCKET_WAITALL) + else { - while (ret > 0 && nbytes > 0) + bool more = true; + + while (more) { - if (!(m_flags & wxSOCKET_BLOCK) && !WaitForWrite()) - break; + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() ) + break; - ret = GSocket_Write(m_socket, (const char *)buffer, nbytes); + ret = m_socket->Write((const char *)buffer, nbytes); if (ret > 0) { @@ -464,16 +579,12 @@ wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes) nbytes -= ret; buffer = (const char *)buffer + ret; } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite()) - { - ret = GSocket_Write(m_socket, (const char *)buffer, nbytes); - if (ret > 0) - total = ret; + // If we got here and wxSOCKET_WAITALL is not set, we can leave + // now. Otherwise, wait until we send all the data or until there + // is an error. + // + more = (ret > 0 && nbytes > 0 && (m_flags & wxSOCKET_WAITALL)); } } @@ -484,7 +595,6 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) { wxUint32 total; bool error; - int old_flags; struct { unsigned char sig[4]; @@ -492,11 +602,10 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) } msg; // Mask write events - m_writing = TRUE; + m_writing = true; - error = TRUE; + error = true; total = 0; - old_flags = m_flags; SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); msg.sig[0] = (unsigned char) 0xad; @@ -527,12 +636,12 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) goto exit; // everything was OK - error = FALSE; + error = false; exit: m_error = error; m_lcount = total; - m_writing = FALSE; + m_writing = false; return *this; } @@ -542,7 +651,7 @@ wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) if (nbytes != 0) Pushback(buffer, nbytes); - m_error = FALSE; + m_error = false; m_lcount = nbytes; return *this; @@ -550,15 +659,13 @@ wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) wxSocketBase& wxSocketBase::Discard() { - int old_flags; char *buffer = new char[MAX_DISCARD_SIZE]; wxUint32 ret; wxUint32 total = 0; // Mask read events - m_reading = TRUE; + m_reading = true; - old_flags = m_flags; SetFlags(wxSOCKET_NOWAIT); do @@ -570,10 +677,10 @@ wxSocketBase& wxSocketBase::Discard() delete[] buffer; m_lcount = total; - m_error = FALSE; + m_error = false; // Allow read events again - m_reading = FALSE; + m_reading = false; return *this; } @@ -588,18 +695,19 @@ wxSocketBase& wxSocketBase::Discard() // timeout elapses. The polling loop calls PROCESS_EVENTS(), so // this won't block the GUI. -bool wxSocketBase::_Wait(long seconds, long milliseconds, +bool wxSocketBase::_Wait(long seconds, + long milliseconds, wxSocketEventFlags flags) { GSocketEventFlags result; - long timeout; + long timeout; // in ms - // Set this to TRUE to interrupt ongoing waits - m_interrupt = FALSE; + // Set this to true to interrupt ongoing waits + m_interrupt = false; // Check for valid socket if (!m_socket) - return FALSE; + return false; // Check for valid timeout value. if (seconds != -1) @@ -607,88 +715,121 @@ bool wxSocketBase::_Wait(long seconds, long milliseconds, else timeout = m_timeout * 1000; - // Active polling (without using events) + // check if we are using event loop or not: normally we do in GUI but not in + // console applications but this can be overridden + const bool has_event_loop = wxEventLoop::GetActive() != NULL; + + // Wait in an active polling loop. // - // 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. + // NOTE: We duplicate some of the code in OnRequest, but this doesn't + // hurt. It has to be here because the (GSocket) event might arrive + // a bit delayed, and it has to be in OnRequest as well because we + // don't know whether the Wait functions are being used. // // Do this at least once (important if timeout == 0, when // we are just polling). Also, if just polling, do not yield. - wxStopWatch chrono; - bool done = FALSE; + const wxMilliClock_t time_limit = wxGetLocalTimeMillis() + timeout; + bool done = false; + bool valid_result = false; + + if (!has_event_loop) + { + // This is used to avoid a busy loop on wxBase - having a select + // timeout of 50 ms per iteration should be enough. + if (timeout > 50) + m_socket->SetTimeout(50); + else + m_socket->SetTimeout(timeout); + } while (!done) { - result = GSocket_Select(m_socket, flags | GSOCK_LOST_FLAG); + 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; - return TRUE; + m_connected = true; + m_establishing = false; + valid_result = true; + break; } // Data available or output buffer ready if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG)) { - return TRUE; + valid_result = true; + break; } // Connection lost if (result & GSOCK_LOST_FLAG) { - m_connected = FALSE; - m_establishing = FALSE; - return (flags & GSOCK_LOST_FLAG); + m_connected = false; + m_establishing = false; + valid_result = ((flags & GSOCK_LOST_FLAG) != 0); + break; } // Wait more? - if ((!timeout) || (chrono.Time() > timeout) || (m_interrupt)) - done = TRUE; + long time_left = wxMilliClockToLong(time_limit - wxGetLocalTimeMillis()); + if ((!timeout) || (time_left <= 0) || (m_interrupt)) + done = true; else - PROCESS_EVENTS(); + { + if (has_event_loop) + { + PROCESS_EVENTS(); + } + else + { + // If there's less than 50 ms left, just call select with that timeout. + if (time_left < 50) + m_socket->SetTimeout(time_left); + } + } } - return FALSE; + // Set timeout back to original value (we overwrote it for polling) + if (!has_event_loop) + m_socket->SetTimeout(m_timeout*1000); + + return valid_result; } bool wxSocketBase::Wait(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | - GSOCK_OUTPUT_FLAG | - GSOCK_CONNECTION_FLAG | - GSOCK_LOST_FLAG); + return _Wait(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; + 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 + // _Wait 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 _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG); } + bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG); + return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG); } bool wxSocketBase::WaitForLost(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG); + return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG); } // -------------------------------------------------------------------------- @@ -704,27 +845,33 @@ bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const GAddress *peer; if (!m_socket) - return FALSE; + return false; + + peer = m_socket->GetPeer(); + + // copying a null address would just trigger an assert anyway + + if (!peer) + return false; - peer = GSocket_GetPeer(m_socket); addr_man.SetAddress(peer); GAddress_destroy(peer); - return TRUE; + 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; } // @@ -733,38 +880,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; } // @@ -773,67 +918,62 @@ 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(wxSocketFlags flags) { - m_flags = flags; -} - - -// -------------------------------------------------------------------------- -// Callbacks (now obsolete - use events instead) -// -------------------------------------------------------------------------- - -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) -{ - wxSockCbk old_cbk = cbk_; - - m_cbk = cbk_; - return old_cbk; + m_flags = flags; } -char *wxSocketBase::CallbackData(char *data) -{ - char *old_data = m_cdata; - - m_cdata = data; - return old_data; -} // -------------------------------------------------------------------------- // Event handling // -------------------------------------------------------------------------- -// Callback function from GSocket. All events are internally -// monitored, but users only get these they are interested in. - -static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), - GSocketEvent notify, - char *cdata) +// 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) { - wxSocketBase *sckobj = (wxSocketBase *)cdata; + wxSocketBase *sckobj = (wxSocketBase *)cdata; - sckobj->OnRequest((wxSocketNotify) notify); + sckobj->OnRequest((wxSocketNotify) notification); } - -void wxSocketBase::OnRequest(wxSocketNotify req_evt) +void wxSocketBase::OnRequest(wxSocketNotify notification) { - // 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. + // NOTE: We duplicate some of the code in _Wait, but this doesn't + // hurt. It has to be here because the (GSocket) event might arrive + // a bit delayed, and it has to be in _Wait as well because we don't + // know whether the Wait functions are being used. - switch(req_evt) + switch(notification) { case wxSOCKET_CONNECTION: - m_establishing = FALSE; - m_connected = TRUE; + m_establishing = false; + m_connected = true; break; // If we are in the middle of a R/W operation, do not @@ -841,18 +981,18 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt) // which are no longer valid. case wxSOCKET_INPUT: - if (m_reading || !GSocket_Select(m_socket, GSOCK_INPUT_FLAG)) + if (m_reading || !m_socket->Select(GSOCK_INPUT_FLAG)) return; break; case wxSOCKET_OUTPUT: - if (m_writing || !GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG)) + if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG)) return; break; case wxSOCKET_LOST: - m_connected = FALSE; - m_establishing = FALSE; + m_connected = false; + m_establishing = false; break; default: @@ -861,52 +1001,51 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt) // Schedule the event - wxSocketEventFlags flag = -1; - switch (req_evt) + 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 (((m_neededreq & flag) == flag) && m_notify_state) + if (((m_eventmask & flag) == flag) && m_notify) { - wxSocketEvent event(m_id); - - event.m_event = req_evt; - event.m_clientData = m_clientData; - event.SetEventObject(this); - if (m_handler) -#if USE_DELAYED_EVENTS - m_handler->AddPendingEvent(event); -#else - m_handler->ProcessEvent(event); -#endif + { + wxSocketEvent event(m_id); + event.m_event = notification; + event.m_clientData = m_clientData; + event.SetEventObject(this); - if (m_cbk) - m_cbk(*this, req_evt, m_cdata); + m_handler->AddPendingEvent(event); + } } } void wxSocketBase::Notify(bool notify) { - m_notify_state = notify; + m_notify = notify; + if (m_socket) + m_socket->Notify(notify); } void wxSocketBase::SetNotify(wxSocketEventFlags flags) { - m_neededreq = flags; + m_eventmask = flags; } void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id) { - m_handler = &handler; - m_id = id; + m_handler = &handler; + m_id = id; } - // -------------------------------------------------------------------------- // Pushback buffer // -------------------------------------------------------------------------- @@ -960,37 +1099,56 @@ wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek) // ========================================================================== -// wxSocketServer +// wxSocketServer // ========================================================================== // -------------------------------------------------------------------------- // Ctor // -------------------------------------------------------------------------- -wxSocketServer::wxSocketServer(wxSockAddress& addr_man, +wxSocketServer::wxSocketServer(const wxSockAddress& addr_man, wxSocketFlags flags) : wxSocketBase(flags, wxSOCKET_SERVER) { - // Create the socket - m_socket = GSocket_new(); + wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") ); - if (!m_socket) - return; + m_socket = GSocket_new(); - // 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; - } + if (!m_socket) + { + wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") ); + 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); + // 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 ); } // -------------------------------------------------------------------------- @@ -1002,33 +1160,33 @@ bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) GSocket *child_socket; if (!m_socket) - return FALSE; + return false; - // If wait == FALSE, then the call should be nonblocking. + // If wait == false, then the call should be nonblocking. // When we are finished, we put the socket to blocking mode // again. if (!wait) - GSocket_SetNonBlocking(m_socket, TRUE); + m_socket->SetNonBlocking(1); - child_socket = GSocket_WaitConnection(m_socket); + child_socket = m_socket->WaitConnection(); if (!wait) - GSocket_SetNonBlocking(m_socket, FALSE); + m_socket->SetNonBlocking(0); if (!child_socket) - return FALSE; + return false; sock.m_type = wxSOCKET_BASE; sock.m_socket = child_socket; - sock.m_connected = TRUE; + sock.m_connected = true; - GSocket_SetTimeout(sock.m_socket, sock.m_timeout * 1000); - GSocket_SetCallback(sock.m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + 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); - return TRUE; + return true; } wxSocketBase *wxSocketServer::Accept(bool wait) @@ -1038,14 +1196,57 @@ wxSocketBase *wxSocketServer::Accept(bool wait) sock->SetFlags(m_flags); if (!AcceptWith(*sock, wait)) - return NULL; + { + sock->Destroy(); + sock = NULL; + } return sock; } bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) { - return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); + return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); +} + +bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen) +{ + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); + + if (m_socket->GetSockOpt(level, optname, optval, optlen) + != GSOCK_NOERROR) + { + return false; + } + return true; +} + +bool wxSocketBase::SetOption(int level, int optname, const void *optval, + int optlen) +{ + wxASSERT_MSG( m_socket, _T("Socket not initialised") ); + + if (m_socket->SetSockOpt(level, optname, optval, optlen) + != GSOCK_NOERROR) + { + return false; + } + return true; +} + +bool wxSocketBase::SetLocal(wxIPV4address& local) +{ + 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; } // ========================================================================== @@ -1059,6 +1260,8 @@ bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) wxSocketClient::wxSocketClient(wxSocketFlags flags) : wxSocketBase(flags, wxSOCKET_CLIENT) { + m_initialRecvBufferSize = + m_initialSendBufferSize = -1; } wxSocketClient::~wxSocketClient() @@ -1069,7 +1272,7 @@ wxSocketClient::~wxSocketClient() // Connect // -------------------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) +bool wxSocketClient::DoConnect(wxSockAddress& addr_man, wxSockAddress* local, bool wait) { GSocketError err; @@ -1077,56 +1280,102 @@ bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) { // Shutdown and destroy the socket Close(); - GSocket_destroy(m_socket); + delete m_socket; } m_socket = GSocket_new(); - m_connected = FALSE; - m_establishing = FALSE; + m_connected = false; + m_establishing = false; if (!m_socket) - return FALSE; + return false; - GSocket_SetTimeout(m_socket, m_timeout * 1000); - GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + 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. + // If wait == false, then the call should be nonblocking. // When we are finished, we put the socket to blocking mode // again. if (!wait) - GSocket_SetNonBlocking(m_socket, TRUE); + m_socket->SetNonBlocking(1); - GSocket_SetPeer(m_socket, addr_man.GetAddress()); - err = GSocket_Connect(m_socket, GSOCK_STREAMED); + // 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; + } + + // Bind to the local IP address and port, when provided + if (local) + { + GAddress* la = local->GetAddress(); + + if (la && la->m_addr) + m_socket->SetLocal(la); + } + +#if defined(__WXMSW__) || defined(__WXGTK__) + m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); +#endif + + m_socket->SetPeer(addr_man.GetAddress()); + err = m_socket->Connect(GSOCK_STREAMED); + + //this will register for callbacks - must be called after m_socket->m_fd was initialized + m_socket->Notify(m_notify); if (!wait) - GSocket_SetNonBlocking(m_socket, FALSE); + m_socket->SetNonBlocking(0); if (err != GSOCK_NOERROR) { if (err == GSOCK_WOULDBLOCK) - m_establishing = TRUE; + m_establishing = true; - return FALSE; + return false; } - m_connected = TRUE; - return TRUE; + m_connected = true; + return true; +} + +bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) +{ + return (DoConnect(addr_man, NULL, wait)); +} + +bool wxSocketClient::Connect(wxSockAddress& addr_man, 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) // Already connected + return true; - if (!m_establishing || !m_socket) // No connection in progress - return FALSE; + if (!m_establishing || !m_socket) // No connection in progress + return false; - return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG | - GSOCK_LOST_FLAG); + return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG | + GSOCK_LOST_FLAG); } // ========================================================================== @@ -1135,33 +1384,47 @@ bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) /* NOTE: experimental stuff - might change */ -wxDatagramSocket::wxDatagramSocket( wxSockAddress& addr, +wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr, wxSocketFlags flags ) : wxSocketBase( flags, wxSOCKET_DATAGRAM ) { - // Create the socket - m_socket = GSocket_new(); - - if(!m_socket) - return; + // Create the socket + m_socket = GSocket_new(); - // 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 ); + 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, @@ -1173,46 +1436,38 @@ wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, return (*this); } -wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr, +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 -// ========================================================================== - -wxSocketEvent::wxSocketEvent(int id) : wxEvent(id) -{ - SetEventType( (wxEventType)wxEVT_SOCKET ); -} - -void wxSocketEvent::CopyObject(wxObject& object_dest) const -{ - wxSocketEvent *event = (wxSocketEvent *)&object_dest; - - wxEvent::CopyObject(object_dest); - - event->m_event = m_event; - event->m_clientData = m_clientData; -} - - // ========================================================================== // 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)