initialize m_initialized to false to avoid spurious asserts

[wxWidgets.git] / src / common / socket.cpp

diff --git a/src/common/socket.cpp b/src/common/socket.cpp
index ffa094fcb53e78873a927e06080e48f45dccf0b2..6e40e90f9132f80f44ecf2834cbfcd8267f813e9 100644 (file)
--- a/src/common/socket.cpp
+++ b/src/common/socket.cpp
@@ -6,10 +6,14 @@
 // Copyright:  (C) 1999-1997, Guilhem Lavaux
 //             (C) 2000-1999, Guillermo Rodriguez Garcia
 // RCS_ID:     $Id$
 // Copyright:  (C) 1999-1997, Guilhem Lavaux
 //             (C) 2000-1999, Guillermo Rodriguez Garcia
 // RCS_ID:     $Id$

-// License:    see wxWindows license
+// License:    see wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
+// ==========================================================================
+// Declarations
+// ==========================================================================
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma implementation "socket.h"
 #endif
 
 #pragma implementation "socket.h"
 #endif
 


@@ -22,11 +26,8 @@
 
 #if wxUSE_SOCKETS
 
 
 #if wxUSE_SOCKETS
 

-// ==========================================================================
-// Headers and constants
-// ==========================================================================
-

 #include "wx/app.h"
 #include "wx/app.h"

+#include "wx/apptrait.h"

 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"


@@ -37,30 +38,43 @@
 #include "wx/intl.h"
 #include "wx/event.h"
 
 #include "wx/intl.h"
 #include "wx/event.h"
 

-#if wxUSE_GUI
-  #include "wx/gdicmn.h"      // for wxPendingDelete
-#endif // wxUSE_GUI
-

 #include "wx/sckaddr.h"
 #include "wx/socket.h"
 
 #include "wx/sckaddr.h"
 #include "wx/socket.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)
 
 
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 

-// what to do within waits
-#if wxUSE_GUI
-  #define PROCESS_EVENTS() wxYield()
-#else
-  #define PROCESS_EVENTS()
-#endif
-
-// use wxPostEvent or not
-#define USE_DELAYED_EVENTS 1
+// what to do within waits: we have 2 cases: from the main thread itself we
+// have to call wxYield() to let the events (including the GUI events and the
+// low-level (not 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_THREADS
+    #define PROCESS_EVENTS()        \
+    {                               \
+        if ( wxThread::IsMain() )   \
+            wxYield();              \
+        else                        \
+            wxThread::Yield();      \
+    }
+#else // !wxUSE_THREADS
+    #define PROCESS_EVENTS() wxYield()
+#endif // wxUSE_THREADS/!wxUSE_THREADS

 
 

+#define wxTRACE_Socket _T("wxSocket")

 
 // --------------------------------------------------------------------------
 
 // --------------------------------------------------------------------------

-// ClassInfos
+// wxWin macros

 // --------------------------------------------------------------------------
 
 IMPLEMENT_CLASS(wxSocketBase, wxObject)
 // --------------------------------------------------------------------------
 
 IMPLEMENT_CLASS(wxSocketBase, wxObject)


@@ -69,24 +83,72 @@ IMPLEMENT_CLASS(wxSocketClient, wxSocketBase)
 IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase)
 IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
 
 IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase)
 IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
 

+// --------------------------------------------------------------------------
+// private classes
+// --------------------------------------------------------------------------
+

 class wxSocketState : public wxObject
 {
 public:
 class wxSocketState : public wxObject
 {
 public:

-  bool                     m_notify_state;
-  wxSocketEventFlags       m_neededreq;

   wxSocketFlags            m_flags;
   wxSocketFlags            m_flags;

-  wxSocketBase::wxSockCbk  m_cbk;
-  char                    *m_cdata;
+  wxSocketEventFlags       m_eventmask;
+  bool                     m_notify;
+  void                    *m_clientData;

 
 public:
   wxSocketState() : wxObject() {}
 
 public:
   wxSocketState() : wxObject() {}

-};

 
 

+    DECLARE_NO_COPY_CLASS(wxSocketState)
+};

 
 // ==========================================================================
 // wxSocketBase
 // ==========================================================================
 
 
 // ==========================================================================
 // 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++ )
