X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc0972a2514ecc52f1905bbfa92168e10a6c6267..9ac34ac9156ea40ad76025aedb6eef86b2a813cc:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 88ad1f1548..228fe79a28 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -4,7 +4,8 @@ // Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia // Created: April 1997 // Copyright: (C) 1999-1997, Guilhem Lavaux -// (C) 2000-1999, Guillermo Rodriguez Garcia +// (C) 1999-2000, Guillermo Rodriguez Garcia +// (C) 2008 Vadim Zeitlin // RCS_ID: $Id$ // License: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -41,6 +42,64 @@ #include "wx/stopwatch.h" #include "wx/thread.h" #include "wx/evtloop.h" +#include "wx/link.h" + +#include "wx/private/fd.h" +#include "wx/private/socket.h" + +#ifdef __UNIX__ + #include +#endif + +// we use MSG_NOSIGNAL to avoid getting SIGPIPE when sending data to a remote +// host which closed the connection if it is available, otherwise we rely on +// SO_NOSIGPIPE existency +// +// this should cover all the current Unix systems (Windows never sends any +// signals anyhow) but if we find one that has neither we should explicitly +// ignore SIGPIPE for it +// OpenVMS has neither MSG_NOSIGNAL nor SO_NOSIGPIPE. However the socket sample +// seems to work. Not sure if problems will show up on OpenVMS using sockets. +#ifdef MSG_NOSIGNAL + #define wxSOCKET_MSG_NOSIGNAL MSG_NOSIGNAL +#else // MSG_NOSIGNAL not available (BSD including OS X) + // next best possibility is to use SO_NOSIGPIPE socket option, this covers + // BSD systems (including OS X) -- but if we don't have it neither (AIX and + // old HP-UX do not), we have to fall back to the old way of simply + // disabling SIGPIPE temporarily, so define a class to do it in a safe way + #if defined(__UNIX__) && !defined(SO_NOSIGPIPE) + extern "C" { typedef void (*wxSigHandler_t)(int); } + namespace + { + class IgnoreSignal + { + public: + // ctor disables the given signal + IgnoreSignal(int sig) + : m_handler(signal(sig, SIG_IGN)), + m_sig(sig) + { + } + + // dtor restores the old handler + ~IgnoreSignal() + { + signal(m_sig, m_handler); + } + + private: + const wxSigHandler_t m_handler; + const int m_sig; + + wxDECLARE_NO_COPY_CLASS(IgnoreSignal); + }; + } // anonymous namespace + + #define wxNEEDS_IGNORE_SIGPIPE + #endif // Unix without SO_NOSIGPIPE + + #define wxSOCKET_MSG_NOSIGNAL 0 +#endif // DLL options compatibility check: #include "wx/build.h" @@ -50,10 +109,13 @@ WX_CHECK_BUILD_OPTIONS("wxNet") // macros and constants // -------------------------------------------------------------------------- +// event +wxDEFINE_EVENT(wxEVT_SOCKET, wxSocketEvent); + // discard buffer #define MAX_DISCARD_SIZE (10 * 1024) -#define wxTRACE_Socket _T("wxSocket") +#define wxTRACE_Socket wxT("wxSocket") // -------------------------------------------------------------------------- // wxWin macros @@ -65,6 +127,21 @@ IMPLEMENT_CLASS(wxSocketClient, wxSocketBase) IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase) IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent) +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- + +namespace +{ + +void SetTimeValFromMS(timeval& tv, unsigned long ms) +{ + tv.tv_sec = (ms / 1000); + tv.tv_usec = (ms % 1000) * 1000; +} + +} // anonymous namespace + // -------------------------------------------------------------------------- // private classes // -------------------------------------------------------------------------- @@ -80,42 +157,109 @@ public: public: wxSocketState() : wxObject() {} - DECLARE_NO_COPY_CLASS(wxSocketState) + wxDECLARE_NO_COPY_CLASS(wxSocketState); }; -// Conditionally make the socket non-blocking for the lifetime of this object. -class wxSocketUnblocker +// wxSocketWaitModeChanger: temporarily change the socket flags affecting its +// wait mode +class wxSocketWaitModeChanger { public: - wxSocketUnblocker(GSocket *socket, bool unblock = true) + // temporarily set the flags to include the flag value which may be either + // wxSOCKET_NOWAIT or wxSOCKET_WAITALL + wxSocketWaitModeChanger(wxSocketBase *socket, int flag) : m_socket(socket), - m_unblock(unblock) + m_oldflags(socket->GetFlags()) + { - if ( m_unblock ) - m_socket->SetNonBlocking(true); + wxASSERT_MSG( flag == wxSOCKET_WAITALL || flag == wxSOCKET_NOWAIT, + "not a wait flag" ); + + // preserve wxSOCKET_BLOCK value when switching to wxSOCKET_WAITALL + // mode but not when switching to wxSOCKET_NOWAIT as the latter is + // incompatible with wxSOCKET_BLOCK + if ( flag != wxSOCKET_NOWAIT ) + flag |= m_oldflags & wxSOCKET_BLOCK; + + socket->SetFlags(flag); } - ~wxSocketUnblocker() + ~wxSocketWaitModeChanger() { - if ( m_unblock ) - m_socket->SetNonBlocking(false); + m_socket->SetFlags(m_oldflags); } private: - GSocket * const m_socket; - bool m_unblock; + wxSocketBase * const m_socket; + const int m_oldflags; - DECLARE_NO_COPY_CLASS(wxSocketUnblocker) + wxDECLARE_NO_COPY_CLASS(wxSocketWaitModeChanger); +}; + +// wxSocketRead/WriteGuard are instantiated before starting reading +// from/writing to the socket +class wxSocketReadGuard +{ +public: + wxSocketReadGuard(wxSocketBase *socket) + : m_socket(socket) + { + wxASSERT_MSG( !m_socket->m_reading, "read reentrancy?" ); + + m_socket->m_reading = true; + } + + ~wxSocketReadGuard() + { + m_socket->m_reading = false; + + // 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: + wxSocketBase * const m_socket; + + wxDECLARE_NO_COPY_CLASS(wxSocketReadGuard); +}; + +class wxSocketWriteGuard +{ +public: + wxSocketWriteGuard(wxSocketBase *socket) + : m_socket(socket) + { + wxASSERT_MSG( !m_socket->m_writing, "write reentrancy?" ); + + m_socket->m_writing = true; + } + + ~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: + wxSocketBase * const m_socket; + + wxDECLARE_NO_COPY_CLASS(wxSocketWriteGuard); }; // ============================================================================ -// GSocketManager +// wxSocketManager // ============================================================================ -GSocketManager *GSocketManager::ms_manager = NULL; +wxSocketManager *wxSocketManager::ms_manager = NULL; /* static */ -void GSocketManager::Set(GSocketManager *manager) +void wxSocketManager::Set(wxSocketManager *manager) { wxASSERT_MSG( !ms_manager, "too late to set manager now" ); @@ -123,7 +267,7 @@ void GSocketManager::Set(GSocketManager *manager) } /* static */ -void GSocketManager::Init() +void wxSocketManager::Init() { wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" ); @@ -152,6 +296,452 @@ void GSocketManager::Init() ms_manager = app->GetTraits()->GetSocketManager(); } +// ========================================================================== +// wxSocketImpl +// ========================================================================== + +wxSocketImpl::wxSocketImpl(wxSocketBase& wxsocket) + : m_wxsocket(&wxsocket) +{ + m_fd = INVALID_SOCKET; + m_error = wxSOCKET_NOERROR; + m_server = false; + m_stream = true; + + SetTimeout(wxsocket.GetTimeout() * 1000); + + m_establishing = false; + m_reusable = false; + m_broadcast = false; + m_dobind = true; + m_initialRecvBufferSize = -1; + m_initialSendBufferSize = -1; +} + +wxSocketImpl::~wxSocketImpl() +{ + if ( m_fd != INVALID_SOCKET ) + Shutdown(); +} + +bool wxSocketImpl::PreCreateCheck(const wxSockAddressImpl& addr) +{ + if ( m_fd != INVALID_SOCKET ) + { + m_error = wxSOCKET_INVSOCK; + return false; + } + + if ( !addr.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return false; + } + + return true; +} + +void wxSocketImpl::PostCreation() +{ + // FreeBSD variants can't use MSG_NOSIGNAL, and instead use a socket option +#ifdef SO_NOSIGPIPE + EnableSocketOption(SO_NOSIGPIPE); +#endif + + if ( m_reusable ) + EnableSocketOption(SO_REUSEADDR); + + if ( m_broadcast ) + { + wxASSERT_MSG( !m_stream, "broadcasting is for datagram sockets only" ); + + EnableSocketOption(SO_BROADCAST); + } + + if ( m_initialRecvBufferSize >= 0 ) + SetSocketOption(SO_RCVBUF, m_initialRecvBufferSize); + if ( m_initialSendBufferSize >= 0 ) + SetSocketOption(SO_SNDBUF, m_initialSendBufferSize); + + // we always put our sockets in unblocked mode and handle blocking + // ourselves in DoRead/Write() if wxSOCKET_WAITALL is specified + UnblockAndRegisterWithEventLoop(); +} + +wxSocketError wxSocketImpl::UpdateLocalAddress() +{ + if ( !m_local.IsOk() ) + { + // ensure that we have a valid object using the correct family: correct + // being the same one as our peer uses as we have no other way to + // determine it + m_local.Create(m_peer.GetFamily()); + } + + WX_SOCKLEN_T lenAddr = m_local.GetLen(); + if ( getsockname(m_fd, m_local.GetWritableAddr(), &lenAddr) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } + + return wxSOCKET_NOERROR; +} + +wxSocketError wxSocketImpl::CreateServer() +{ + if ( !PreCreateCheck(m_local) ) + return m_error; + + m_server = true; + m_stream = true; + + // do create the socket + m_fd = socket(m_local.GetFamily(), SOCK_STREAM, 0); + + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } + + PostCreation(); + + // and then bind to and listen on it + // + // FIXME: should we test for m_dobind here? + if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 ) + m_error = wxSOCKET_IOERR; + + if ( IsOk() ) + { + if ( listen(m_fd, 5) != 0 ) + m_error = wxSOCKET_IOERR; + } + + if ( !IsOk() ) + { + Close(); + return m_error; + } + + // finally retrieve the address we effectively bound to + return UpdateLocalAddress(); +} + +wxSocketError wxSocketImpl::CreateClient(bool wait) +{ + if ( !PreCreateCheck(m_peer) ) + return m_error; + + m_fd = socket(m_peer.GetFamily(), SOCK_STREAM, 0); + + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } + + PostCreation(); + + // If a local address has been set, then bind to it before calling connect + if ( m_local.IsOk() ) + { + if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } + } + + // Do connect now + int rc = connect(m_fd, m_peer.GetAddr(), m_peer.GetLen()); + if ( rc == SOCKET_ERROR ) + { + wxSocketError err = GetLastError(); + if ( err == wxSOCKET_WOULDBLOCK ) + { + m_establishing = true; + + // block waiting for connection if we should (otherwise just return + // wxSOCKET_WOULDBLOCK to the caller) + if ( wait ) + { + err = SelectWithTimeout(wxSOCKET_CONNECTION_FLAG) + ? wxSOCKET_NOERROR + : wxSOCKET_TIMEDOUT; + m_establishing = false; + } + } + + m_error = err; + } + else // connected + { + m_error = wxSOCKET_NOERROR; + } + + return m_error; +} + + +wxSocketError wxSocketImpl::CreateUDP() +{ + if ( !PreCreateCheck(m_local) ) + return m_error; + + m_stream = false; + m_server = false; + + m_fd = socket(m_local.GetFamily(), SOCK_DGRAM, 0); + + if ( m_fd == INVALID_SOCKET ) + { + m_error = wxSOCKET_IOERR; + return wxSOCKET_IOERR; + } + + PostCreation(); + + if ( m_dobind ) + { + if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 ) + { + Close(); + m_error = wxSOCKET_IOERR; + return m_error; + } + + return UpdateLocalAddress(); + } + + return wxSOCKET_NOERROR; +} + +wxSocketImpl *wxSocketImpl::Accept(wxSocketBase& wxsocket) +{ + wxSockAddressStorage from; + WX_SOCKLEN_T fromlen = sizeof(from); + const SOCKET 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 + ReenableEvents(wxSOCKET_INPUT_FLAG); + + if ( fd == INVALID_SOCKET ) + return NULL; + + 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->UnblockAndRegisterWithEventLoop(); + + return sock; +} + + +void wxSocketImpl::Close() +{ + if ( m_fd != INVALID_SOCKET ) + { + DoClose(); + m_fd = INVALID_SOCKET; + } +} + +void wxSocketImpl::Shutdown() +{ + if ( m_fd != INVALID_SOCKET ) + { + shutdown(m_fd, 1 /* SD_SEND */); + Close(); + } +} + +/* + * Sets the timeout for blocking calls. Time is expressed in + * milliseconds. + */ +void wxSocketImpl::SetTimeout(unsigned long millis) +{ + SetTimeValFromMS(m_timeout, millis); +} + +void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event) +{ + m_wxsocket->OnRequest(event); +} + +/* Address handling */ +wxSocketError wxSocketImpl::SetLocal(const wxSockAddressImpl& local) +{ + /* the socket must be initialized, or it must be a server */ + if (m_fd != INVALID_SOCKET && !m_server) + { + m_error = wxSOCKET_INVSOCK; + return wxSOCKET_INVSOCK; + } + + if ( !local.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return wxSOCKET_INVADDR; + } + + m_local = local; + + return wxSOCKET_NOERROR; +} + +wxSocketError wxSocketImpl::SetPeer(const wxSockAddressImpl& peer) +{ + if ( !peer.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return wxSOCKET_INVADDR; + } + + m_peer = peer; + + return wxSOCKET_NOERROR; +} + +const wxSockAddressImpl& wxSocketImpl::GetLocal() +{ + if ( !m_local.IsOk() ) + UpdateLocalAddress(); + + return m_local; +} + +// ---------------------------------------------------------------------------- +// wxSocketImpl IO +// ---------------------------------------------------------------------------- + +// this macro wraps the given expression (normally a syscall) in a loop which +// ignores any interruptions, i.e. reevaluates it again if it failed and errno +// is EINTR +#ifdef __UNIX__ + #define DO_WHILE_EINTR( rc, syscall ) \ + do { \ + rc = (syscall); \ + } \ + while ( rc == -1 && errno == EINTR ) +#else + #define DO_WHILE_EINTR( rc, syscall ) rc = (syscall) +#endif + +int wxSocketImpl::RecvStream(void *buffer, int size) +{ + int ret; + DO_WHILE_EINTR( ret, recv(m_fd, static_cast(buffer), size, 0) ); + + if ( !ret ) + { + // receiving 0 bytes for a TCP socket indicates that the connection was + // closed by peer so shut down our end as well (for UDP sockets empty + // datagrams are also possible) + m_establishing = false; + NotifyOnStateChange(wxSOCKET_LOST); + + Shutdown(); + + // do not return an error in this case however + } + + return ret; +} + +int wxSocketImpl::SendStream(const void *buffer, int size) +{ +#ifdef wxNEEDS_IGNORE_SIGPIPE + IgnoreSignal ignore(SIGPIPE); +#endif + + int ret; + DO_WHILE_EINTR( ret, send(m_fd, static_cast(buffer), size, + wxSOCKET_MSG_NOSIGNAL) ); + + return ret; +} + +int wxSocketImpl::RecvDgram(void *buffer, int size) +{ + wxSockAddressStorage from; + WX_SOCKLEN_T fromlen = sizeof(from); + + int ret; + DO_WHILE_EINTR( ret, recvfrom(m_fd, static_cast(buffer), size, + 0, &from.addr, &fromlen) ); + + if ( ret == SOCKET_ERROR ) + return SOCKET_ERROR; + + m_peer = wxSockAddressImpl(from.addr, fromlen); + if ( !m_peer.IsOk() ) + return -1; + + return ret; +} + +int wxSocketImpl::SendDgram(const void *buffer, int size) +{ + if ( !m_peer.IsOk() ) + { + m_error = wxSOCKET_INVADDR; + return -1; + } + + int ret; + DO_WHILE_EINTR( ret, sendto(m_fd, static_cast(buffer), size, + 0, m_peer.GetAddr(), m_peer.GetLen()) ); + + return ret; +} + +int wxSocketImpl::Read(void *buffer, int size) +{ + // server sockets can't be used for IO, only to accept new connections + if ( m_fd == INVALID_SOCKET || m_server ) + { + m_error = wxSOCKET_INVSOCK; + return -1; + } + + int ret = m_stream ? RecvStream(buffer, size) + : RecvDgram(buffer, size); + + m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR; + + return ret; +} + +int wxSocketImpl::Write(const void *buffer, int size) +{ + if ( m_fd == INVALID_SOCKET || m_server ) + { + m_error = wxSOCKET_INVSOCK; + return -1; + } + + int ret = m_stream ? SendStream(buffer, size) + : SendDgram(buffer, size); + + m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR; + + return ret; +} + // ========================================================================== // wxSocketBase // ========================================================================== @@ -160,37 +750,53 @@ void GSocketManager::Init() // 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() { - return m_countInit > 0; + wxASSERT_MSG( wxIsMainThread(), "unsafe to call from other threads" ); + + return gs_socketInitCount != 0; } bool wxSocketBase::Initialize() { - if ( !m_countInit++ ) - { - if ( !GSocket_Init() ) - { - 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() ) return false; - } } + gs_socketInitCount++; + 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 ) { - GSocket_Cleanup(); + wxSocketManager * const manager = wxSocketManager::Get(); + wxCHECK_RET( manager, "should have a socket manager" ); + + manager->OnExit(); } } @@ -200,7 +806,7 @@ void wxSocketBase::Shutdown() void wxSocketBase::Init() { - m_socket = NULL; + m_impl = NULL; m_type = wxSOCKET_UNINIT; // state @@ -209,7 +815,6 @@ void wxSocketBase::Init() m_establishing = m_reading = m_writing = - m_error = m_closed = false; m_lcount = 0; m_timeout = 600; @@ -225,13 +830,19 @@ void wxSocketBase::Init() m_handler = NULL; m_clientData = NULL; m_notify = false; - m_eventmask = 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() - Initialize(); + if ( !Initialize() ) + { + wxLogError(_("Cannot initialize sockets")); + } } } @@ -251,23 +862,15 @@ wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type) 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(); - // Destroy the GSocket object - if (m_socket) - delete m_socket; + // Destroy the implementation object + delete m_impl; // Free the pushback buffer - if (m_unread) - free(m_unread); + free(m_unread); } bool wxSocketBase::Destroy() @@ -280,17 +883,16 @@ bool wxSocketBase::Destroy() // Shutdown and close the socket Close(); - // Supress events from now on + // 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; @@ -299,62 +901,60 @@ bool wxSocketBase::Destroy() return true; } +// ---------------------------------------------------------------------------- +// simple accessors +// ---------------------------------------------------------------------------- + +void wxSocketBase::SetError(wxSocketError error) +{ + m_impl->m_error = error; +} + +wxSocketError wxSocketBase::LastError() const +{ + return m_impl->GetError(); +} + // -------------------------------------------------------------------------- // Basic IO calls // -------------------------------------------------------------------------- -// The following IO operations update m_error and m_lcount: +// The following IO operations update m_lcount: // {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard} -// -// TODO: Should Connect, Accept and AcceptWith update m_error? - bool wxSocketBase::Close() { // Interrupt pending waits InterruptWait(); - if (m_socket) - { - // Disable callbacks - m_socket->UnsetCallback( - GSOCK_INPUT_FLAG | - GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | - GSOCK_CONNECTION_FLAG - ); - - // Shutdown the connection - m_socket->Shutdown(); - } + ShutdownOutput(); m_connected = false; m_establishing = false; return true; } +void wxSocketBase::ShutdownOutput() +{ + if ( m_impl ) + m_impl->Shutdown(); +} + wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes) { - // Mask read events - m_reading = true; + wxSocketReadGuard read(this); m_lcount = DoRead(buffer, nbytes); - // If in wxSOCKET_WAITALL mode, all bytes should have been read. - if (m_flags & wxSOCKET_WAITALL) - m_error = (m_lcount != nbytes); - else - m_error = (m_lcount == 0); - - // Allow read events from now on - m_reading = false; - return *this; } wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) { + wxCHECK_MSG( m_impl, 0, "socket must be valid" ); + // We use pointer arithmetic here which doesn't work with void pointers. char *buffer = static_cast(buffer_); + wxCHECK_MSG( buffer, 0, "NULL buffer" ); // Try the push back buffer first, even before checking whether the socket // is valid to allow reading previously pushed back data from an already @@ -363,66 +963,68 @@ wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) nbytes -= total; buffer += total; - // If it's indeed closed or if read everything, there is nothing more to do. - if ( !m_socket || !nbytes ) - return total; - - wxCHECK_MSG( buffer, 0, "NULL buffer" ); - - - // wxSOCKET_NOWAIT overrides all the other flags and means that we are - // polling the socket and don't block at all. - if ( m_flags & wxSOCKET_NOWAIT ) - { - wxSocketUnblocker unblock(m_socket); - int ret = m_socket->Read(buffer, nbytes); - if ( ret < 0 ) - return 0; - - total += ret; - } - else // blocking socket + while ( nbytes ) { - for ( ;; ) + // our socket is non-blocking so Read() will return immediately if + // there is nothing to read yet and it's more efficient to try it first + // before entering DoWait() which is going to start dispatching GUI + // events and, even more importantly, we must do this under Windows + // where we're not going to get notifications about socket being ready + // for reading before we read all the existing data from it + const int ret = !m_impl->m_stream || m_connected + ? m_impl->Read(buffer, nbytes) + : 0; + if ( ret == -1 ) { - // Wait until socket becomes ready for reading dispatching the GUI - // events in the meanwhile unless wxSOCKET_BLOCK was explicitly - // specified to disable this. - if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() ) - break; - - const int ret = m_socket->Read(buffer, nbytes); - if ( ret == 0 ) + if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK ) { - // for connection-oriented (e.g. TCP) sockets we can only read - // 0 bytes if the other end has been closed, and for - // connectionless ones (UDP) this flag doesn't make sense - // anyhow so we can set it to true too without doing any harm - m_closed = true; - break; + // if we don't want to wait, just return immediately + if ( m_flags & wxSOCKET_NOWAIT ) + break; + + // otherwise wait until the socket becomes ready for reading or + // an error occurs on it + if ( !DoWaitWithTimeout(wxSOCKET_INPUT_FLAG) ) + { + // and exit if the timeout elapsed before it did + SetError(wxSOCKET_TIMEDOUT); + break; + } + + // retry reading + continue; } - - if ( ret < 0 ) + else // "real" error { - // this will be always interpreted as error by Read() - return 0; + SetError(wxSOCKET_IOERR); + break; } + } + else if ( ret == 0 ) + { + // for connection-oriented (e.g. TCP) sockets we can only read + // 0 bytes if the other end has been closed, and for connectionless + // ones (UDP) this flag doesn't make sense anyhow so we can set it + // to true too without doing any harm + m_closed = true; + + // 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 ) + SetError(wxSOCKET_IOERR); + break; + } - total += ret; - - // If wxSOCKET_WAITALL is not set, we can leave now as we did read - // something and we don't need to wait for all nbytes bytes to be - // read. - if ( !(m_flags & wxSOCKET_WAITALL) ) - break; + total += ret; - // Otherwise continue reading until we do read everything. - nbytes -= ret; - if ( !nbytes ) - break; + // if we are happy to read something and not the entire nbytes bytes, + // then we're done + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; - buffer += ret; - } + nbytes -= ret; + buffer += ret; } return total; @@ -430,190 +1032,152 @@ wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes) wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes) { - wxUint32 len, len2, sig, total; - bool error; - int old_flags; struct { unsigned char sig[4]; unsigned char len[4]; } msg; - // Mask read events - m_reading = true; - - total = 0; - error = true; - old_flags = m_flags; - SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); + wxSocketReadGuard read(this); - if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) - goto exit; + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL); - 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) + bool ok = false; + if ( DoRead(&msg, sizeof(msg)) == sizeof(msg) ) { - wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); - goto exit; - } + wxUint32 sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); - len = (wxUint32)msg.len[0]; - len |= (wxUint32)(msg.len[1] << 8); - len |= (wxUint32)(msg.len[2] << 16); - len |= (wxUint32)(msg.len[3] << 24); + if ( sig == 0xfeeddead ) + { + wxUint32 len = (wxUint32)msg.len[0]; + len |= (wxUint32)(msg.len[1] << 8); + len |= (wxUint32)(msg.len[2] << 16); + len |= (wxUint32)(msg.len[3] << 24); - if (len > nbytes) - { - len2 = len - nbytes; - len = nbytes; - } - else - len2 = 0; + wxUint32 len2; + if (len > nbytes) + { + len2 = len - nbytes; + len = nbytes; + } + else + len2 = 0; - // Don't attempt to read if the msg was zero bytes long. - if (len) - { - total = DoRead(buffer, len); + // Don't attempt to read if the msg was zero bytes long. + m_lcount = len ? DoRead(buffer, len) : 0; - if (total != len) - goto exit; - } + if ( len2 ) + { + char discard_buffer[MAX_DISCARD_SIZE]; + long discard_len; + + // NOTE: discarded bytes don't add to m_lcount. + do + { + discard_len = len2 > MAX_DISCARD_SIZE + ? MAX_DISCARD_SIZE + : len2; + discard_len = DoRead(discard_buffer, (wxUint32)discard_len); + len2 -= (wxUint32)discard_len; + } + while ((discard_len > 0) && len2); + } - if (len2) - { - char *discard_buffer = new char[MAX_DISCARD_SIZE]; - long discard_len; + if ( !len2 && DoRead(&msg, sizeof(msg)) == sizeof(msg) ) + { + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); - // NOTE: discarded bytes don't add to m_lcount. - do - { - discard_len = ((len2 > MAX_DISCARD_SIZE)? MAX_DISCARD_SIZE : len2); - discard_len = DoRead(discard_buffer, (wxUint32)discard_len); - len2 -= (wxUint32)discard_len; + if ( sig == 0xdeadfeed ) + ok = true; + } } - while ((discard_len > 0) && len2); - - delete [] discard_buffer; - - if (len2 != 0) - goto exit; - } - if (DoRead(&msg, sizeof(msg)) != sizeof(msg)) - goto exit; - - 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 != 0xdeadfeed) - { - wxLogWarning(_("wxSocket: invalid signature in ReadMsg.")); - goto exit; } - // everything was OK - error = false; - -exit: - m_error = error; - m_lcount = total; - m_reading = false; - SetFlags(old_flags); + if ( !ok ) + SetError(wxSOCKET_IOERR); return *this; } wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes) { - // Mask read events - m_reading = true; + wxSocketReadGuard read(this); - m_lcount = DoRead(buffer, nbytes); - Pushback(buffer, m_lcount); + // Peek() should never block + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT); - // If in wxSOCKET_WAITALL mode, all bytes should have been read. - if (m_flags & wxSOCKET_WAITALL) - m_error = (m_lcount != nbytes); - else - m_error = (m_lcount == 0); + m_lcount = DoRead(buffer, nbytes); - // Allow read events again - m_reading = false; + Pushback(buffer, m_lcount); return *this; } wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes) { - // Mask write events - m_writing = true; + wxSocketWriteGuard write(this); m_lcount = DoWrite(buffer, nbytes); - // If in wxSOCKET_WAITALL mode, all bytes should have been written. - if (m_flags & wxSOCKET_WAITALL) - m_error = (m_lcount != nbytes); - else - m_error = (m_lcount == 0); - - // Allow write events again - m_writing = false; - return *this; } // This function is a mirror image of DoRead() except that it doesn't use the -// push back buffer, please see comments there +// push back buffer and doesn't treat 0 return value specially (normally this +// shouldn't happen at all here), so please see comments there for explanations wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes) { - const char *buffer = static_cast(buffer_); - - // Return if there is nothing to read or the socket is (already?) closed. - if ( !m_socket || !nbytes ) - return 0; + wxCHECK_MSG( m_impl, 0, "socket must be valid" ); + const char *buffer = static_cast(buffer_); wxCHECK_MSG( buffer, 0, "NULL buffer" ); wxUint32 total = 0; - if ( m_flags & wxSOCKET_NOWAIT ) + while ( nbytes ) { - wxSocketUnblocker unblock(m_socket); - const int ret = m_socket->Write(buffer, nbytes); - if ( ret > 0 ) - total += ret; - } - else // blocking socket - { - for ( ;; ) + if ( m_impl->m_stream && !m_connected ) { - if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() ) - break; + if ( (m_flags & wxSOCKET_WAITALL) || !total ) + SetError(wxSOCKET_IOERR); + break; + } - const int ret = m_socket->Write(buffer, nbytes); - if ( ret == 0 ) + const int ret = m_impl->Write(buffer, nbytes); + if ( ret == -1 ) + { + if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK ) { - m_closed = true; - break; - } + if ( m_flags & wxSOCKET_NOWAIT ) + break; - if ( ret < 0 ) - return 0; + if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) ) + { + SetError(wxSOCKET_TIMEDOUT); + break; + } - total += ret; - if ( !(m_flags & wxSOCKET_WAITALL) ) + continue; + } + else // "real" error + { + SetError(wxSOCKET_IOERR); break; + } + } - nbytes -= ret; - if ( !nbytes ) - break; + total += ret; - buffer += ret; - } + if ( !(m_flags & wxSOCKET_WAITALL) ) + break; + + nbytes -= ret; + buffer += ret; } return total; @@ -621,20 +1185,15 @@ wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes) wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) { - wxUint32 total; - bool error; struct { unsigned char sig[4]; unsigned char len[4]; } msg; - // Mask write events - m_writing = true; + wxSocketWriteGuard write(this); - error = true; - total = 0; - SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL); msg.sig[0] = (unsigned char) 0xad; msg.sig[1] = (unsigned char) 0xde; @@ -646,33 +1205,28 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes) msg.len[2] = (unsigned char) ((nbytes >> 16) & 0xff); msg.len[3] = (unsigned char) ((nbytes >> 24) & 0xff); - if (DoWrite(&msg, sizeof(msg)) < sizeof(msg)) - goto exit; - - total = DoWrite(buffer, nbytes); - - if (total < nbytes) - goto exit; - - msg.sig[0] = (unsigned char) 0xed; - msg.sig[1] = (unsigned char) 0xfe; - msg.sig[2] = (unsigned char) 0xad; - msg.sig[3] = (unsigned char) 0xde; - msg.len[0] = - msg.len[1] = - msg.len[2] = - msg.len[3] = (char) 0; - - if ((DoWrite(&msg, sizeof(msg))) < sizeof(msg)) - goto exit; - - // everything was OK - error = false; + bool ok = false; + if ( DoWrite(&msg, sizeof(msg)) == sizeof(msg) ) + { + m_lcount = DoWrite(buffer, nbytes); + if ( m_lcount == nbytes ) + { + msg.sig[0] = (unsigned char) 0xed; + msg.sig[1] = (unsigned char) 0xfe; + msg.sig[2] = (unsigned char) 0xad; + msg.sig[3] = (unsigned char) 0xde; + msg.len[0] = + msg.len[1] = + msg.len[2] = + msg.len[3] = (char) 0; + + if ( DoWrite(&msg, sizeof(msg)) == sizeof(msg)) + ok = true; + } + } -exit: - m_error = error; - m_lcount = total; - m_writing = false; + if ( !ok ) + SetError(wxSOCKET_IOERR); return *this; } @@ -682,7 +1236,7 @@ wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes) if (nbytes != 0) Pushback(buffer, nbytes); - m_error = false; + SetError(wxSOCKET_NOERROR); m_lcount = nbytes; return *this; @@ -694,10 +1248,9 @@ wxSocketBase& wxSocketBase::Discard() wxUint32 ret; wxUint32 total = 0; - // Mask read events - m_reading = true; + wxSocketReadGuard read(this); - SetFlags(wxSOCKET_NOWAIT); + wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT); do { @@ -708,10 +1261,7 @@ wxSocketBase& wxSocketBase::Discard() delete[] buffer; m_lcount = total; - m_error = false; - - // Allow read events again - m_reading = false; + SetError(wxSOCKET_NOERROR); return *this; } @@ -720,40 +1270,127 @@ wxSocketBase& wxSocketBase::Discard() // Wait functions // -------------------------------------------------------------------------- -// 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 runs the event loop so that -// this won't block the GUI. - -bool -wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) +/* + This function will check for the events specified in the flags parameter, + and it will return a mask indicating which operations can be performed. + */ +wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags, + const timeval *timeout) { - wxCHECK_MSG( m_socket, false, "can't wait on invalid socket" ); + if ( m_fd == INVALID_SOCKET ) + return (wxSOCKET_LOST_FLAG & flags); - // This can be set to true from Interrupt() to exit this function a.s.a.p. - m_interrupt = false; + struct timeval tv; + if ( timeout ) + tv = *timeout; + else + tv.tv_sec = tv.tv_usec = 0; + + // prepare the FD sets, passing NULL for the one(s) we don't use + fd_set + readfds, *preadfds = NULL, + writefds, *pwritefds = NULL, + exceptfds; // always want to know about errors + + if ( flags & wxSOCKET_INPUT_FLAG ) + { + preadfds = &readfds; + 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) ) + { + pwritefds = &writefds; + wxFD_ZERO(pwritefds); + wxFD_SET(m_fd, pwritefds); + } + + wxFD_ZERO(&exceptfds); + wxFD_SET(m_fd, &exceptfds); + + const int rc = select(m_fd + 1, preadfds, pwritefds, &exceptfds, &tv); + + // check for errors first + if ( rc == -1 || wxFD_ISSET(m_fd, &exceptfds) ) + { + m_establishing = false; + + return wxSOCKET_LOST_FLAG & flags; + } + + if ( rc == 0 ) + return 0; + + wxASSERT_MSG( rc == 1, "unexpected select() return value" ); + + wxSocketEventFlags detected = 0; + if ( preadfds && wxFD_ISSET(m_fd, preadfds) ) + detected |= wxSOCKET_INPUT_FLAG; + + if ( pwritefds && wxFD_ISSET(m_fd, pwritefds) ) + { + // check for the case of non-blocking connect() + if ( m_establishing && !m_server ) + { + int error; + SOCKOPTLEN_T len = sizeof(error); + m_establishing = false; + getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len); + + if ( error ) + detected = wxSOCKET_LOST_FLAG; + else + detected |= wxSOCKET_CONNECTION_FLAG; + } + else // not called to get non-blocking connect() status + { + detected |= wxSOCKET_OUTPUT_FLAG; + } + } + return detected & flags; +} +int +wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) +{ // Use either the provided timeout or the default timeout value associated // with this socket. // // TODO: allow waiting forever, see #9443 const long timeout = seconds == -1 ? m_timeout * 1000 : seconds * 1000 + milliseconds; + + return DoWait(timeout, flags); +} + +int +wxSocketBase::DoWait(long timeout, wxSocketEventFlags flags) +{ + wxCHECK_MSG( m_impl, -1, "can't wait on invalid socket" ); + + // we're never going to become ready in a 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) + if ( !m_impl->IsServer() && !m_connected && !m_establishing ) + return -1; + + // This can be set to true from Interrupt() to exit this function a.s.a.p. + m_interrupt = false; + + const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout; // Get the active event loop which we'll use for the message dispatching - // when running in the main thread + // when running in the main thread unless this was explicitly disabled by + // setting wxSOCKET_BLOCK flag wxEventLoopBase *eventLoop; - if ( wxIsMainThread() ) + if ( !(m_flags & wxSOCKET_BLOCK) && wxIsMainThread() ) { eventLoop = wxEventLoop::GetActive(); - -#ifdef __WXMSW__ - wxASSERT_MSG( eventLoop, - "Sockets won't work without a running event loop" ); -#endif // __WXMSW__ } else // in worker thread { @@ -761,81 +1398,93 @@ wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags) eventLoop = NULL; } - // Wait in an active polling loop: notice that the loop is executed at - // least once, even if timeout is 0 (i.e. polling). - bool gotEvent = false; - for ( ;; ) - { - // We always stop waiting when the connection is lost as it doesn't - // make sense to continue further, even if GSOCK_LOST_FLAG is not - // specified in flags to wait for. - const GSocketEventFlags - result = m_socket->Select(flags | GSOCK_LOST_FLAG); + // Make sure the events we're interested in are enabled before waiting for + // them: this is really necessary here as otherwise this could happen: + // 1. DoRead(wxSOCKET_WAITALL) is called + // 2. There is nothing to read so DoWait(wxSOCKET_INPUT_FLAG) is called + // 3. Some, but not all data appears, wxSocketImplUnix::OnReadWaiting() + // is called and wxSOCKET_INPUT_FLAG events are disabled in it + // 4. Because of wxSOCKET_WAITALL we call DoWait() again but the events + // are still disabled and we block forever + // + // More elegant solution would be nice but for now simply re-enabling the + // events here will do + m_impl->ReenableEvents(flags & (wxSOCKET_INPUT_FLAG | wxSOCKET_OUTPUT_FLAG)); - // Incoming connection (server) or connection established (client)? - if ( result & GSOCK_CONNECTION_FLAG ) + + // Wait until we receive the event we're waiting for or the timeout expires + // (but note that we always execute the loop at least once, even if timeout + // is 0 as this is used for polling) + int rc = 0; + for ( bool firstTime = true; !m_interrupt; firstTime = false ) + { + long timeLeft = wxMilliClockToLong(timeEnd - wxGetLocalTimeMillis()); + if ( timeLeft < 0 ) { - m_connected = true; - m_establishing = false; - gotEvent = true; - break; + if ( !firstTime ) + break; // timed out + + timeLeft = 0; } - // Data available or output buffer ready? - if ( (result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG) ) + wxSocketEventFlags events; + if ( eventLoop ) { - gotEvent = true; - break; + // reset them before starting to wait + m_eventsgot = 0; + + eventLoop->DispatchTimeout(timeLeft); + + events = m_eventsgot; + } + else // no event loop or waiting in another thread + { + // as explained below, we should always check for wxSOCKET_LOST_FLAG + timeval tv; + SetTimeValFromMS(tv, timeLeft); + events = m_impl->Select(flags | wxSOCKET_LOST_FLAG, &tv); } - // Connection lost - if ( result & GSOCK_LOST_FLAG ) + // always check for wxSOCKET_LOST_FLAG, even if flags doesn't include + // it, as continuing to wait for anything else after getting it is + // pointless + if ( events & wxSOCKET_LOST_FLAG ) { m_connected = false; m_establishing = false; - if ( flags & GSOCK_LOST_FLAG ) - gotEvent = true; + rc = -1; break; } - if ( m_interrupt ) - break; - - // Wait more? - const wxMilliClock_t timeNow = wxGetLocalTimeMillis(); - if ( timeNow >= timeEnd ) - break; + // otherwise mask out the bits we're not interested in + events &= flags; - if ( eventLoop ) + // Incoming connection (server) or connection established (client)? + if ( events & wxSOCKET_CONNECTION_FLAG ) { - // Dispatch the events when we run in the main thread and have an - // active event loop: without this sockets don't work at all under - // MSW as socket flags are only updated when socket messages are - // processed. - if ( eventLoop->Pending() ) - eventLoop->Dispatch(); + m_connected = true; + m_establishing = false; + rc = true; + break; } -#if wxUSE_THREADS - else // no event loop or waiting in another thread + + // Data available or output buffer ready? + if ( (events & wxSOCKET_INPUT_FLAG) || (events & wxSOCKET_OUTPUT_FLAG) ) { - // We're busy waiting but at least give up the rest of our current - // time slice. - wxThread::Yield(); + rc = true; + break; } -#endif // wxUSE_THREADS } - return gotEvent; + return rc; } bool wxSocketBase::Wait(long seconds, long milliseconds) { return DoWait(seconds, milliseconds, - GSOCK_INPUT_FLAG | - GSOCK_OUTPUT_FLAG | - GSOCK_CONNECTION_FLAG | - GSOCK_LOST_FLAG - ); + wxSOCKET_INPUT_FLAG | + wxSOCKET_OUTPUT_FLAG | + wxSOCKET_CONNECTION_FLAG) != 0; } bool wxSocketBase::WaitForRead(long seconds, long milliseconds) @@ -844,22 +1493,28 @@ bool wxSocketBase::WaitForRead(long seconds, long milliseconds) if ( m_unread ) return true; - // Note that GSOCK_INPUT_LOST has to be explicitly passed to DoWait - // because 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 DoWait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG); + // Check if the socket is not already ready for input, if it is, there is + // no need to start waiting for it (worse, we'll actually never get a + // notification about the socket becoming ready if it is already under + // Windows) + if ( m_impl->Select(wxSOCKET_INPUT_FLAG) ) + return true; + + return DoWait(seconds, milliseconds, wxSOCKET_INPUT_FLAG) != 0; } bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) { - return DoWait(seconds, milliseconds, GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG); + if ( m_impl->Select(wxSOCKET_OUTPUT_FLAG) ) + return true; + + return DoWait(seconds, milliseconds, wxSOCKET_OUTPUT_FLAG) != 0; } bool wxSocketBase::WaitForLost(long seconds, long milliseconds) { - return DoWait(seconds, milliseconds, GSOCK_LOST_FLAG); + return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG) == -1; } // -------------------------------------------------------------------------- @@ -870,36 +1525,28 @@ bool wxSocketBase::WaitForLost(long seconds, long milliseconds) // Get local or peer address // -bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const +bool wxSocketBase::GetPeer(wxSockAddress& addr) const { - GAddress *peer; - - if (!m_socket) - return false; - - peer = m_socket->GetPeer(); + wxCHECK_MSG( m_impl, false, "invalid socket" ); - // copying a null address would just trigger an assert anyway - - if (!peer) + const wxSockAddressImpl& peer = m_impl->GetPeer(); + if ( !peer.IsOk() ) return false; - addr_man.SetAddress(peer); - GAddress_destroy(peer); + addr.SetAddress(peer); return true; } -bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const +bool wxSocketBase::GetLocal(wxSockAddress& addr) const { - GAddress *local; + wxCHECK_MSG( m_impl, false, "invalid socket" ); - if (!m_socket) + const wxSockAddressImpl& local = m_impl->GetLocal(); + if ( !local.IsOk() ) return false; - local = m_socket->GetLocal(); - addr_man.SetAddress(local); - GAddress_destroy(local); + addr.SetAddress(local); return true; } @@ -950,8 +1597,8 @@ void wxSocketBase::SetTimeout(long seconds) { m_timeout = seconds; - if (m_socket) - m_socket->SetTimeout(m_timeout * 1000); + if (m_impl) + m_impl->SetTimeout(m_timeout * 1000); } void wxSocketBase::SetFlags(wxSocketFlags flags) @@ -971,97 +1618,72 @@ void wxSocketBase::SetFlags(wxSocketFlags flags) // Event handling // -------------------------------------------------------------------------- -// 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) notification); -} - void wxSocketBase::OnRequest(wxSocketNotify notification) { - switch(notification) + wxSocketEventFlags flag = 0; + switch ( notification ) { - case wxSOCKET_CONNECTION: - m_establishing = false; - m_connected = true; - break; - - // 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 || !m_socket->Select(GSOCK_INPUT_FLAG)) - return; + flag = wxSOCKET_INPUT_FLAG; break; case wxSOCKET_OUTPUT: - if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG)) - return; + flag = wxSOCKET_OUTPUT_FLAG; break; - case wxSOCKET_LOST: - m_connected = false; + case wxSOCKET_CONNECTION: + flag = wxSOCKET_CONNECTION_FLAG; + + // we're now successfully connected + m_connected = true; m_establishing = false; + + // error was previously set to wxSOCKET_WOULDBLOCK, but this is not + // the case any longer + SetError(wxSOCKET_NOERROR); break; - } - // Schedule the event + case wxSOCKET_LOST: + flag = wxSOCKET_LOST_FLAG; + + // if we lost the connection the socket is now closed and not + // connected any more + m_connected = false; + m_closed = true; + break; - 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; default: - wxLogWarning(_("wxSocket: unknown event!.")); - return; + wxFAIL_MSG( "unknown wxSocket notification" ); } - if (((m_eventmask & flag) == flag) && m_notify) + // remember the events which were generated for this socket, we're going to + // use this in DoWait() + m_eventsgot |= flag; + + // send the wx event if enabled and we're interested in it + if ( m_notify && (m_eventmask & flag) && m_handler ) { - if (m_handler) + // don't generate the events when we're inside DoWait() called from our + // own code as we are going to consume the data that has just become + // available ourselves and the user code won't see it at all + if ( (notification == wxSOCKET_INPUT && m_reading) || + (notification == wxSOCKET_OUTPUT && m_writing) ) { - wxSocketEvent event(m_id); - event.m_event = notification; - event.m_clientData = m_clientData; - event.SetEventObject(this); - - m_handler->AddPendingEvent(event); + return; } + + wxSocketEvent event(m_id); + event.m_event = notification; + event.m_clientData = m_clientData; + event.SetEventObject(this); + + m_handler->AddPendingEvent(event); } } void wxSocketBase::Notify(bool notify) { m_notify = notify; - if (m_socket) - m_socket->Notify(notify); } void wxSocketBase::SetNotify(wxSocketEventFlags flags) @@ -1137,49 +1759,44 @@ wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek) // Ctor // -------------------------------------------------------------------------- -wxSocketServer::wxSocketServer(const wxSockAddress& addr_man, +wxSocketServer::wxSocketServer(const wxSockAddress& addr, wxSocketFlags flags) : wxSocketBase(flags, wxSOCKET_SERVER) { - wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") ); + wxLogTrace( wxTRACE_Socket, wxT("Opening wxSocketServer") ); - m_socket = GSocket_new(); + wxSocketManager * const manager = wxSocketManager::Get(); + m_impl = manager ? manager->CreateSocket(*this) : NULL; - if (!m_socket) + if (!m_impl) { - wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") ); + wxLogTrace( wxTRACE_Socket, wxT("*** Failed to create m_impl") ); return; } // Setup the socket as server - m_socket->Notify(m_notify); - m_socket->SetLocal(addr_man.GetAddress()); + m_impl->SetLocal(addr.GetAddress()); if (GetFlags() & wxSOCKET_REUSEADDR) { - m_socket->SetReusable(); + m_impl->SetReusable(); } if (GetFlags() & wxSOCKET_BROADCAST) { - m_socket->SetBroadcast(); + m_impl->SetBroadcast(); } if (GetFlags() & wxSOCKET_NOBIND) { - m_socket->DontDoBind(); + m_impl->DontDoBind(); } - if (m_socket->SetServer() != GSOCK_NOERROR) + if (m_impl->CreateServer() != wxSOCKET_NOERROR) { - delete m_socket; - m_socket = NULL; + delete m_impl; + m_impl = NULL; - wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") ); + wxLogTrace( wxTRACE_Socket, wxT("*** CreateServer() failed") ); return; } - m_socket->SetTimeout(m_timeout * 1000); - m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char *)this); - - wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_socket->m_fd ); + wxLogTrace( wxTRACE_Socket, wxT("wxSocketServer on fd %d"), m_impl->m_fd ); } // -------------------------------------------------------------------------- @@ -1188,27 +1805,38 @@ wxSocketServer::wxSocketServer(const wxSockAddress& addr_man, bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { - if (!m_socket) + if ( !m_impl || (m_impl->m_fd == INVALID_SOCKET) || !m_impl->IsServer() ) + { + wxFAIL_MSG( "can only be called for a valid server socket" ); + + SetError(wxSOCKET_INVSOCK); + return false; + } + + if ( wait ) + { + // wait until we get a connection + if ( !m_impl->SelectWithTimeout(wxSOCKET_INPUT_FLAG) ) + { + SetError(wxSOCKET_TIMEDOUT); - // If wait == false, then the call should be nonblocking. - // When we are finished, we put the socket to blocking mode - // again. - wxSocketUnblocker unblock(m_socket, !wait); - GSocket * const child_socket = m_socket->WaitConnection(); + return false; + } + } + + sock.m_impl = m_impl->Accept(sock); + + if ( !sock.m_impl ) + { + SetError(m_impl->GetLastError()); - if (!child_socket) return false; + } sock.m_type = wxSOCKET_BASE; - sock.m_socket = child_socket; sock.m_connected = true; - sock.m_socket->SetTimeout(sock.m_timeout * 1000); - sock.m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char *)&sock); - return true; } @@ -1229,47 +1857,37 @@ wxSocketBase *wxSocketServer::Accept(bool wait) bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) { - return DoWait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); + return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) == 1; } bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen) { - wxASSERT_MSG( m_socket, _T("Socket not initialised") ); + wxASSERT_MSG( m_impl, wxT("Socket not initialised") ); - if (m_socket->GetSockOpt(level, optname, optval, optlen) - != GSOCK_NOERROR) - { + SOCKOPTLEN_T lenreal = *optlen; + if ( getsockopt(m_impl->m_fd, level, optname, + static_cast(optval), &lenreal) != 0 ) return false; - } + + *optlen = lenreal; + return true; } -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_socket, _T("Socket not initialised") ); + wxASSERT_MSG( m_impl, wxT("Socket not initialised") ); - if (m_socket->SetSockOpt(level, optname, optval, optlen) - != GSOCK_NOERROR) - { - return false; - } - return true; + return setsockopt(m_impl->m_fd, level, optname, + static_cast(optval), optlen) == 0; } bool wxSocketBase::SetLocal(const wxIPV4address& local) { - GAddress* la = local.GetAddress(); - - // If the address is valid, save it for use when we call Connect - if (la && la->m_addr) - { - m_localAddress = local; - - return true; - } + m_localAddress = local; - return false; + return true; } // ========================================================================== @@ -1287,89 +1905,61 @@ wxSocketClient::wxSocketClient(wxSocketFlags flags) m_initialSendBufferSize = -1; } -wxSocketClient::~wxSocketClient() -{ -} - // -------------------------------------------------------------------------- // Connect // -------------------------------------------------------------------------- -bool wxSocketClient::DoConnect(const wxSockAddress& addr_man, +bool wxSocketClient::DoConnect(const wxSockAddress& remote, const wxSockAddress* local, bool wait) { - if (m_socket) + if ( m_impl ) { - // Shutdown and destroy the socket + // Shutdown and destroy the old socket Close(); - delete m_socket; + delete m_impl; } - m_socket = GSocket_new(); m_connected = false; m_establishing = false; - if (!m_socket) + // Create and set up the new one + wxSocketManager * const manager = wxSocketManager::Get(); + m_impl = manager ? manager->CreateSocket(*this) : NULL; + if ( !m_impl ) return false; - m_socket->SetTimeout(m_timeout * 1000); - m_socket->SetCallback( - GSOCK_INPUT_FLAG | - GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | - GSOCK_CONNECTION_FLAG, - wx_socket_callback, - (char *)this - ); - - // If wait == false, then the call should be nonblocking. When we are - // finished, we put the socket to blocking mode again. - wxSocketUnblocker unblock(m_socket, !wait); - // Reuse makes sense for clients too, if we are trying to rebind to the same port if (GetFlags() & wxSOCKET_REUSEADDR) - { - m_socket->SetReusable(); - } + m_impl->SetReusable(); if (GetFlags() & wxSOCKET_BROADCAST) - { - m_socket->SetBroadcast(); - } + m_impl->SetBroadcast(); if (GetFlags() & wxSOCKET_NOBIND) - { - m_socket->DontDoBind(); - } + m_impl->DontDoBind(); - // If no local address was passed and one has been set, use the one that was Set - if (!local && m_localAddress.GetAddress()) - { + // Bind to the local IP address and port, when provided or if one had been + // set before + if ( !local && m_localAddress.GetAddress().IsOk() ) local = &m_localAddress; - } - // Bind to the local IP address and port, when provided - if (local) - { - GAddress* la = local->GetAddress(); - - if (la && la->m_addr) - m_socket->SetLocal(la); - } + if ( local ) + m_impl->SetLocal(local->GetAddress()); -#if defined(__WXMSW__) || defined(__WXGTK__) - m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); -#endif + m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize); - m_socket->SetPeer(addr_man.GetAddress()); - const GSocketError err = m_socket->Connect(GSOCK_STREAMED); + m_impl->SetPeer(remote.GetAddress()); - //this will register for callbacks - must be called after m_socket->m_fd was initialized - m_socket->Notify(m_notify); + // Finally do create the socket and connect to the peer + const wxSocketError err = m_impl->CreateClient(wait); - if (err != GSOCK_NOERROR) + if ( err != wxSOCKET_NOERROR ) { - if (err == GSOCK_WOULDBLOCK) + if ( err == wxSOCKET_WOULDBLOCK ) + { + wxASSERT_MSG( !wait, "shouldn't get this for blocking connect" ); + m_establishing = true; + } return false; } @@ -1378,16 +1968,16 @@ bool wxSocketClient::DoConnect(const wxSockAddress& addr_man, return true; } -bool wxSocketClient::Connect(const wxSockAddress& addr_man, bool wait) +bool wxSocketClient::Connect(const wxSockAddress& remote, bool wait) { - return DoConnect(addr_man, NULL, wait); + return DoConnect(remote, NULL, wait); } -bool wxSocketClient::Connect(const wxSockAddress& addr_man, +bool wxSocketClient::Connect(const wxSockAddress& remote, const wxSockAddress& local, bool wait) { - return DoConnect(addr_man, &local, wait); + return DoConnect(remote, &local, wait); } bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) @@ -1399,64 +1989,55 @@ bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) return true; } - wxCHECK_MSG( m_establishing && m_socket, false, + wxCHECK_MSG( m_establishing && m_impl, false, "No connection establishment attempt in progress" ); - // we must specify GSOCK_LOST_FLAG here explicitly because we must return - // true if the connection establishment process is finished, whether it is - // over because we successfully connected or because we were not able to - // connect - return DoWait(seconds, milliseconds, - GSOCK_CONNECTION_FLAG | GSOCK_LOST_FLAG); + // notice that we return true even if DoWait() returned -1, i.e. if an + // error occurred and connection was lost: this is intentional as we should + // return false only if timeout expired without anything happening + return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) != 0; } // ========================================================================== // wxDatagramSocket // ========================================================================== -/* NOTE: experimental stuff - might change */ - wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr, wxSocketFlags flags ) : wxSocketBase( flags, wxSOCKET_DATAGRAM ) { // Create the socket - m_socket = GSocket_new(); + wxSocketManager * const manager = wxSocketManager::Get(); + m_impl = manager ? manager->CreateSocket(*this) : NULL; - if (!m_socket) - { - wxFAIL_MSG( _T("datagram socket not new'd") ); + if (!m_impl) return; - } - m_socket->Notify(m_notify); + // Setup the socket as non connection oriented - m_socket->SetLocal(addr.GetAddress()); + m_impl->SetLocal(addr.GetAddress()); if (flags & wxSOCKET_REUSEADDR) { - m_socket->SetReusable(); + m_impl->SetReusable(); } if (GetFlags() & wxSOCKET_BROADCAST) { - m_socket->SetBroadcast(); + m_impl->SetBroadcast(); } if (GetFlags() & wxSOCKET_NOBIND) { - m_socket->DontDoBind(); + m_impl->DontDoBind(); } - if ( m_socket->SetNonOriented() != GSOCK_NOERROR ) + + if ( m_impl->CreateUDP() != wxSOCKET_NOERROR ) { - delete m_socket; - m_socket = NULL; + delete m_impl; + m_impl = NULL; return; } // Initialize all stuff m_connected = false; m_establishing = false; - m_socket->SetTimeout( m_timeout ); - m_socket->SetCallback( GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, - wx_socket_callback, (char*)this ); } wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, @@ -1472,9 +2053,9 @@ wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr, const void* buf, wxUint32 nBytes ) { - wxASSERT_MSG( m_socket, _T("Socket not initialised") ); + wxASSERT_MSG( m_impl, wxT("Socket not initialised") ); - m_socket->SetPeer(addr.GetAddress()); + m_impl->SetPeer(addr.GetAddress()); Write(buf, nBytes); return (*this); } @@ -1488,7 +2069,8 @@ class wxSocketModule : public wxModule public: virtual bool OnInit() { - // wxSocketBase will call GSocket_Init() itself when/if needed + // wxSocketBase will call Initialize() itself only if sockets are + // really used, don't do it from here return true; } @@ -1504,4 +2086,21 @@ private: IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) +#if defined(wxUSE_SELECT_DISPATCHER) && wxUSE_SELECT_DISPATCHER +// NOTE: we need to force linking against socketiohandler.cpp otherwise in +// static builds of wxWidgets the ManagerSetter::ManagerSetter ctor +// contained there wouldn't be ever called +wxFORCE_LINK_MODULE( socketiohandler ) +#endif + +// same for ManagerSetter in the MSW file +#ifdef __WXMSW__ + wxFORCE_LINK_MODULE( mswsocket ) +#endif + +// and for OSXManagerSetter in the OS X one +#ifdef __WXOSX__ + wxFORCE_LINK_MODULE( osxsocket ) +#endif + #endif // wxUSE_SOCKETS