Don't block in wxEventLoopManual::Dispatch() if loop was exited.

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

diff --git a/src/common/socket.cpp b/src/common/socket.cpp
index 71cfcc6cce9d11dd35746b98bf5a942e49cacf95..0d619a77c2f239f7b83cf12088cc0fc98d10f8f6 100644 (file)
--- a/src/common/socket.cpp
+++ b/src/common/socket.cpp
@@ -7,7 +7,7 @@
 //             (C) 1999-2000, Guillermo Rodriguez Garcia
 //             (C) 2008 Vadim Zeitlin
 // RCS_ID:     $Id$
 //             (C) 1999-2000, Guillermo Rodriguez Garcia
 //             (C) 2008 Vadim Zeitlin
 // RCS_ID:     $Id$

-// License:    wxWindows licence
+// Licence:    wxWindows licence

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


@@ -115,7 +115,7 @@ wxDEFINE_EVENT(wxEVT_SOCKET, wxSocketEvent);
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 

-#define wxTRACE_Socket _T("wxSocket")
+#define wxTRACE_Socket wxT("wxSocket")

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


@@ -213,7 +213,11 @@ public:
     {
         m_socket->m_reading = false;
 
     {
         m_socket->m_reading = false;
 

-        m_socket->m_impl->ReenableEvents(wxSOCKET_INPUT_FLAG);
+        // connection could have been lost while reading, in this case calling
+        // ReenableEvents() would assert and is not necessary anyhow
+        wxSocketImpl * const impl = m_socket->m_impl;
+        if ( impl && impl->m_fd != INVALID_SOCKET )
+            impl->ReenableEvents(wxSOCKET_INPUT_FLAG);

     }
 
 private:
     }
 
 private:


@@ -231,13 +235,15 @@ public:
         wxASSERT_MSG( !m_socket->m_writing, "write reentrancy?" );
 
         m_socket->m_writing = true;
         wxASSERT_MSG( !m_socket->m_writing, "write reentrancy?" );
 
         m_socket->m_writing = true;

-
-        m_socket->m_impl->ReenableEvents(wxSOCKET_OUTPUT_FLAG);

     }
 
     ~wxSocketWriteGuard()
     {
         m_socket->m_writing = false;
     }
 
     ~wxSocketWriteGuard()
     {
         m_socket->m_writing = false;

+
+        wxSocketImpl * const impl = m_socket->m_impl;
+        if ( impl && impl->m_fd != INVALID_SOCKET )
+            impl->ReenableEvents(wxSOCKET_OUTPUT_FLAG);

     }
 
 private:
     }
 
 private:


@@ -527,7 +533,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);
 


@@ -737,36 +750,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, _T("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" );


@@ -808,12 +833,16 @@ 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())
-            wxLogError("Cannot initialize wxSocketBase");
+        if ( !Initialize() )
+        {
+            wxLogError(_("Cannot initialize sockets"));
+        }

     }
 }
 
     }
 }
 


@@ -833,12 +862,6 @@ wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
 
 wxSocketBase::~wxSocketBase()
 {
 
 wxSocketBase::~wxSocketBase()
 {

-    // Just in case the app called Destroy() *and* then deleted the socket
-    // immediately: don't leave dangling pointers.
-    wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
-    if ( traits )
-        traits->RemoveFromPendingDelete(this);
-

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


@@ -847,8 +870,7 @@ wxSocketBase::~wxSocketBase()
     delete m_impl;
 
     // Free the pushback buffer
     delete m_impl;
 
     // Free the pushback buffer

-    if (m_unread)
-        free(m_unread);
+    free(m_unread);

 }
 
 bool wxSocketBase::Destroy()
 }
 
 bool wxSocketBase::Destroy()


@@ -864,14 +886,13 @@ bool wxSocketBase::Destroy()
     // Suppress events from now on
     Notify(false);
 
     // Suppress events from now on
     Notify(false);
 

-    // schedule this object for deletion
-    wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
-    if ( traits )
+    // Schedule this object for deletion instead of destroying it right now if
+    // possible as we may have other events pending for it
+    if ( wxTheApp )

     {
     {

-        // let the traits object decide what to do with us
-        traits->ScheduleForDestroy(this);
+        wxTheApp->ScheduleForDestruction(this);

     }
     }