+    {
+        wxAppTraits *traits = wxAppConsole::GetInstance() ?
+                              wxAppConsole::GetInstance()->GetTraits() : NULL;
+        GSocketGUIFunctionsTable *functions = 
+            traits ? traits->GetSocketGUIFunctionsTable() : NULL;
+        GSocket_SetGUIFunctions(functions);
+        
+        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
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // Ctor and dtor
 // --------------------------------------------------------------------------


@@ -116,10 +178,15 @@ void wxSocketBase::Init()
   m_id           = -1;
   m_handler      = NULL;
   m_clientData   = NULL;
   m_id           = -1;
   m_handler      = NULL;
   m_clientData   = NULL;

-  m_notify_state = FALSE;
-  m_neededreq    = 0;
-  m_cbk          = NULL;
-  m_cdata        = NULL;
+  m_notify       = FALSE;
+  m_eventmask    = 0;
+
+  if ( !IsInitialized() )
+  {
+      // this Initialize() will be undone by wxSocketModule::OnExit(), all the
+      // other calls to it should be matched by a call to Shutdown()
+      Initialize();
+  }

 }
 
 wxSocketBase::wxSocketBase()
 }
 
 wxSocketBase::wxSocketBase()


@@ -139,9 +206,9 @@ wxSocketBase::~wxSocketBase()
 {
   // Just in case the app called Destroy() *and* then deleted
   // the socket immediately: don't leave dangling pointers.
 {
   // Just in case the app called Destroy() *and* then deleted
   // the socket immediately: don't leave dangling pointers.

-#if wxUSE_GUI
-  wxPendingDelete.DeleteObject(this);
-#endif
+  wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+  if ( traits )
+      traits->RemoveFromPendingDelete(this);

 
   // Shutdown and close the socket
   if (!m_beingDeleted)
 
   // Shutdown and close the socket
   if (!m_beingDeleted)


@@ -166,19 +233,27 @@ bool wxSocketBase::Destroy()
   // Shutdown and close the socket
   Close();
 
   // Shutdown and close the socket
   Close();
 

-#if wxUSE_GUI
-  if ( wxPendingDelete.Member(this) )
-      wxPendingDelete.Append(this);
-#else
-  delete this;
-#endif
+  // Supress events from now on
+  Notify(FALSE);
+
+  // 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;
 }
 

-

 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------

-// Basic IO operations
+// Basic IO calls

 // --------------------------------------------------------------------------
 
 // The following IO operations update m_error and m_lcount:
 // --------------------------------------------------------------------------
 
 // The following IO operations update m_error and m_lcount:


@@ -189,7 +264,7 @@ bool wxSocketBase::Destroy()
 bool wxSocketBase::Close()
 {
   // Interrupt pending waits
 bool wxSocketBase::Close()
 {
   // Interrupt pending waits

-  InterruptAllWaits();
+  InterruptWait();

 
   if (m_socket)
   {
 
   if (m_socket)
   {


@@ -228,39 +303,45 @@ wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
 wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
 {
   int total;
 wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
 {
   int total;

-  int ret = 1;

 
   // Try the pushback buffer first
   total = GetPushback(buffer, nbytes, FALSE);
   nbytes -= total;
   buffer  = (char *)buffer + total;
 
 
   // Try the pushback buffer first
   total = GetPushback(buffer, nbytes, FALSE);
   nbytes -= total;
   buffer  = (char *)buffer + total;
 

-  // If the socket is invalid or we got all the data, return now
-  if (!m_socket || !nbytes)
+  // Return now in one of the following cases:
+  // - the socket is invalid,
+  // - we got all the data,
+  // - 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
     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
   //
   // wxSOCKET_BLOCK
   // wxSOCKET_NONE
   //

+  int ret;

   if (m_flags & wxSOCKET_NOWAIT)
   {
   if (m_flags & wxSOCKET_NOWAIT)
   {

-    GSocket_SetNonBlocking(m_socket, TRUE);
+    GSocket_SetNonBlocking(m_socket, 1);

     ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
     ret = GSocket_Read(m_socket, (char *)buffer, nbytes);

-    GSocket_SetNonBlocking(m_socket, FALSE);
+    GSocket_SetNonBlocking(m_socket, 0);

 
     if (ret > 0)
       total += ret;
   }
 
     if (ret > 0)
       total += ret;
   }

-  else if (m_flags & wxSOCKET_WAITALL)
+  else

   {
   {

-    while (ret > 0 && nbytes > 0)
+    bool more = TRUE;
+
+    while (more)

     {
     {

-      if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead())
-          break;
+      if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() )
+        break;

 
       ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
 
 
       ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
 


@@ -270,16 +351,12 @@ wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
         nbytes -= ret;
         buffer  = (char *)buffer + ret;
       }
         nbytes -= ret;
         buffer  = (char *)buffer + ret;
       }

-    }
-  }
-  else
-  {
-    if ((m_flags & wxSOCKET_BLOCK) || WaitForRead())
-    {
-      ret = GSocket_Read(m_socket, (char *)buffer, nbytes);

 
 

-      if (ret > 0)
-        total += ret;
+      // If we got here and wxSOCKET_WAITALL is not set, we can leave
+      // now. Otherwise, wait until we recv all the data or until there
+      // is an error.
+      //
+      more = (ret > 0 && nbytes > 0 && (m_flags & wxSOCKET_WAITALL));

     }
   }
 
     }
   }
 


@@ -315,7 +392,7 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
 
   if (sig != 0xfeeddead)
   {
 
   if (sig != 0xfeeddead)
   {

-    wxLogWarning( _("wxSocket: invalid signature in ReadMsg."));
+    wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));

     goto exit;
   }
 
     goto exit;
   }
 


@@ -369,7 +446,7 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
 
   if (sig != 0xdeadfeed)
   {
 
   if (sig != 0xdeadfeed)
   {

-    wxLogWarning( _("wxSocket: invalid signature in ReadMsg."));
+    wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));

     goto exit;
   }
 
     goto exit;
   }
 


