wxMessageBox off the main thread lost result code.

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

diff --git a/src/common/socket.cpp b/src/common/socket.cpp
index 09324181ae35d32b9a041a1fece18e4dd1c158d0..a793e3520dccf14f3eeeaf394c4382ed9661090b 100644 (file)
--- a/src/common/socket.cpp
+++ b/src/common/socket.cpp
@@ -6,8 +6,7 @@
 // Copyright:  (C) 1999-1997, Guilhem Lavaux
 //             (C) 1999-2000, Guillermo Rodriguez Garcia
 //             (C) 2008 Vadim Zeitlin
 // Copyright:  (C) 1999-1997, Guilhem Lavaux
 //             (C) 1999-2000, Guillermo Rodriguez Garcia
 //             (C) 2008 Vadim Zeitlin

-// RCS_ID:     $Id$
-// License:    wxWindows licence
+// Licence:    wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ==========================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ==========================================================================


@@ -172,7 +171,9 @@ public:
           m_oldflags(socket->GetFlags())
 
     {
           m_oldflags(socket->GetFlags())
 
     {

-        wxASSERT_MSG( flag == wxSOCKET_WAITALL || flag == wxSOCKET_NOWAIT,
+        // We can be passed only wxSOCKET_WAITALL{_READ,_WRITE} or
+        // wxSOCKET_NOWAIT{_READ,_WRITE} normally.
+        wxASSERT_MSG( !(flag & wxSOCKET_WAITALL) || !(flag & wxSOCKET_NOWAIT),

                       "not a wait flag" );
 
         // preserve wxSOCKET_BLOCK value when switching to wxSOCKET_WAITALL
                       "not a wait flag" );
 
         // preserve wxSOCKET_BLOCK value when switching to wxSOCKET_WAITALL


@@ -524,7 +525,7 @@ wxSocketImpl *wxSocketImpl::Accept(wxSocketBase& wxsocket)
 {
     wxSockAddressStorage from;
     WX_SOCKLEN_T fromlen = sizeof(from);
 {
     wxSockAddressStorage from;
     WX_SOCKLEN_T fromlen = sizeof(from);

-    const SOCKET fd = accept(m_fd, &from.addr, &fromlen);
+    const wxSOCKET_T fd = accept(m_fd, &from.addr, &fromlen);

 
     // accepting is similar to reading in the sense that it resets "ready for
     // read" flag on the socket
 
     // accepting is similar to reading in the sense that it resets "ready for
     // read" flag on the socket


@@ -533,7 +534,14 @@ wxSocketImpl *wxSocketImpl::Accept(wxSocketBase& wxsocket)
     if ( fd == INVALID_SOCKET )
         return NULL;
 
     if ( fd == INVALID_SOCKET )
         return NULL;
 

-    wxSocketImpl * const sock = Create(wxsocket);
+    wxSocketManager * const manager = wxSocketManager::Get();
+    if ( !manager )
+        return NULL;
+
+    wxSocketImpl * const sock = manager->CreateSocket(wxsocket);
+    if ( !sock )
+        return NULL;
+

     sock->m_fd = fd;
     sock->m_peer = wxSockAddressImpl(from.addr, fromlen);
 
     sock->m_fd = fd;
     sock->m_peer = wxSockAddressImpl(from.addr, fromlen);
 


@@ -743,36 +751,48 @@ int wxSocketImpl::Write(const void *buffer, int size)
 // Initialization and shutdown
 // --------------------------------------------------------------------------
 
 // 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;
+namespace
+{
+
+// counts the number of calls to Initialize() minus the number of calls to
+// Shutdown(): we don't really need it any more but it was documented that
+// Shutdown() must be called the same number of times as Initialize() and using
+// a counter helps us to check it
+int gs_socketInitCount = 0;
+
+} // anonymous namespace

 
 bool wxSocketBase::IsInitialized()
 {
 
 bool wxSocketBase::IsInitialized()
 {

-    return m_countInit > 0;
+    wxASSERT_MSG( wxIsMainThread(), "unsafe to call from other threads" );
+
+    return gs_socketInitCount != 0;

 }
 
 bool wxSocketBase::Initialize()
 {
 }
 
 bool wxSocketBase::Initialize()
 {

-    if ( !m_countInit++ )
+    wxCHECK_MSG( wxIsMainThread(), false,
+                 "must be called from the main thread" );
+
+    if ( !gs_socketInitCount )

     {
         wxSocketManager * const manager = wxSocketManager::Get();
         if ( !manager || !manager->OnInit() )
     {
         wxSocketManager * const manager = wxSocketManager::Get();
         if ( !manager || !manager->OnInit() )

-        {
-            m_countInit--;
-

             return false;
             return false;

-        }

     }
 
     }
 

+    gs_socketInitCount++;
+

     return true;
 }
 
 void wxSocketBase::Shutdown()
 {
     return true;
 }
 
 void wxSocketBase::Shutdown()
 {

-    // we should be initialized
-    wxASSERT_MSG( m_countInit > 0, wxT("extra call to Shutdown()") );
-    if ( --m_countInit == 0 )
+    wxCHECK_RET( wxIsMainThread(), "must be called from the main thread" );
+
+    wxCHECK_RET( gs_socketInitCount > 0, "too many calls to Shutdown()" );
+
+    if ( !--gs_socketInitCount )

     {
         wxSocketManager * const manager = wxSocketManager::Get();
         wxCHECK_RET( manager, "should have a socket manager" );
     {
         wxSocketManager * const manager = wxSocketManager::Get();
         wxCHECK_RET( manager, "should have a socket manager" );


@@ -798,6 +818,8 @@ void wxSocketBase::Init()
     m_writing      =
     m_closed       = false;
     m_lcount       = 0;
     m_writing      =
     m_closed       = false;
     m_lcount       = 0;

+    m_lcount_read  = 0;
+    m_lcount_write = 0;

     m_timeout      = 600;
     m_beingDeleted = false;
 
     m_timeout      = 600;
     m_beingDeleted = false;
 


@@ -814,13 +836,15 @@ void wxSocketBase::Init()
     m_eventmask    =
     m_eventsgot    = 0;
 
     m_eventmask    =
     m_eventsgot    = 0;
 

-    if ( !IsInitialized() )
+    // when we create the first socket in the main thread we initialize the
+    // OS-dependent socket stuff: notice that this means that the user code
+    // needs to call wxSocket::Initialize() itself if the first socket it
+    // creates is not created in the main thread
+    if ( wxIsMainThread() )

     {
     {

-        // this Initialize() will be undone by wxSocketModule::OnExit(), all
-        // the other calls to it should be matched by a call to Shutdown()
-        if (!Initialize())
+        if ( !Initialize() )

         {
         {

-            wxLogError("Cannot initialize wxSocketBase");
+            wxLogError(_("Cannot initialize sockets"));

         }
     }
 }
         }
     }
 }


@@ -866,8 +890,12 @@ bool wxSocketBase::Destroy()
     Notify(false);
 
     // Schedule this object for deletion instead of destroying it right now if
     Notify(false);
 
     // Schedule this object for deletion instead of destroying it right now if

-    // possible as we may have other events pending for it
-    if ( wxTheApp )
+    // it can have other events pending for it and we have a way to do it.
+    //
+    // Notice that sockets used in other threads won't have any events for them
+    // and we shouldn't use delayed destruction mechanism for them as it's not
+    // MT-safe.
+    if ( wxIsMainThread() && wxTheApp )

     {
         wxTheApp->ScheduleForDestruction(this);
     }
     {
         wxTheApp->ScheduleForDestruction(this);
     }


@@ -922,7 +950,8 @@ wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
 {
     wxSocketReadGuard read(this);
 
 {
     wxSocketReadGuard read(this);
 

-    m_lcount = DoRead(buffer, nbytes);
+    m_lcount_read = DoRead(buffer, nbytes);
+    m_lcount = m_lcount_read;

 
     return *this;
 }
 
     return *this;
 }


@@ -958,8 +987,12 @@ wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
             if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK )
             {
                 // if we don't want to wait, just return immediately
             if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK )
             {
                 // if we don't want to wait, just return immediately

-                if ( m_flags & wxSOCKET_NOWAIT )
+                if ( m_flags & wxSOCKET_NOWAIT_READ )
+                {
+                    // this shouldn't be counted as an error in this case
+                    SetError(wxSOCKET_NOERROR);

                     break;
                     break;

+                }

 
                 // otherwise wait until the socket becomes ready for reading or
                 // an error occurs on it
 
                 // otherwise wait until the socket becomes ready for reading or
                 // an error occurs on it


@@ -990,7 +1023,7 @@ wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
             // we're not going to read anything else and so if we haven't read
             // anything (or not everything in wxSOCKET_WAITALL case) already,
             // signal an error
             // we're not going to read anything else and so if we haven't read
             // anything (or not everything in wxSOCKET_WAITALL case) already,
             // signal an error

-            if ( (m_flags & wxSOCKET_WAITALL) || !total )
+            if ( (m_flags & wxSOCKET_WAITALL_READ) || !total )

                 SetError(wxSOCKET_IOERR);
             break;
         }
                 SetError(wxSOCKET_IOERR);
             break;
         }


@@ -999,7 +1032,7 @@ wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
 
         // if we are happy to read something and not the entire nbytes bytes,
         // then we're done
 
         // if we are happy to read something and not the entire nbytes bytes,
         // then we're done

-        if ( !(m_flags & wxSOCKET_WAITALL) )
+        if ( !(m_flags & wxSOCKET_WAITALL_READ) )

             break;
 
         nbytes -= ret;
             break;
 
         nbytes -= ret;


@@ -1019,7 +1052,7 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
 
     wxSocketReadGuard read(this);
 
 
     wxSocketReadGuard read(this);
 

-    wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL);
+    wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL_READ);

 
     bool ok = false;
     if ( DoRead(&msg, sizeof(msg)) == sizeof(msg) )
 
     bool ok = false;
     if ( DoRead(&msg, sizeof(msg)) == sizeof(msg) )


@@ -1046,7 +1079,8 @@ wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
                 len2 = 0;
 
             // Don't attempt to read if the msg was zero bytes long.
                 len2 = 0;
 
             // Don't attempt to read if the msg was zero bytes long.

-            m_lcount = len ? DoRead(buffer, len) : 0;
+            m_lcount_read = len ? DoRead(buffer, len) : 0;
+            m_lcount = m_lcount_read;

 
             if ( len2 )
             {
 
             if ( len2 )
             {


@@ -1088,6 +1122,9 @@ wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
 {
     wxSocketReadGuard read(this);
 
 {
     wxSocketReadGuard read(this);
 

+    // Peek() should never block
+    wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT);
+

     m_lcount = DoRead(buffer, nbytes);
 
     Pushback(buffer, m_lcount);
     m_lcount = DoRead(buffer, nbytes);
 
     Pushback(buffer, m_lcount);


@@ -1099,7 +1136,8 @@ wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
 {
     wxSocketWriteGuard write(this);
 
 {
     wxSocketWriteGuard write(this);
 

-    m_lcount = DoWrite(buffer, nbytes);
+    m_lcount_write = DoWrite(buffer, nbytes);
+    m_lcount = m_lcount_write;

 
     return *this;
 }
 
     return *this;
 }


@@ -1119,7 +1157,7 @@ wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes)
     {
         if ( m_impl->m_stream && !m_connected )
         {
     {
         if ( m_impl->m_stream && !m_connected )
         {

-            if ( (m_flags & wxSOCKET_WAITALL) || !total )
+            if ( (m_flags & wxSOCKET_WAITALL_WRITE) || !total )

                 SetError(wxSOCKET_IOERR);
             break;
         }
                 SetError(wxSOCKET_IOERR);
             break;
         }


@@ -1129,7 +1167,7 @@ wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes)
         {
             if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK )
             {
         {
             if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK )
             {

-                if ( m_flags & wxSOCKET_NOWAIT )
+                if ( m_flags & wxSOCKET_NOWAIT_WRITE )

                     break;
 
                 if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) )
                     break;
 
                 if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) )


@@ -1149,7 +1187,7 @@ wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes)
 
         total += ret;
 
 
         total += ret;
 

-        if ( !(m_flags & wxSOCKET_WAITALL) )
+        if ( !(m_flags & wxSOCKET_WAITALL_WRITE) )

             break;
 
         nbytes -= ret;
             break;
 
         nbytes -= ret;


@@ -1169,7 +1207,7 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
 
     wxSocketWriteGuard write(this);
 
 
     wxSocketWriteGuard write(this);
 

-    wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL);
+    wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL_WRITE);

 
     msg.sig[0] = (unsigned char) 0xad;
     msg.sig[1] = (unsigned char) 0xde;
 
     msg.sig[0] = (unsigned char) 0xad;
     msg.sig[1] = (unsigned char) 0xde;


