X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/04e1eb03b0daca6fb94a87c972da527c25db032c..0fe5e8fea017ecb73f8aaa8ceb745feb269b3f79:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 1cfac04844..95669073cd 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -9,6 +9,10 @@ // License: see wxWindows license ///////////////////////////////////////////////////////////////////////////// +// ========================================================================== +// Declarations +// ========================================================================== + #ifdef __GNUG__ #pragma implementation "socket.h" #endif @@ -22,10 +26,6 @@ #if wxUSE_SOCKETS -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// - #include "wx/app.h" #include "wx/defs.h" #include "wx/object.h" @@ -35,26 +35,50 @@ #include "wx/module.h" #include "wx/log.h" #include "wx/intl.h" +#include "wx/event.h" -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// +#if wxUSE_GUI + #include "wx/gdicmn.h" // for wxPendingDelete +#endif // wxUSE_GUI #include "wx/sckaddr.h" #include "wx/socket.h" +// -------------------------------------------------------------------------- +// macros and constants +// -------------------------------------------------------------------------- + // discard buffer #define MAX_DISCARD_SIZE (10 * 1024) -// what to do within waits -#define PROCESS_EVENTS() wxYield() - -// use wxPostEvent or not -#define EXPERIMENTAL_USE_POST 1 +// what to do within waits: in wxBase we don't do anything as we don't have +// the event loop anyhow (for now). In GUI apps 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 wxWindows) 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_GUI + #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 +#else // !wxUSE_GUI + #define PROCESS_EVENTS() +#endif // wxUSE_GUI/!wxUSE_GUI -// -------------------------------------------------------------- -// ClassInfos -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// wxWin macros +// -------------------------------------------------------------------------- IMPLEMENT_CLASS(wxSocketBase, wxObject) IMPLEMENT_CLASS(wxSocketServer, wxSocketBase) @@ -62,66 +86,182 @@ 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; + wxSocketFlags m_flags; + wxSocketEventFlags m_eventmask; + bool m_notify; + void *m_clientData; +#if WXWIN_COMPATIBILITY wxSocketBase::wxSockCbk m_cbk; char *m_cdata; +#endif // WXWIN_COMPATIBILITY public: wxSocketState() : wxObject() {} }; -// -------------------------------------------------------------- -// 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) +// ========================================================================== +// 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; } -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) +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, _T("extra call to Shutdown()") ); + if ( !--m_countInit ) + { + 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 = 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 = -1; + m_handler = NULL; + m_clientData = NULL; + m_notify = FALSE; + m_eventmask = 0; +#if WXWIN_COMPATIBILITY + m_cbk = NULL; + m_cdata = NULL; +#endif // WXWIN_COMPATIBILITY + + 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. +#if wxUSE_GUI + wxPendingDelete.DeleteObject(this); +#endif // Shutdown and close the socket - Close(); + if (!m_beingDeleted) + Close(); // Destroy the GSocket object if (m_socket) GSocket_destroy(m_socket); + + // Free the pushback buffer + if (m_unread) + free(m_unread); } +bool wxSocketBase::Destroy() +{ + // Delayed destruction: the socket will be deleted during the next + // idle loop iteration. This ensures that all pending events have + // been processed. + m_beingDeleted = TRUE; + + // Shutdown and close the socket + Close(); + + // Supress events from now on + Notify(FALSE); + +#if wxUSE_GUI + if ( !wxPendingDelete.Member(this) ) + wxPendingDelete.Append(this); +#else + delete this; +#endif + + return TRUE; +} + +// -------------------------------------------------------------------------- +// Basic IO calls +// -------------------------------------------------------------------------- + +// The following IO operations update m_error and m_lcount: +// {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard} +// +// TODO: Should Connect, Accept and AcceptWith update m_error? + bool wxSocketBase::Close() { // Interrupt pending waits - InterruptAllWaits(); + InterruptWait(); if (m_socket) { @@ -133,33 +273,12 @@ bool wxSocketBase::Close() GSocket_Shutdown(m_socket); } - m_connected = FALSE; // (GRG) + m_connected = FALSE; m_establishing = FALSE; return TRUE; } -// -------------------------------------------------------------- -// wxSocketBase basic IO operations -// -------------------------------------------------------------- - -// All IO operations {Read, Write, ReadMsg, WriteMsg, Peek, -// Unread, Discard} update m_error and m_lcount. -// -// TODO: Should Connect, Accept and AcceptWith update m_error? - -class _wxSocketInternalTimer: public wxTimer -{ -public: - int *m_state; - unsigned long m_new_val; - - void Notify() - { - *m_state = (int)m_new_val; // Change the value - } -}; - -wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { // Mask read events m_reading = TRUE; @@ -178,7 +297,7 @@ wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) return *this; } -wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes) +wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes) { int total; int ret = 1; @@ -186,60 +305,62 @@ wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes) // Try the pushback buffer first total = GetPushback(buffer, nbytes, FALSE); nbytes -= total; - buffer += total; - - // If the socket is invalid or we got all the data, return now (GRG) - if (!m_socket || !nbytes) + buffer = (char *)buffer + total; + + // Return now in one of the following cases: + // - the socket is invalid, + // - we got all the data, + // - we got *some* data and we are not using wxSOCKET_WAITALL. + if ( !m_socket || + !nbytes || + ((total != 0) && !(m_flags & wxSOCKET_WAITALL)) ) 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 // if (m_flags & wxSOCKET_NOWAIT) { - GSocket_SetNonBlocking(m_socket, TRUE); - ret = GSocket_Read(m_socket, buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); + GSocket_SetNonBlocking(m_socket, 1); + ret = GSocket_Read(m_socket, (char *)buffer, nbytes); + GSocket_SetNonBlocking(m_socket, 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, buffer, nbytes); + ret = GSocket_Read(m_socket, (char *)buffer, nbytes); if (ret > 0) { total += ret; - buffer += ret; nbytes -= ret; + buffer = (char *)buffer + ret; } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForRead()) - { - ret = GSocket_Read(m_socket, 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)); } } return total; } -wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) { wxUint32 len, len2, sig, total; bool error; @@ -258,17 +379,17 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) 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]; + sig = (wxUint32)msg.sig[0]; sig |= (wxUint32)(msg.sig[1] << 8); sig |= (wxUint32)(msg.sig[2] << 16); sig |= (wxUint32)(msg.sig[3] << 24); if (sig != 0xfeeddead) { - wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); goto exit; } @@ -312,7 +433,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]; @@ -322,7 +443,7 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) if (sig != 0xdeadfeed) { - wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); + wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); goto exit; } @@ -338,7 +459,7 @@ exit: return *this; } -wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) { // Mask read events m_reading = TRUE; @@ -358,7 +479,7 @@ wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes) return *this; } -wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { // Mask write events m_writing = TRUE; @@ -377,68 +498,66 @@ wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes) return *this; } -wxUint32 wxSocketBase::_Write(const char *buffer, wxUint32 nbytes) +wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes) { wxUint32 total = 0; int ret = 1; - // If the socket is invalid, return immediately (GRG) - 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 // if (m_flags & wxSOCKET_NOWAIT) { - GSocket_SetNonBlocking(m_socket, TRUE); - ret = GSocket_Write(m_socket, buffer, nbytes); - GSocket_SetNonBlocking(m_socket, FALSE); + GSocket_SetNonBlocking(m_socket, 1); + ret = GSocket_Write(m_socket, (const char *)buffer, nbytes); + GSocket_SetNonBlocking(m_socket, 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, buffer, nbytes); + ret = GSocket_Write(m_socket, (const char *)buffer, nbytes); if (ret > 0) { total += ret; - buffer += ret; nbytes -= ret; + buffer = (const char *)buffer + ret; } - } - } - else - { - if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite()) - { - ret = GSocket_Write(m_socket, 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)); } } 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; @@ -461,7 +580,7 @@ wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, wxUint32 nbytes) 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); @@ -475,7 +594,7 @@ 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 @@ -489,7 +608,7 @@ exit: return *this; } -wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) { if (nbytes != 0) Pushback(buffer, nbytes); @@ -530,137 +649,56 @@ wxSocketBase& wxSocketBase::Discard() 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; -} - - -// -------------------------------------------------------------- -// wxSocketBase Wait functions -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Wait functions +// -------------------------------------------------------------------------- -// 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. +// 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. -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; // Set this to TRUE to interrupt ongoing waits m_interrupt = FALSE; - // Check for valid socket (GRG) + // Check for valid socket if (!m_socket) 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); - } - - // 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) + + wxStopWatch chrono; + bool done = FALSE; + + while (!done) { result = GSocket_Select(m_socket, 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; @@ -669,27 +707,24 @@ bool wxSocketBase::_Wait(long seconds, long milliseconds, // Data available or output buffer ready if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG)) { - timer.Stop(); return TRUE; } // Connection lost if (result & GSOCK_LOST_FLAG) { - timer.Stop(); - m_connected = FALSE; // (GRG) + m_connected = FALSE; m_establishing = FALSE; - return (flags & GSOCK_LOST_FLAG); // (GRG) <--- Maybe here??? + return (flags & GSOCK_LOST_FLAG) != 0; } // Wait more? - if ((timeout == 0) || (m_interrupt)) - break; + if ((!timeout) || (chrono.Time() > timeout) || (m_interrupt)) + done = TRUE; else PROCESS_EVENTS(); } - timer.Stop(); return FALSE; } @@ -703,11 +738,17 @@ bool wxSocketBase::Wait(long seconds, long milliseconds) bool wxSocketBase::WaitForRead(long seconds, long milliseconds) { - // Check pushback buffer + // Check pushback buffer before entering _Wait if (m_unread) return TRUE; - return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG); + // Note that GSOCK_INPUT_LOST has to be explicitly passed to + // _Wait becuase of the semantics of WaitForRead: a return + // value of TRUE means that a GSocket_Read call will return + // immediately, not that there is actually data to read. + + return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | + GSOCK_LOST_FLAG); } bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) @@ -720,6 +761,92 @@ bool wxSocketBase::WaitForLost(long seconds, long milliseconds) return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG); } +// -------------------------------------------------------------------------- +// Miscellaneous +// -------------------------------------------------------------------------- + +// +// Get local or peer address +// + +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; +} + +// +// Save and restore socket state +// + +void wxSocketBase::SaveState() +{ + wxSocketState *state; + + state = new wxSocketState(); + + state->m_flags = m_flags; + state->m_notify = m_notify; + state->m_eventmask = m_eventmask; + state->m_clientData = m_clientData; +#if WXWIN_COMPATIBILITY + state->m_cbk = m_cbk; + state->m_cdata = m_cdata; +#endif // WXWIN_COMPATIBILITY + + m_states.Append(state); +} + +void wxSocketBase::RestoreState() +{ + wxNode *node; + wxSocketState *state; + + node = m_states.Last(); + if (!node) + return; + + state = (wxSocketState *)node->Data(); + + m_flags = state->m_flags; + m_notify = state->m_notify; + m_eventmask = state->m_eventmask; + m_clientData = state->m_clientData; +#if WXWIN_COMPATIBILITY + m_cbk = state->m_cbk; + m_cdata = state->m_cdata; +#endif // WXWIN_COMPATIBILITY + + delete node; + delete state; +} + +// +// Timeout and flags +// + void wxSocketBase::SetTimeout(long seconds) { m_timeout = seconds; @@ -728,18 +855,17 @@ void wxSocketBase::SetTimeout(long seconds) GSocket_SetTimeout(m_socket, m_timeout * 1000); } -// -------------------------------------------------------------- -// wxSocketBase flags -// -------------------------------------------------------------- - -void wxSocketBase::SetFlags(wxSockFlags _flags) +void wxSocketBase::SetFlags(wxSocketFlags flags) { - m_flags = _flags; + m_flags = flags; } -// -------------------------------------------------------------- -// wxSocketBase callback management -// -------------------------------------------------------------- + +// -------------------------------------------------------------------------- +// Callbacks (now obsolete - use events instead) +// -------------------------------------------------------------------------- + +#if WXWIN_COMPATIBILITY wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) { @@ -757,55 +883,48 @@ char *wxSocketBase::CallbackData(char *data) return old_data; } -// -------------------------------------------------------------- -// wxSocketBase automatic notifier -// -------------------------------------------------------------- +#endif // WXWIN_COMPATIBILITY -// All events (INPUT, OUTPUT, CONNECTION, LOST) are now always -// internally watched; but users will only be notified of those -// events they are interested in. +// -------------------------------------------------------------------------- +// Event handling +// -------------------------------------------------------------------------- -static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), - GSocketEvent event, 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; - sckobj->OnRequest((wxSocketNotify)event); -} - -wxSocketEventFlags wxSocketBase::EventToNotify(wxSocketNotify evt) -{ - switch (evt) - { - case GSOCK_INPUT: return GSOCK_INPUT_FLAG; - case GSOCK_OUTPUT: return GSOCK_OUTPUT_FLAG; - case GSOCK_CONNECTION: return GSOCK_CONNECTION_FLAG; - case GSOCK_LOST: return GSOCK_LOST_FLAG; - } - return 0; + sckobj->OnRequest((wxSocketNotify) notification); } -void wxSocketBase::SetNotify(wxSocketEventFlags flags) +void wxSocketBase::OnRequest(wxSocketNotify notification) { - m_neededreq = flags; -} + // 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. -void wxSocketBase::Notify(bool notify) -{ - m_notify_state = notify; -} - -void wxSocketBase::OnRequest(wxSocketNotify req_evt) -{ - wxSocketEvent event(m_id); - wxSocketEventFlags flag = EventToNotify(req_evt); - - // This duplicates some code in _Wait(), but this doesn't - // hurt. It has to be here because we don't know whether - // WaitXXX will be used, and it has to be in _Wait as well - // because the event might be a bit delayed. - // - switch(req_evt) + switch(notification) { case wxSOCKET_CONNECTION: m_establishing = FALSE; @@ -815,7 +934,7 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt) // If we are in the middle of a R/W operation, do not // propagate events to users. Also, filter 'late' events // which are no longer valid. - // + case wxSOCKET_INPUT: if (m_reading || !GSocket_Select(m_socket, GSOCK_INPUT_FLAG)) return; @@ -835,56 +954,71 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt) break; } - if (((m_neededreq & flag) == flag) && m_notify_state) + // Schedule the event + + wxSocketEventFlags flag = 0; + switch (notification) { - event.m_socket = this; - event.m_skevt = req_evt; + 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_evt_handler) -#if EXPERIMENTAL_USE_POST - wxPostEvent(m_evt_handler, event); -#else - ProcessEvent(event); -#endif + if (((m_eventmask & flag) == flag) && m_notify) + { + if (m_handler) + { + wxSocketEvent event(m_id); + event.m_event = notification; + event.m_clientData = m_clientData; + event.SetEventObject(this); - OldOnNotify(req_evt); + m_handler->AddPendingEvent(event); + } + +#if WXWIN_COMPATIBILITY if (m_cbk) - m_cbk(*this, req_evt, m_cdata); + m_cbk(*this, notification, m_cdata); +#endif // WXWIN_COMPATIBILITY } } -void wxSocketBase::OldOnNotify(wxSocketNotify WXUNUSED(evt)) +void wxSocketBase::Notify(bool notify) { + m_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; @@ -895,7 +1029,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; @@ -903,7 +1037,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) { @@ -920,17 +1054,18 @@ 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) + wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_SERVER) { // Create the socket m_socket = GSocket_new(); @@ -954,9 +1089,9 @@ wxSocketServer::wxSocketServer(wxSockAddress& addr_man, } -// -------------------------------------------------------------- -// wxSocketServer Accept -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Accept +// -------------------------------------------------------------------------- bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { @@ -970,17 +1105,17 @@ bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) // again. if (!wait) - GSocket_SetNonBlocking(m_socket, TRUE); + GSocket_SetNonBlocking(m_socket, 1); child_socket = GSocket_WaitConnection(m_socket); if (!wait) - GSocket_SetNonBlocking(m_socket, FALSE); + GSocket_SetNonBlocking(m_socket, 0); if (!child_socket) return FALSE; - sock.m_type = SOCK_INTERNAL; + sock.m_type = wxSOCKET_BASE; sock.m_socket = child_socket; sock.m_connected = TRUE; @@ -996,10 +1131,13 @@ 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; } @@ -1009,16 +1147,16 @@ bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); } -// -------------------------------------------------------------- +// ========================================================================== // wxSocketClient -// -------------------------------------------------------------- +// ========================================================================== -// -------------------------------------------------------------- -// wxSocketClient ctor and dtor -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) : - wxSocketBase(_flags, SOCK_CLIENT) +wxSocketClient::wxSocketClient(wxSocketFlags flags) + : wxSocketBase(flags, wxSOCKET_CLIENT) { } @@ -1026,15 +1164,15 @@ wxSocketClient::~wxSocketClient() { } -// -------------------------------------------------------------- -// wxSocketClient Connect functions -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Connect +// -------------------------------------------------------------------------- bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) { GSocketError err; - if (m_socket) // (GRG) + if (m_socket) { // Shutdown and destroy the socket Close(); @@ -1058,13 +1196,13 @@ bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) // again. if (!wait) - GSocket_SetNonBlocking(m_socket, TRUE); + GSocket_SetNonBlocking(m_socket, 1); GSocket_SetPeer(m_socket, addr_man.GetAddress()); err = GSocket_Connect(m_socket, GSOCK_STREAMED); if (!wait) - GSocket_SetNonBlocking(m_socket, FALSE); + GSocket_SetNonBlocking(m_socket, 0); if (err != GSOCK_NOERROR) { @@ -1086,17 +1224,19 @@ bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) 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( wxSockAddress& addr, + wxSocketFlags flags ) + : wxSocketBase( flags, wxSOCKET_DATAGRAM ) { // Create the socket m_socket = GSocket_new(); @@ -1124,7 +1264,7 @@ wxDatagramSocket::wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags ) } wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, - char* buf, + void* buf, wxUint32 nBytes ) { Read(buf, nBytes); @@ -1133,7 +1273,7 @@ wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, } wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr, - const char* buf, + const void* buf, wxUint32 nBytes ) { GSocket_SetPeer(m_socket, addr.GetAddress()); @@ -1141,41 +1281,27 @@ wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr, return (*this); } -// -------------------------------------------------------------- -// wxSocketEvent -// -------------------------------------------------------------- - -// XXX: Should be moved to event.cpp ? - -wxSocketEvent::wxSocketEvent(int id) - : wxEvent(id) -{ - wxEventType type = (wxEventType)wxEVT_SOCKET; - - SetEventType(type); -} - -void wxSocketEvent::CopyObject(wxObject& obj_d) const -{ - wxSocketEvent *event = (wxSocketEvent *)&obj_d; - - wxEvent::CopyObject(obj_d); - - event->m_skevt = m_skevt; - event->m_socket = m_socket; -} - -// -------------------------------------------------------------------------- +// ========================================================================== // wxSocketModule -// -------------------------------------------------------------------------- +// ========================================================================== -class WXDLLEXPORT wxSocketModule: public wxModule +class WXDLLEXPORT 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)