@@ -427,34 +504,35 @@ wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
 wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
 {
   wxUint32 total = 0;
 wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
 {
   wxUint32 total = 0;

-  int ret = 1;

 
 

-  // If the socket is invalid, return immediately
-  if (!m_socket)
+  // If the socket is invalid or parameters are ill, return immediately
+  if (!m_socket || !buffer || !nbytes)

     return 0;
 
   // Possible combinations (they are checked in this order)
   // wxSOCKET_NOWAIT
     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
   //
   // wxSOCKET_BLOCK
   // wxSOCKET_NONE
   //

+  int ret;

   if (m_flags & wxSOCKET_NOWAIT)
   {
   if (m_flags & wxSOCKET_NOWAIT)
   {

-    GSocket_SetNonBlocking(m_socket, TRUE);
+    GSocket_SetNonBlocking(m_socket, 1);

     ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);
     ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);

-    GSocket_SetNonBlocking(m_socket, FALSE);
+    GSocket_SetNonBlocking(m_socket, 0);

 
     if (ret > 0)
       total = ret;
   }
 
     if (ret > 0)
       total = ret;
   }

-  else if (m_flags & wxSOCKET_WAITALL)
+  else

   {
   {

-    while (ret > 0 && nbytes > 0)
+    bool more = TRUE;
+
+    while (more)

     {
     {

-      if (!(m_flags & wxSOCKET_BLOCK) && !WaitForWrite())
-          break;
+      if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
+        break;

 
       ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);
 
 
       ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);
 


@@ -464,16 +542,12 @@ wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
         nbytes -= ret;
         buffer  = (const char *)buffer + ret;
       }
         nbytes -= ret;
         buffer  = (const char *)buffer + ret;
       }

