replaced C++ comments with C ones

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

diff --git a/src/common/socket.cpp b/src/common/socket.cpp
index a38097d124f7d72a05c00f99fa744295e25fa0c2..7ec0743ec109a5a7ad75c44cd1dca9ba881248a2 100644 (file)
--- a/src/common/socket.cpp
+++ b/src/common/socket.cpp
@@ -51,12 +51,30 @@
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 

-// what to do within waits
+// 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_GUI

-  #define PROCESS_EVENTS() wxYield()
-#else
-  #define PROCESS_EVENTS()
-#endif
+    #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

 
 // --------------------------------------------------------------------------
 // wxWin macros
 
 // --------------------------------------------------------------------------
 // wxWin macros


@@ -244,32 +262,38 @@ wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
   nbytes -= total;
   buffer  = (char *)buffer + total;
 
   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
   //
   if (m_flags & wxSOCKET_NOWAIT)
   {
   // wxSOCKET_BLOCK
   // wxSOCKET_NONE
   //
   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);
 


@@ -279,16 +303,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));

     }
   }
 
     }
   }
 


@@ -324,7 +344,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;
   }
 


@@ -378,7 +398,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;
   }
 


@@ -438,32 +458,33 @@ wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
   wxUint32 total = 0;
   int ret = 1;
 
   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
   //
   if (m_flags & wxSOCKET_NOWAIT)
   {
   // wxSOCKET_BLOCK
   // wxSOCKET_NONE
   //
   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);
 


@@ -473,16 +494,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));

     }
   }
 
     }
   }
 


@@ -653,7 +670,7 @@ bool wxSocketBase::_Wait(long seconds,
     {
       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?


@@ -893,13 +910,16 @@ void wxSocketBase::OnRequest(wxSocketNotify notification)
 
   // Schedule the event
 
 
   // Schedule the event
 

-  wxSocketEventFlags flag = -1;
+  wxSocketEventFlags flag = 0;

   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;
   switch (notification)
   {
     case GSOCK_INPUT:      flag = GSOCK_INPUT_FLAG; break;
     case GSOCK_OUTPUT:     flag = GSOCK_OUTPUT_FLAG; break;
     case GSOCK_CONNECTION: flag = GSOCK_CONNECTION_FLAG; break;
     case GSOCK_LOST:       flag = GSOCK_LOST_FLAG; break;

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

   }
 
   if (((m_eventmask & flag) == flag) && m_notify)
   }
 
   if (((m_eventmask & flag) == flag) && m_notify)


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

-// wxSocketServer                             
+// wxSocketServer

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


@@ -1039,12 +1059,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;


@@ -1068,7 +1088,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;
 }


@@ -1127,13 +1150,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)
   {


@@ -1240,7 +1263,7 @@ class WXDLLEXPORT wxSocketModule : public wxModule
   DECLARE_DYNAMIC_CLASS(wxSocketModule)
 
 public:
   DECLARE_DYNAMIC_CLASS(wxSocketModule)
 
 public:

-  bool OnInit() { return GSocket_Init(); }
+  bool OnInit() { return GSocket_Init() != 0; }

   void OnExit() { GSocket_Cleanup(); }
 };
 
   void OnExit() { GSocket_Cleanup(); }
 };