-    else // no app or no traits
+    else // no app

     {
         // in wxBase we might have no app object at all, don't leak memory
         delete this;
     {
         // in wxBase we might have no app object at all, don't leak memory
         delete this;


@@ -959,7 +980,11 @@ wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
             {
                 // if we don't want to wait, just return immediately
                 if ( m_flags & wxSOCKET_NOWAIT )
             {
                 // if we don't want to wait, just return immediately
                 if ( m_flags & wxSOCKET_NOWAIT )

+                {
+                    // 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


@@ -1088,6 +1113,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);


@@ -1269,17 +1297,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 +1390,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.


@@ -1620,7 +1665,9 @@ void wxSocketBase::OnRequest(wxSocketNotify notification)
         case wxSOCKET_LOST:
             flag = wxSOCKET_LOST_FLAG;
 
         case wxSOCKET_LOST:
             flag = wxSOCKET_LOST_FLAG;
 

-            // if we lost the connection the socket is now closed
+            // if we lost the connection the socket is now closed and not
+            // connected any more
+            m_connected = false;

             m_closed = true;
             break;
 
             m_closed = true;
             break;
 


@@ -1735,13 +1782,14 @@ wxSocketServer::wxSocketServer(const wxSockAddress& addr,
                                wxSocketFlags flags)
               : wxSocketBase(flags, wxSOCKET_SERVER)
 {
                                wxSocketFlags flags)
               : wxSocketBase(flags, wxSOCKET_SERVER)
 {

-    wxLogTrace( wxTRACE_Socket, _T("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)
     {

-        wxLogTrace( wxTRACE_Socket, _T("*** Failed to create m_impl") );
+        wxLogTrace( wxTRACE_Socket, wxT("*** Failed to create m_impl") );

         return;
     }
 
         return;
     }
 


@@ -1760,14 +1808,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, _T("*** CreateServer() failed") );
+        wxLogTrace( wxTRACE_Socket, wxT("*** CreateServer() failed") );

         return;
     }
 
         return;
     }
 

-    wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_impl->m_fd );
+    // Notice that we need a cast as SOCKET is 64 bit under Win64 and that the
+    // cast is safe because a SOCKET 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,7 +1884,7 @@ bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
 
 bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
 {
 
 bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
 {

-    wxASSERT_MSG( m_impl, _T("Socket not initialised") );
+    wxASSERT_MSG( m_impl, wxT("Socket not initialised") );

 
     SOCKOPTLEN_T lenreal = *optlen;
     if ( getsockopt(m_impl->m_fd, level, optname,
 
     SOCKOPTLEN_T lenreal = *optlen;
     if ( getsockopt(m_impl->m_fd, level, optname,


@@ -1848,7 +1899,7 @@ bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
 bool
 wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen)
 {
 bool
 wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen)
 {

-    wxASSERT_MSG( m_impl, _T("Socket not initialised") );
+    wxASSERT_MSG( m_impl, wxT("Socket not initialised") );

 
     return setsockopt(m_impl->m_fd, level, optname,
                       static_cast<const char *>(optval), optlen) == 0;
 
     return setsockopt(m_impl->m_fd, level, optname,
                       static_cast<const char *>(optval), optlen) == 0;


@@ -1895,7 +1946,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;
 


@@ -1977,7 +2029,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;


@@ -1999,8 +2052,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;
     }
 


@@ -2022,7 +2074,7 @@ wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr,
                                             const void* buf,
                                             wxUint32 nBytes )
 {
                                             const void* buf,
                                             wxUint32 nBytes )
 {

-    wxASSERT_MSG( m_impl, _T("Socket not initialised") );
+    wxASSERT_MSG( m_impl, wxT("Socket not initialised") );

 
     m_impl->SetPeer(addr.GetAddress());
     Write(buf, nBytes);
 
     m_impl->SetPeer(addr.GetAddress());
     Write(buf, nBytes);


@@ -2062,4 +2114,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