-    }
-  }
-  else
-  {
-    if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite())
-    {
-      ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);

 
 

-      if (ret > 0)
-        total = ret;
+      // If we got here and wxSOCKET_WAITALL is not set, we can leave
+      // now. Otherwise, wait until we send all the data or until there
+      // is an error.
+      //
+      more = (ret > 0 && nbytes > 0 && (m_flags & wxSOCKET_WAITALL));

     }
   }
 
     }
   }
 


@@ -484,7 +558,6 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
 {
   wxUint32 total;
   bool error;
 {
   wxUint32 total;
   bool error;

-  int old_flags;

   struct
   {
     unsigned char sig[4];
   struct
   {
     unsigned char sig[4];


@@ -496,7 +569,6 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
 
   error = TRUE;
   total = 0;
 
   error = TRUE;
   total = 0;

-  old_flags = m_flags;

   SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
 
   msg.sig[0] = (unsigned char) 0xad;
   SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
 
   msg.sig[0] = (unsigned char) 0xad;


@@ -550,7 +622,6 @@ wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
 
 wxSocketBase& wxSocketBase::Discard()
 {
 
 wxSocketBase& wxSocketBase::Discard()
 {

-  int old_flags;

   char *buffer = new char[MAX_DISCARD_SIZE];
   wxUint32 ret;
   wxUint32 total = 0;
   char *buffer = new char[MAX_DISCARD_SIZE];
   wxUint32 ret;
   wxUint32 total = 0;


@@ -558,7 +629,6 @@ wxSocketBase& wxSocketBase::Discard()
   // Mask read events
   m_reading = TRUE;
 
   // Mask read events
   m_reading = TRUE;
 

-  old_flags = m_flags;

   SetFlags(wxSOCKET_NOWAIT);
 
   do
   SetFlags(wxSOCKET_NOWAIT);
 
   do


@@ -588,7 +658,8 @@ wxSocketBase& wxSocketBase::Discard()
 // timeout elapses. The polling loop calls PROCESS_EVENTS(), so
 // this won't block the GUI.
 
 // 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;
                          wxSocketEventFlags flags)
 {
   GSocketEventFlags result;


@@ -607,14 +678,16 @@ bool wxSocketBase::_Wait(long seconds, long milliseconds,
   else
     timeout = m_timeout * 1000;
 
   else
     timeout = m_timeout * 1000;
 

-  // Active polling (without using events)
+#if !defined(wxUSE_GUI) || !wxUSE_GUI
+  GSocket_SetTimeout(m_socket, timeout);
+#endif 
+
+  // Wait in an active polling loop.

   //
   //

-  // NOTE: this duplicates some of the code in OnRequest (lost
-  //   connection and connection establishment handling) but
-  //   this doesn't hurt. It has to be here because the event
-  //   might be a bit delayed, and it has to be in OnRequest
-  //   as well because maybe the Wait functions are not being
-  //   used.
+  // NOTE: We duplicate some of the code in OnRequest, but this doesn't
+  //   hurt. It has to be here because the (GSocket) event might arrive
+  //   a bit delayed, and it has to be in OnRequest as well because we
+  //   don't know whether the Wait functions are being used.

   //
   // Do this at least once (important if timeout == 0, when
   // we are just polling). Also, if just polling, do not yield.
   //
   // Do this at least once (important if timeout == 0, when
   // we are just polling). Also, if just polling, do not yield.


@@ -645,7 +718,7 @@ bool wxSocketBase::_Wait(long seconds, long milliseconds,
     {
       m_connected = FALSE;
       m_establishing = FALSE;
     {
       m_connected = FALSE;
       m_establishing = FALSE;

-      return (flags & GSOCK_LOST_FLAG);
+      return (flags & GSOCK_LOST_FLAG) != 0;

     }
 
     // Wait more?
     }
 
     // Wait more?


@@ -707,6 +780,12 @@ bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
     return FALSE;
 
   peer = GSocket_GetPeer(m_socket);
     return FALSE;
 
   peer = GSocket_GetPeer(m_socket);

+
+    // copying a null address would just trigger an assert anyway
+
+  if (!peer)
+    return FALSE;
+

   addr_man.SetAddress(peer);
   GAddress_destroy(peer);
 
   addr_man.SetAddress(peer);
   GAddress_destroy(peer);
 


@@ -737,33 +816,31 @@ void wxSocketBase::SaveState()
 
   state = new wxSocketState();
 
 
   state = new wxSocketState();
 

-  state->m_notify_state = m_notify_state;
-  state->m_neededreq    = m_neededreq;
-  state->m_flags        = m_flags;
-  state->m_cbk          = m_cbk;
-  state->m_cdata        = m_cdata;
+  state->m_flags      = m_flags;
+  state->m_notify     = m_notify;
+  state->m_eventmask  = m_eventmask;
+  state->m_clientData = m_clientData;

 
   m_states.Append(state);
 }
 
 void wxSocketBase::RestoreState()
 {
 
   m_states.Append(state);
 }
 
 void wxSocketBase::RestoreState()
 {

-  wxNode *node;
+  wxList::compatibility_iterator node;

   wxSocketState *state;
 
   wxSocketState *state;
 

-  node = m_states.Last();
+  node = m_states.GetLast();

   if (!node)
     return;
 
   if (!node)
     return;
 

-  state = (wxSocketState *)node->Data();
+  state = (wxSocketState *)node->GetData();

 
 

-  SetFlags(state->m_flags);
-  m_cbk       = state->m_cbk;
-  m_cdata     = state->m_cdata;
-  m_neededreq = state->m_neededreq;
-  Notify(state->m_notify_state);
-
-  delete node;
+  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;
 }
 
   delete state;
 }
 


@@ -785,51 +862,46 @@ void wxSocketBase::SetFlags(wxSocketFlags flags)
 }
 
 
 }
 
 

-// --------------------------------------------------------------------------
-// Callbacks (now obsolete - use events instead)
-// --------------------------------------------------------------------------
-
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
-{
-  wxSockCbk old_cbk = cbk_;
-
-  m_cbk = cbk_;
-  return old_cbk;
-}
-
-char *wxSocketBase::CallbackData(char *data)
-{
-  char *old_data = m_cdata;
-
-  m_cdata = data;
-  return old_data;
-}
-

 // --------------------------------------------------------------------------
 // Event handling
 // --------------------------------------------------------------------------
 
 // --------------------------------------------------------------------------
 // Event handling
 // --------------------------------------------------------------------------
 

-// Callback function from GSocket. All events are internally
-// monitored, but users only get these they are interested in.
-
-static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
-                                           GSocketEvent notify,
-                                           char *cdata)
+// A note on how events are processed, which is probably the most
+// difficult thing to get working right while keeping the same API
+// and functionality for all platforms.
+//
+// When GSocket detects an event, it calls wx_socket_callback, which in
+// turn just calls wxSocketBase::OnRequest in the corresponding wxSocket
+// object. OnRequest does some housekeeping, and if the event is to be
+// propagated to the user, it creates a new wxSocketEvent object and
+// posts it. The event is not processed immediately, but delayed with
+// AddPendingEvent instead. This is necessary in order to decouple the
+// event processing from wx_socket_callback; otherwise, subsequent IO
+// calls made from the user event handler would fail, as gtk callbacks
+// are not reentrant.
+//
+// Note that, unlike events, user callbacks (now deprecated) are _not_
+// decoupled from wx_socket_callback and thus they suffer from a variety
+// of problems. Avoid them where possible and use events instead.
+
+extern "C"
+void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
+                                    GSocketEvent notification,
+                                    char *cdata)

 {
   wxSocketBase *sckobj = (wxSocketBase *)cdata;
 
 {
   wxSocketBase *sckobj = (wxSocketBase *)cdata;
 

-  sckobj->OnRequest((wxSocketNotify) notify);
+  sckobj->OnRequest((wxSocketNotify) notification);

 }
 
 }
 

-
-void wxSocketBase::OnRequest(wxSocketNotify req_evt)
+void wxSocketBase::OnRequest(wxSocketNotify notification)

 {
 {

-  // This duplicates some code in _Wait, but this doesn't
-  // hurt. It has to be here because we don't know whether
-  // the Wait functions will be used, and it has to be in
-  // _Wait as well because the event might be a bit delayed.
+  // NOTE: We duplicate some of the code in _Wait, but this doesn't
+  //   hurt. It has to be here because the (GSocket) event might arrive
+  //   a bit delayed, and it has to be in _Wait as well because we don't
+  //   know whether the Wait functions are being used.

 
 

-  switch(req_evt)
+  switch(notification)

   {
     case wxSOCKET_CONNECTION:
       m_establishing = FALSE;
   {
     case wxSOCKET_CONNECTION:
       m_establishing = FALSE;


@@ -861,43 +933,41 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt)
 
   // Schedule the event
 
 
   // Schedule the event
 

-  wxSocketEventFlags flag = -1;
-  switch (req_evt)
+  wxSocketEventFlags flag = 0;
+  wxUnusedVar(flag);
+  switch (notification)

   {
     case GSOCK_INPUT:      flag = GSOCK_INPUT_FLAG; break;
     case GSOCK_OUTPUT:     flag = GSOCK_OUTPUT_FLAG; break;
     case GSOCK_CONNECTION: flag = GSOCK_CONNECTION_FLAG; break;
     case GSOCK_LOST:       flag = GSOCK_LOST_FLAG; break;
   {
     case GSOCK_INPUT:      flag = GSOCK_INPUT_FLAG; break;
     case GSOCK_OUTPUT:     flag = GSOCK_OUTPUT_FLAG; break;
     case GSOCK_CONNECTION: flag = GSOCK_CONNECTION_FLAG; break;
     case GSOCK_LOST:       flag = GSOCK_LOST_FLAG; break;

+    default:
+      wxLogWarning(_("wxSocket: unknown event!."));
+      return;

   }
 
   }
 

-  if (((m_neededreq & flag) == flag) && m_notify_state)
+  if (((m_eventmask & flag) == flag) && m_notify)

   {
   {

-    wxSocketEvent event(m_id);
-
-    event.m_event      = req_evt;
-    event.m_clientData = m_clientData;
-    event.SetEventObject(this);
-

     if (m_handler)
     if (m_handler)

-#if USE_DELAYED_EVENTS
-      m_handler->AddPendingEvent(event);
-#else
-      m_handler->ProcessEvent(event);
-#endif
+    {
+      wxSocketEvent event(m_id);
+      event.m_event      = notification;
+      event.m_clientData = m_clientData;
+      event.SetEventObject(this);

 
 

-    if (m_cbk)
-      m_cbk(*this, req_evt, m_cdata);
+      m_handler->AddPendingEvent(event);
+    }

   }
 }
 
 void wxSocketBase::Notify(bool notify)
 {
   }
 }
 
 void wxSocketBase::Notify(bool notify)
 {

-  m_notify_state = notify;
+  m_notify = notify;

 }
 
 void wxSocketBase::SetNotify(wxSocketEventFlags flags)
 {
 }
 
 void wxSocketBase::SetNotify(wxSocketEventFlags flags)
 {

-  m_neededreq = flags;
+  m_eventmask = flags;

 }
 
 void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
 }
 
 void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)


@@ -906,7 +976,6 @@ void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
   m_id      = id;
 }
 
   m_id      = id;
 }
 

