X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5e2e843f0013a93fd113d62fa6fc00ea7c8e21f0..35d5da677d3203d7027eb28b1b6878be9d920108:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 078079063b..a4f8583376 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,60 +1,82 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// - -#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/socket.h" -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// +#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() +// 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 -// use wxPostEvent or not -#define EXPERIMENTAL_USE_POST 1 +#define wxTRACE_Socket _T("wxSocket") -// -------------------------------------------------------------- -// ClassInfos -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// wxWin macros +// -------------------------------------------------------------------------- IMPLEMENT_CLASS(wxSocketBase, wxObject) IMPLEMENT_CLASS(wxSocketServer, wxSocketBase) @@ -62,107 +84,247 @@ IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase) IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) +// -------------------------------------------------------------------------- +// private classes +// -------------------------------------------------------------------------- + class wxSocketState : public wxObject { public: - bool m_notify_state; - GSocketEventFlags 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() {} + + DECLARE_NO_COPY_CLASS(wxSocketState) }; -// -------------------------------------------------------------- -// wxSocketBase 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) +// ============================================================================ +// 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::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 +// ========================================================================== + +// -------------------------------------------------------------------------- +// 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 +// -------------------------------------------------------------------------- + +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() +{ + Init(); +} + +wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type) +{ + Init(); + + m_flags = flags; + m_type = type; } wxSocketBase::~wxSocketBase() { - if (m_unread) - free(m_unread); + // 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 - Close(); + if (!m_beingDeleted) + Close(); // Destroy the GSocket object if (m_socket) - GSocket_destroy(m_socket); + delete m_socket; + + // Free the pushback buffer + if (m_unread) + free(m_unread); } -bool wxSocketBase::Close() +bool wxSocketBase::Destroy() { - // Interrupt pending waits - InterruptAllWaits(); + // Delayed destruction: the socket will be deleted during the next + // idle loop iteration. This ensures that all pending events have + // been processed. + m_beingDeleted = true; - if (m_socket) - { - // Disable callbacks - GSocket_UnsetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG); + // Shutdown and close the socket + Close(); - // Shutdown the connection - GSocket_Shutdown(m_socket); - m_connected = FALSE; - m_establishing = FALSE; + // Supress events from now on + Notify(false); + + // schedule this object for deletion + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) + { + // let the traits object decide what to do with us + traits->ScheduleForDestroy(this); + } + else // no app or no traits + { + // in wxBase we might have no app object at all, don't leak memory + delete this; } - return TRUE; + return true; } -// -------------------------------------------------------------- -// wxSocketBase basic IO operations -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Basic IO calls +// -------------------------------------------------------------------------- -// All IO operations {Read, Write, ReadMsg, WriteMsg, Peek, -// Unread, Discard} update m_error and m_lcount. +// The following IO operations update m_error and m_lcount: +// {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard} // // TODO: Should Connect, Accept and AcceptWith update m_error? -class _wxSocketInternalTimer: public wxTimer +bool wxSocketBase::Close() { -public: - int *m_state; - unsigned long m_new_val; + // Interrupt pending waits + InterruptWait(); - void Notify() + if (m_socket) { - *m_state = (int)m_new_val; // Change the value + // Disable callbacks + m_socket->UnsetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG); + + // Shutdown the connection + m_socket->Shutdown(); } -}; -wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) + 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); @@ -173,74 +335,93 @@ wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) m_error = (m_lcount == 0); // Allow read events from now on - m_reading = FALSE; + m_reading = false; return *this; } -wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes) +wxUint32 wxSocketBase::_Read(void* buffer_, wxUint32 nbytes) { + char *buffer = (char *)buffer_; + int total; - int ret = 1; - // we try this even if the connection has already been closed. - total = GetPushback(buffer, nbytes, FALSE); + // Try the pushback buffer first + total = GetPushback(buffer, nbytes, false); nbytes -= total; - buffer += total; + buffer = (char *)buffer + total; - // If the socket is not connected, or we have got the whole - // needed buffer, return immedately - if (!m_socket || !m_connected || !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, buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); + m_socket->SetNonBlocking(1); + ret = m_socket->Read(buffer, nbytes); + m_socket->SetNonBlocking(0); - if (ret > 0) - total += ret; + if ( ret < 0 ) + return 0; + + total += ret; } - else if (m_flags & wxSOCKET_WAITALL) + else // blocking socket { - while (ret > 0 && nbytes > 0) + for ( ;; ) { - if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead()) - break; + // dispatch events unless disabled + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() ) + break; - ret = GSocket_Read(m_socket, buffer, nbytes); + 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) + if ( ret < 0 ) { - total += ret; - buffer += ret; - nbytes -= ret; + // this will be always interpreted as error by Read() + return 0; } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForRead()) - { - ret = GSocket_Read(m_socket, buffer, nbytes); - if (ret > 0) - total += ret; + total += ret; + + // if wxSOCKET_WAITALL is not set, we can leave now as we did read + // something + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + // otherwise check if read the maximal requested amount of data + nbytes -= ret; + if ( !nbytes ) + break; + + // we didn't, so continue reading + buffer = (char *)buffer + ret; } } return total; } -wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) { wxUint32 len, len2, sig, total; bool error; @@ -252,14 +433,14 @@ wxSocketBase& wxSocketBase::ReadMsg(char* 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); - if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg)) + if (_Read(&msg, sizeof(msg)) != sizeof(msg)) goto exit; sig = (wxUint32)msg.sig[0]; @@ -269,7 +450,7 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) if (sig != 0xfeeddead) { - wxLogWarning( _("TCP: invalid signature returned to ReadMsg.")); + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); goto exit; } @@ -278,9 +459,6 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) len |= (wxUint32)(msg.len[2] << 16); len |= (wxUint32)(msg.len[3] << 24); - //wxLogMessage("Readmsg: %d %d %d %d -> len == %d", - // msg.len[0], msg.len[1], msg.len[2], msg.len[3], len); - if (len > nbytes) { len2 = len - nbytes; @@ -289,8 +467,7 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) else len2 = 0; - // This check is necessary so that we don't attemp to read if - // the msg was zero bytes long. + // Don't attemp to read if the msg was zero bytes long. if (len) { total = _Read(buffer, len); @@ -317,7 +494,7 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) if (len2 != 0) goto exit; } - if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg)) + if (_Read(&msg, sizeof(msg)) != sizeof(msg)) goto exit; sig = (wxUint32)msg.sig[0]; @@ -327,26 +504,26 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) if (sig != 0xdeadfeed) { - //wxLogMessage(wxT("Warning: invalid signature returned to 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; } -wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes) +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); @@ -358,15 +535,15 @@ wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes) m_error = (m_lcount == 0); // Allow read events again - m_reading = FALSE; + m_reading = false; return *this; } -wxSocketBase& wxSocketBase::Write(const char *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); @@ -377,108 +554,101 @@ wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes) m_error = (m_lcount == 0); // Allow write events again - m_writing = FALSE; + m_writing = false; return *this; } -wxUint32 wxSocketBase::_Write(const char *buffer, wxUint32 nbytes) +wxUint32 wxSocketBase::_Write(const void *buffer_, wxUint32 nbytes) { + const char *buffer = (const char *)buffer_; + wxUint32 total = 0; - int ret = 1; - if (!m_connected || !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, buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); + m_socket->SetNonBlocking(1); + ret = m_socket->Write(buffer, nbytes); + m_socket->SetNonBlocking(0); if (ret > 0) total = ret; } - else if (m_flags & wxSOCKET_WAITALL) + else // blocking socket { - while (ret > 0 && nbytes > 0) + for ( ;; ) { - if (!(m_flags & wxSOCKET_BLOCK) && !WaitForWrite()) - break; + if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() ) + break; - ret = GSocket_Write(m_socket, buffer, nbytes); + ret = m_socket->Write(buffer, nbytes); - if (ret > 0) + // see comments for similar logic for ret handling in _Read() + if ( ret == 0 ) { - total += ret; - buffer += ret; - nbytes -= ret; + m_closed = true; + break; + } + + if ( ret < 0 ) + { + return 0; } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite()) - { - ret = GSocket_Write(m_socket, buffer, nbytes); - if (ret > 0) - total = ret; + total += ret; + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + nbytes -= ret; + if ( !nbytes ) + break; + + buffer = (const char *)buffer + ret; } } 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 { + struct + { unsigned char sig[4]; unsigned char len[4]; } 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); - // warning about 'cast truncates constant value' -#ifdef __VISUALC__ -# pragma warning(disable: 4310) -#endif // __VISUALC__ - 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; - - //wxLogMessage("Writemsg: %d %d %d %d -> %d", - // nbytes & 0xff, - // (nbytes >> 8) & 0xff, - // (nbytes >> 16) & 0xff, - // (nbytes >> 24) & 0xff, - // nbytes - // ); + 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)) + if (_Write(&msg, sizeof(msg)) < sizeof(msg)) goto exit; total = _Write(buffer, nbytes); @@ -492,30 +662,26 @@ wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, wxUint32 nbytes) 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)) + if ((_Write(&msg, sizeof(msg))) < sizeof(msg)) goto exit; // everything was OK - error = FALSE; + error = false; exit: m_error = error; m_lcount = total; - m_writing = FALSE; + m_writing = false; return *this; - -#ifdef __VISUALC__ -# pragma warning(default: 4310) -#endif // __VISUALC__ } -wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes) +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; @@ -523,387 +689,409 @@ wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes) wxSocketBase& wxSocketBase::Discard() { - int old_flags; - char *my_data = new char[MAX_DISCARD_SIZE]; - wxUint32 recv_size = MAX_DISCARD_SIZE; + 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); - while (recv_size == MAX_DISCARD_SIZE) + do { - recv_size = _Read(my_data, MAX_DISCARD_SIZE); - total += recv_size; + ret = _Read(buffer, MAX_DISCARD_SIZE); + total += ret; } + while (ret == MAX_DISCARD_SIZE); - delete [] my_data; + delete[] buffer; m_lcount = total; - m_error = FALSE; + m_error = false; // Allow read events again - m_reading = FALSE; + m_reading = false; return *this; } -// -------------------------------------------------------------- -// wxSocketBase get local or peer addresses -// -------------------------------------------------------------- - -bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const -{ - GAddress *peer; - - if (!m_socket) - return FALSE; - - peer = GSocket_GetPeer(m_socket); - addr_man.SetAddress(peer); - GAddress_destroy(peer); - - return TRUE; -} - -bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const -{ - GAddress *local; - - if (!m_socket) - return FALSE; - - local = GSocket_GetLocal(m_socket); - addr_man.SetAddress(local); - GAddress_destroy(local); - - return TRUE; -} - -// -------------------------------------------------------------- -// wxSocketBase save and restore socket state -// -------------------------------------------------------------- - -void wxSocketBase::SaveState() -{ - wxSocketState *state; - - 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; - - m_states.Append(state); -} - -void wxSocketBase::RestoreState() -{ - wxNode *node; - wxSocketState *state; - - node = m_states.Last(); - if (!node) - return; - - state = (wxSocketState *)node->Data(); - - SetFlags(state->m_flags); - m_cbk = state->m_cbk; - m_cdata = state->m_cdata; - m_neededreq = state->m_neededreq; - Notify(state->m_notify_state); - - delete node; - delete state; -} - +// -------------------------------------------------------------------------- +// Wait functions +// -------------------------------------------------------------------------- -// -------------------------------------------------------------- -// wxSocketBase Wait functions -// -------------------------------------------------------------- +// 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 +// this won't block the GUI. -// These WaitXXX unctions do not depend on the event system any -// longer; instead, they poll the socket, using GSocket_Select() -// to check for the specified combination of event flags, until -// an event occurs or until the timeout ellapses. The polling -// loop calls PROCESS_EVENTS(), so this won't block the GUI. -// -// XXX: Should it honour the wxSOCKET_BLOCK flag ? -// -bool wxSocketBase::_Wait(long seconds, long milliseconds, +bool wxSocketBase::_Wait(long seconds, + long milliseconds, wxSocketEventFlags flags) { GSocketEventFlags result; - _wxSocketInternalTimer timer; - long timeout; - int state = -1; + 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; - // If it is not a server, it must be connected or establishing connection - if ((m_type != SOCK_SERVER) && (!m_connected && !m_establishing)) - return FALSE; - - // Check for valid timeout value + // 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); - } + // 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; - // Active polling (without using events) + // 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 WaitXXX 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. - // - while (state == -1) + + 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) { - timer.Stop(); - 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)) { - timer.Stop(); - return TRUE; + valid_result = true; + break; } // Connection lost if (result & GSOCK_LOST_FLAG) { - timer.Stop(); - return TRUE; // XXX: should be FALSE if !(flags & GSOCK_LOST_FLAG) ! + m_connected = false; + m_establishing = false; + valid_result = ((flags & GSOCK_LOST_FLAG) != 0); + break; } // Wait more? - if ((timeout == 0) || (m_interrupt)) - break; + 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); + } + } } - timer.Stop(); - 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 + // Check pushback buffer before entering _Wait if (m_unread) - return TRUE; + return true; - return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG); + // Note that GSOCK_INPUT_LOST has to be explicitly passed to + // _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); } -void wxSocketBase::SetTimeout(long seconds) +// -------------------------------------------------------------------------- +// Miscellaneous +// -------------------------------------------------------------------------- + +// +// Get local or peer address +// + +bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const { - m_timeout = seconds; + GAddress *peer; - if (m_socket) - GSocket_SetTimeout(m_socket, m_timeout * 1000); -} + if (!m_socket) + return false; -// -------------------------------------------------------------- -// wxSocketBase flags -// -------------------------------------------------------------- + peer = m_socket->GetPeer(); -void wxSocketBase::SetFlags(wxSockFlags _flags) -{ - m_flags = _flags; -} + // copying a null address would just trigger an assert anyway -// -------------------------------------------------------------- -// wxSocketBase callback management -// -------------------------------------------------------------- + if (!peer) + return false; -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) -{ - wxSockCbk old_cbk = cbk_; + addr_man.SetAddress(peer); + GAddress_destroy(peer); - m_cbk = cbk_; - return old_cbk; + return true; } -char *wxSocketBase::CallbackData(char *data) +bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const { - char *old_data = m_cdata; + GAddress *local; - m_cdata = data; - return old_data; -} + if (!m_socket) + return false; -// -------------------------------------------------------------- -// wxSocketBase automatic notifier -// -------------------------------------------------------------- + local = m_socket->GetLocal(); + addr_man.SetAddress(local); + GAddress_destroy(local); -// All events (INPUT, OUTPUT, CONNECTION, LOST) are now always -// internally watched; but users will only be notified of those -// events they are interested in. + return true; +} + +// +// Save and restore socket state +// -static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), - GSocketEvent event, char *cdata) +void wxSocketBase::SaveState() { - wxSocketBase *sckobj = (wxSocketBase *)cdata; + wxSocketState *state; + + state = new wxSocketState(); + + state->m_flags = m_flags; + state->m_notify = m_notify; + state->m_eventmask = m_eventmask; + state->m_clientData = m_clientData; - sckobj->OnRequest((wxSocketNotify)event); + m_states.Append(state); } -wxSocketEventFlags wxSocketBase::EventToNotify(wxSocketNotify evt) +void wxSocketBase::RestoreState() { - 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; + wxList::compatibility_iterator node; + wxSocketState *state; + + node = m_states.GetLast(); + if (!node) + return; + + state = (wxSocketState *)node->GetData(); + + m_flags = state->m_flags; + m_notify = state->m_notify; + m_eventmask = state->m_eventmask; + m_clientData = state->m_clientData; + + m_states.Erase(node); + delete state; } -void wxSocketBase::SetNotify(wxSocketEventFlags flags) +// +// Timeout and flags +// + +void wxSocketBase::SetTimeout(long seconds) { - m_neededreq = flags; + m_timeout = seconds; + + if (m_socket) + m_socket->SetTimeout(m_timeout * 1000); } -void wxSocketBase::Notify(bool notify) +void wxSocketBase::SetFlags(wxSocketFlags flags) { - m_notify_state = notify; + m_flags = flags; } -void wxSocketBase::OnRequest(wxSocketNotify req_evt) + +// -------------------------------------------------------------------------- +// Event handling +// -------------------------------------------------------------------------- + +// A note on how events are processed, which is probably the most +// difficult thing to get working right while keeping the same API +// and functionality for all platforms. +// +// When GSocket detects an event, it calls wx_socket_callback, which in +// turn just calls wxSocketBase::OnRequest in the corresponding wxSocket +// object. OnRequest does some housekeeping, and if the event is to be +// propagated to the user, it creates a new wxSocketEvent object and +// posts it. The event is not processed immediately, but delayed with +// AddPendingEvent instead. This is necessary in order to decouple the +// event processing from wx_socket_callback; otherwise, subsequent IO +// calls made from the user event handler would fail, as gtk callbacks +// are not reentrant. +// +// Note that, unlike events, user callbacks (now deprecated) are _not_ +// decoupled from wx_socket_callback and thus they suffer from a variety +// of problems. Avoid them where possible and use events instead. + +extern "C" +void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), + GSocketEvent notification, + char *cdata) { - wxSocketEvent event(m_id); - wxSocketEventFlags flag = EventToNotify(req_evt); + wxSocketBase *sckobj = (wxSocketBase *)cdata; - // dbg("Entering OnRequest (evt %d)\n", req_evt); + sckobj->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 - // WaitXXX will be used, and it has to be in _Wait as well - // because the event might be a bit delayed. - // - if (req_evt == wxSOCKET_CONNECTION) - { - m_establishing = FALSE; - m_connected = TRUE; - } - else if (req_evt == wxSOCKET_INPUT) +void wxSocketBase::OnRequest(wxSocketNotify notification) +{ + // 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(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. - // - if (m_reading || !GSocket_Select(m_socket, GSOCK_INPUT_FLAG)) - return; + + 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; + + default: + break; } - else if (req_evt == wxSOCKET_OUTPUT) + + // Schedule the event + + wxSocketEventFlags flag = 0; + wxUnusedVar(flag); + switch (notification) { - if (m_writing || !GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG)) + 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) { - // dbg("Evt %d delivered\n", req_evt); - event.m_socket = this; - event.m_skevt = req_evt; - - if (m_evt_handler) -#if EXPERIMENTAL_USE_POST - wxPostEvent(m_evt_handler, event); -#else - ProcessEvent(event); -#endif - - OldOnNotify(req_evt); - if (m_cbk) - m_cbk(*this, req_evt, m_cdata); + if (m_handler) + { + wxSocketEvent event(m_id); + event.m_event = notification; + event.m_clientData = m_clientData; + event.SetEventObject(this); + m_handler->AddPendingEvent(event); + } } - - // dbg("Exiting OnRequest (evt %d)\n", req_evt); } -void wxSocketBase::OldOnNotify(wxSocketNotify WXUNUSED(evt)) +void wxSocketBase::Notify(bool notify) { + m_notify = notify; + if (m_socket) + m_socket->Notify(notify); } -// -------------------------------------------------------------- -// wxSocketBase set event handler -// -------------------------------------------------------------- - -void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id) +void wxSocketBase::SetNotify(wxSocketEventFlags flags) { - m_evt_handler = &h_evt; - m_id = id; + m_eventmask = flags; +} - SetNextHandler(&h_evt); +void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id) +{ + m_handler = &handler; + m_id = id; } -// -------------------------------------------------------------- -// wxSocketBase pushback -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Pushback buffer +// -------------------------------------------------------------------------- -void wxSocketBase::Pushback(const char *buffer, wxUint32 size) +void wxSocketBase::Pushback(const void *buffer, wxUint32 size) { if (!size) return; if (m_unread == NULL) - m_unread = (char *)malloc(size); + m_unread = malloc(size); else { - char *tmp; + void *tmp; - tmp = (char *)malloc(m_unrd_size + size); - memcpy(tmp+size, m_unread, m_unrd_size); + tmp = malloc(m_unrd_size + size); + memcpy((char *)tmp + size, m_unread, m_unrd_size); free(m_unread); m_unread = tmp; @@ -914,7 +1102,7 @@ void wxSocketBase::Pushback(const char *buffer, wxUint32 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; @@ -922,7 +1110,7 @@ wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek) if (size > (m_unrd_size-m_unrd_cur)) size = m_unrd_size-m_unrd_cur; - memcpy(buffer, (m_unread+m_unrd_cur), size); + memcpy(buffer, (char *)m_unread + m_unrd_cur, size); if (!peek) { @@ -939,212 +1127,342 @@ wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek) return size; } -// -------------------------------------------------------------- + +// ========================================================================== // wxSocketServer -// -------------------------------------------------------------- +// ========================================================================== -// -------------------------------------------------------------- -// wxSocketServer ctor and dtor -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// 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(); + 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 ); } -// -------------------------------------------------------------- -// wxSocketServer Accept -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Accept +// -------------------------------------------------------------------------- bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { GSocket *child_socket; if (!m_socket) - return FALSE; + return false; - // GRG: 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); - // GRG: this was not being handled! - if (child_socket == NULL) - return FALSE; + if (!child_socket) + return false; - sock.m_type = SOCK_INTERNAL; + 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) { wxSocketBase* sock = new wxSocketBase(); - sock->SetFlags((wxSockFlags)m_flags); + 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(const 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; +} + +// ========================================================================== // wxSocketClient -// -------------------------------------------------------------- +// ========================================================================== -// -------------------------------------------------------------- -// wxSocketClient ctor and dtor -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) : - wxSocketBase(_flags, SOCK_CLIENT) +wxSocketClient::wxSocketClient(wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_CLIENT) { + m_initialRecvBufferSize = + m_initialSendBufferSize = -1; } wxSocketClient::~wxSocketClient() { } -// -------------------------------------------------------------- -// wxSocketClient Connect functions -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Connect +// -------------------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) +bool wxSocketClient::DoConnect(const wxSockAddress& addr_man, + const wxSockAddress* local, + bool wait) { GSocketError err; - if (IsConnected()) - Close(); - if (m_socket) - GSocket_destroy(m_socket); + { + // Shutdown and destroy the socket + Close(); + delete m_socket; + } - // Initialize all socket stuff ... 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); - // GRG: 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); + + // 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(); - GSocket_SetPeer(m_socket, addr_man.GetAddress()); - err = GSocket_Connect(m_socket, GSOCK_STREAMED); + 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(const wxSockAddress& addr_man, bool wait) +{ + return DoConnect(addr_man, NULL, wait); +} + +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) // 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); + return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG | + GSOCK_LOST_FLAG); } -// -------------------------------------------------------------- +// ========================================================================== // wxDatagramSocket -// -------------------------------------------------------------- +// ========================================================================== /* 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; + // 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, - char* buf, + void* buf, wxUint32 nBytes ) { Read(buf, nBytes); @@ -1152,53 +1470,38 @@ 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 -// -------------------------------------------------------------- - -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)