@@ -1184,8 +1222,9 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
     bool ok = false;
     if ( DoWrite(&msg, sizeof(msg)) == sizeof(msg) )
     {
     bool ok = false;
     if ( DoWrite(&msg, sizeof(msg)) == sizeof(msg) )
     {

-        m_lcount = DoWrite(buffer, nbytes);
-        if ( m_lcount == nbytes )
+        m_lcount_write = DoWrite(buffer, nbytes);
+        m_lcount = m_lcount_write;
+        if ( m_lcount_write == nbytes )

         {
             msg.sig[0] = (unsigned char) 0xed;
             msg.sig[1] = (unsigned char) 0xfe;
         {
             msg.sig[0] = (unsigned char) 0xed;
             msg.sig[1] = (unsigned char) 0xfe;


@@ -1269,17 +1308,31 @@ wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags,
         exceptfds;                      // always want to know about errors
 
     if ( flags & wxSOCKET_INPUT_FLAG )
         exceptfds;                      // always want to know about errors
 
     if ( flags & wxSOCKET_INPUT_FLAG )

-    {

         preadfds = &readfds;
         preadfds = &readfds;

+
+    if ( flags & wxSOCKET_OUTPUT_FLAG )
+        pwritefds = &writefds;
+
+    // When using non-blocking connect() the client socket becomes connected
+    // (successfully or not) when it becomes writable but when using
+    // non-blocking accept() the server socket becomes connected when it
+    // becomes readable.
+    if ( flags & wxSOCKET_CONNECTION_FLAG )
+    {
+        if ( m_server )
+            preadfds = &readfds;
+        else
+            pwritefds = &writefds;
+    }
+
+    if ( preadfds )
+    {

         wxFD_ZERO(preadfds);
         wxFD_SET(m_fd, preadfds);
     }
 
         wxFD_ZERO(preadfds);
         wxFD_SET(m_fd, preadfds);
     }
 

-    // when using non-blocking connect() the socket becomes connected
-    // (successfully or not) when it becomes writable
-    if ( flags & (wxSOCKET_OUTPUT_FLAG | wxSOCKET_CONNECTION_FLAG) )
+    if ( pwritefds )

     {
     {

-        pwritefds = &writefds;

         wxFD_ZERO(pwritefds);
         wxFD_SET(m_fd, pwritefds);
     }
         wxFD_ZERO(pwritefds);
         wxFD_SET(m_fd, pwritefds);
     }


@@ -1348,8 +1401,11 @@ wxSocketBase::DoWait(long timeout, wxSocketEventFlags flags)
 {
     wxCHECK_MSG( m_impl, -1, "can't wait on invalid socket" );
 
 {
     wxCHECK_MSG( m_impl, -1, "can't wait on invalid socket" );
 

-    // we're never going to become ready if we're not connected (any more)
-    if ( !m_connected && !m_establishing )
+    // we're never going to become ready in a TCP client if we're not connected
+    // any more (OTOH a server can call this to precisely wait for a connection
+    // so do wait for it in this case and UDP client is never "connected")
+    if ( !m_impl->IsServer() &&
+            m_impl->m_stream && !m_connected && !m_establishing )

         return -1;
 
     // This can be set to true from Interrupt() to exit this function a.s.a.p.
         return -1;
 
     // This can be set to true from Interrupt() to exit this function a.s.a.p.


@@ -1739,7 +1795,8 @@ wxSocketServer::wxSocketServer(const wxSockAddress& addr,
 {
     wxLogTrace( wxTRACE_Socket, wxT("Opening wxSocketServer") );
 
 {
     wxLogTrace( wxTRACE_Socket, wxT("Opening wxSocketServer") );
 

-    m_impl = wxSocketImpl::Create(*this);
+    wxSocketManager * const manager = wxSocketManager::Get();
+    m_impl = manager ? manager->CreateSocket(*this) : NULL;

 
     if (!m_impl)
     {
 
     if (!m_impl)
     {


@@ -1762,14 +1819,17 @@ wxSocketServer::wxSocketServer(const wxSockAddress& addr,
 
     if (m_impl->CreateServer() != wxSOCKET_NOERROR)
     {
 
     if (m_impl->CreateServer() != wxSOCKET_NOERROR)
     {

-        delete m_impl;
-        m_impl = NULL;
+        wxDELETE(m_impl);

 
         wxLogTrace( wxTRACE_Socket, wxT("*** CreateServer() failed") );
         return;
     }
 
 
         wxLogTrace( wxTRACE_Socket, wxT("*** CreateServer() failed") );
         return;
     }
 

-    wxLogTrace( wxTRACE_Socket, wxT("wxSocketServer on fd %d"), m_impl->m_fd );
+    // Notice that we need a cast as wxSOCKET_T is 64 bit under Win64 and that
+    // the cast is safe because a wxSOCKET_T is a handle and so limited to 32
+    // (or, actually, even 24) bit values anyhow.
+    wxLogTrace( wxTRACE_Socket, wxT("wxSocketServer on fd %u"),
+                static_cast<unsigned>(m_impl->m_fd) );

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


@@ -1833,6 +1893,14 @@ bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
     return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) == 1;
 }
 
     return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) == 1;
 }
 

+wxSOCKET_T wxSocketBase::GetSocket() const
+{
+    wxASSERT_MSG( m_impl, wxS("Socket not initialised") );
+
+    return m_impl->m_fd;
+}
+
+

 bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
 {
     wxASSERT_MSG( m_impl, wxT("Socket not initialised") );
 bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
 {
     wxASSERT_MSG( m_impl, wxT("Socket not initialised") );


@@ -1897,7 +1965,8 @@ bool wxSocketClient::DoConnect(const wxSockAddress& remote,
     m_establishing = false;
 
     // Create and set up the new one
     m_establishing = false;
 
     // Create and set up the new one

-    m_impl = wxSocketImpl::Create(*this);
+    wxSocketManager * const manager = wxSocketManager::Get();
+    m_impl = manager ? manager->CreateSocket(*this) : NULL;

     if ( !m_impl )
         return false;
 
     if ( !m_impl )
         return false;
 


@@ -1979,7 +2048,8 @@ wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
                 : wxSocketBase( flags, wxSOCKET_DATAGRAM )
 {
     // Create the socket
                 : wxSocketBase( flags, wxSOCKET_DATAGRAM )
 {
     // Create the socket

-    m_impl = wxSocketImpl::Create(*this);
+    wxSocketManager * const manager = wxSocketManager::Get();
+    m_impl = manager ? manager->CreateSocket(*this) : NULL;

 
     if (!m_impl)
         return;
 
     if (!m_impl)
         return;


@@ -2001,8 +2071,7 @@ wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
 
     if ( m_impl->CreateUDP() != wxSOCKET_NOERROR )
     {
 
     if ( m_impl->CreateUDP() != wxSOCKET_NOERROR )
     {

-        delete m_impl;
-        m_impl = NULL;
+        wxDELETE(m_impl);

         return;
     }
 
         return;
     }
 


@@ -2064,4 +2133,14 @@ IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
 wxFORCE_LINK_MODULE( socketiohandler )
 #endif
 
 wxFORCE_LINK_MODULE( socketiohandler )
 #endif
 

+// same for ManagerSetter in the MSW file
+#ifdef __WINDOWS__
+    wxFORCE_LINK_MODULE( mswsocket )
+#endif
+
+// and for OSXManagerSetter in the OS X one
+#ifdef __WXOSX__
+    wxFORCE_LINK_MODULE( osxsocket )
+#endif
+

 #endif // wxUSE_SOCKETS
 #endif // wxUSE_SOCKETS