-

 // --------------------------------------------------------------------------
 // Pushback buffer
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // Pushback buffer
 // --------------------------------------------------------------------------


@@ -960,7 +1029,7 @@ wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek)
 
 
 // ==========================================================================
 
 
 // ==========================================================================

-// wxSocketServer                             
+// wxSocketServer

 // ==========================================================================
 
 // --------------------------------------------------------------------------
 // ==========================================================================
 
 // --------------------------------------------------------------------------


@@ -971,26 +1040,32 @@ wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
                                wxSocketFlags flags)
               : wxSocketBase(flags, wxSOCKET_SERVER)
 {
                                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
+
+    GSocket_SetLocal(m_socket, addr_man.GetAddress());
+    if (GSocket_SetServer(m_socket) != GSOCK_NOERROR)
+    {
+        GSocket_destroy(m_socket);
+        m_socket = NULL;

 
 

+        wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer 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);

 }
 
 // --------------------------------------------------------------------------
 }
 
 // --------------------------------------------------------------------------


@@ -1009,12 +1084,12 @@ bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
   // again.
 
   if (!wait)
   // again.
 
   if (!wait)

-    GSocket_SetNonBlocking(m_socket, TRUE);
+    GSocket_SetNonBlocking(m_socket, 1);

 
   child_socket = GSocket_WaitConnection(m_socket);
 
   if (!wait)
 
   child_socket = GSocket_WaitConnection(m_socket);
 
   if (!wait)

-    GSocket_SetNonBlocking(m_socket, FALSE);
+    GSocket_SetNonBlocking(m_socket, 0);

 
   if (!child_socket)
     return FALSE;
 
   if (!child_socket)
     return FALSE;


@@ -1038,7 +1113,10 @@ wxSocketBase *wxSocketServer::Accept(bool wait)
   sock->SetFlags(m_flags);
 
   if (!AcceptWith(*sock, wait))
   sock->SetFlags(m_flags);
 
   if (!AcceptWith(*sock, wait))

-    return NULL;
+  {
+    sock->Destroy();
+    sock = NULL;
+  }

 
   return sock;
 }
 
   return sock;
 }


@@ -1097,13 +1175,13 @@ bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait)
   // again.
 
   if (!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_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)
   {
 
   if (err != GSOCK_NOERROR)
   {


@@ -1182,40 +1260,32 @@ wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr,
     return (*this);
 }
 
     return (*this);
 }
 

-// ==========================================================================
-// wxSocketEvent
-// ==========================================================================
-
-wxSocketEvent::wxSocketEvent(int id) : wxEvent(id)
-{
-  SetEventType( (wxEventType)wxEVT_SOCKET );
-}
-
-void wxSocketEvent::CopyObject(wxObject& object_dest) const
-{
-  wxSocketEvent *event = (wxSocketEvent *)&object_dest;
-
-  wxEvent::CopyObject(object_dest);
-
-  event->m_event      = m_event;
-  event->m_clientData = m_clientData;
-}
-
-

 // ==========================================================================
 // wxSocketModule
 // ==========================================================================
 
 // ==========================================================================
 // wxSocketModule
 // ==========================================================================
 

-class WXDLLEXPORT wxSocketModule: public wxModule
+class wxSocketModule : public wxModule

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxSocketModule)
-

 public:
 public:

-  bool OnInit() { return GSocket_Init(); }
-  void OnExit() { GSocket_Cleanup(); }
+    virtual bool OnInit()
+    {
+        // wxSocketBase will call GSocket_Init() itself when/if needed
+        return TRUE;
+    }
+
+    virtual void OnExit()
+    {
+        if ( wxSocketBase::IsInitialized() )
+            wxSocketBase::Shutdown();
+    }
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxSocketModule)

 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
 
 #endif
   // wxUSE_SOCKETS
 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
 
 #endif
   // wxUSE_SOCKETS

+
+// vi:sts=4:sw=4:et