// 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
/////////////////////////////////////////////////////////////////////////////
// ==========================================================================
#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"
// 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)
- #error "Writing to socket could generate unhandled SIGPIPE."
- #error "Please post information about your system to wx-dev."
- #endif
+ 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
// 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
public:
wxSocketState() : wxObject() {}
- DECLARE_NO_COPY_CLASS(wxSocketState)
+ wxDECLARE_NO_COPY_CLASS(wxSocketState);
+};
+
+// wxSocketWaitModeChanger: temporarily change the socket flags affecting its
+// wait mode
+class wxSocketWaitModeChanger
+{
+public:
+ // 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_oldflags(socket->GetFlags())
+
+ {
+ // 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
+ // 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);
+ }
+
+ ~wxSocketWaitModeChanger()
+ {
+ m_socket->SetFlags(m_oldflags);
+ }
+
+private:
+ wxSocketBase * const m_socket;
+ const int m_oldflags;
+
+ 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);
};
// ============================================================================
: m_wxsocket(&wxsocket)
{
m_fd = INVALID_SOCKET;
- m_local = NULL;
- m_peer = NULL;
m_error = wxSOCKET_NOERROR;
m_server = false;
m_stream = true;
wxSocketImpl::~wxSocketImpl()
{
- if (m_fd != INVALID_SOCKET)
+ if ( m_fd != INVALID_SOCKET )
Shutdown();
-
- if (m_local)
- GAddress_destroy(m_local);
-
- if (m_peer)
- GAddress_destroy(m_peer);
}
-bool wxSocketImpl::PreCreateCheck(GAddress *addr)
+bool wxSocketImpl::PreCreateCheck(const wxSockAddressImpl& addr)
{
if ( m_fd != INVALID_SOCKET )
{
return false;
}
- if ( !addr || !addr->m_addr )
+ if ( !addr.IsOk() )
{
m_error = wxSOCKET_INVADDR;
return false;
wxSocketError wxSocketImpl::UpdateLocalAddress()
{
- WX_SOCKLEN_T lenAddr = sizeof(*m_local->m_addr);
- if ( getsockname(m_fd, m_local->m_addr, &lenAddr) != 0 )
+ 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;
}
- m_local->m_len = lenAddr;
-
return wxSOCKET_NOERROR;
}
m_stream = true;
// do create the socket
- m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0);
+ m_fd = socket(m_local.GetFamily(), SOCK_STREAM, 0);
if ( m_fd == INVALID_SOCKET )
{
// and then bind to and listen on it
//
// FIXME: should we test for m_dobind here?
- if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 )
m_error = wxSOCKET_IOERR;
if ( IsOk() )
if ( !PreCreateCheck(m_peer) )
return m_error;
- m_fd = socket(m_peer->m_realfamily, SOCK_STREAM, 0);
+ m_fd = socket(m_peer.GetFamily(), SOCK_STREAM, 0);
if ( m_fd == INVALID_SOCKET )
{
PostCreation();
// If a local address has been set, then bind to it before calling connect
- if ( m_local && m_local->m_addr )
+ if ( m_local.IsOk() )
{
- if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 )
{
Close();
m_error = wxSOCKET_IOERR;
}
// Do connect now
- int rc = connect(m_fd, m_peer->m_addr, m_peer->m_len);
+ int rc = connect(m_fd, m_peer.GetAddr(), m_peer.GetLen());
if ( rc == SOCKET_ERROR )
{
wxSocketError err = GetLastError();
m_stream = false;
m_server = false;
- m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0);
+ m_fd = socket(m_local.GetFamily(), SOCK_DGRAM, 0);
if ( m_fd == INVALID_SOCKET )
{
if ( m_dobind )
{
- if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 )
{
Close();
m_error = wxSOCKET_IOERR;
wxSocketImpl *wxSocketImpl::Accept(wxSocketBase& wxsocket)
{
- wxSockAddr from;
+ wxSockAddressStorage from;
WX_SOCKLEN_T fromlen = sizeof(from);
- const SOCKET fd = accept(m_fd, &from, &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
+ ReenableEvents(wxSOCKET_INPUT_FLAG);
if ( fd == INVALID_SOCKET )
return NULL;
- wxSocketImpl * const sock = Create(wxsocket);
- sock->m_fd = fd;
+ wxSocketManager * const manager = wxSocketManager::Get();
+ if ( !manager )
+ return NULL;
+
+ wxSocketImpl * const sock = manager->CreateSocket(wxsocket);
+ if ( !sock )
+ return NULL;
- sock->m_peer = GAddress_new();
- _GAddress_translate_from(sock->m_peer, &from, fromlen);
+ sock->m_fd = fd;
+ sock->m_peer = wxSockAddressImpl(from.addr, fromlen);
sock->UnblockAndRegisterWithEventLoop();
}
}
-/*
- * Disallow further read/write operations on this socket, close
- * the fd and disable all callbacks.
- */
void wxSocketImpl::Shutdown()
{
if ( m_fd != INVALID_SOCKET )
}
/* Address handling */
-
-/*
- * Set or get the local or peer address for this socket. The 'set'
- * functions return wxSOCKET_NOERROR on success, an error code otherwise.
- * The 'get' functions return a pointer to a GAddress object on success,
- * or NULL otherwise, in which case they set the error code of the
- * corresponding socket.
- *
- * Error codes:
- * wxSOCKET_INVSOCK - the socket is not valid.
- * wxSOCKET_INVADDR - the address is not valid.
- */
-wxSocketError wxSocketImpl::SetLocal(GAddress *address)
+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;
- }
-
- /* check address */
- if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
- {
- m_error = wxSOCKET_INVADDR;
- return wxSOCKET_INVADDR;
- }
-
- if (m_local)
- GAddress_destroy(m_local);
-
- m_local = GAddress_copy(address);
-
- return wxSOCKET_NOERROR;
-}
-
-wxSocketError wxSocketImpl::SetPeer(GAddress *address)
-{
- /* check address */
- if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
- {
- m_error = wxSOCKET_INVADDR;
- return wxSOCKET_INVADDR;
- }
+ /* 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 (m_peer)
- GAddress_destroy(m_peer);
+ if ( !local.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
- m_peer = GAddress_copy(address);
+ m_local = local;
- return wxSOCKET_NOERROR;
+ return wxSOCKET_NOERROR;
}
-GAddress *wxSocketImpl::GetLocal()
+wxSocketError wxSocketImpl::SetPeer(const wxSockAddressImpl& peer)
{
- GAddress *address;
- wxSockAddr addr;
- WX_SOCKLEN_T size = sizeof(addr);
- wxSocketError err;
-
- /* try to get it from the m_local var first */
- if (m_local)
- return GAddress_copy(m_local);
-
- /* else, if the socket is initialized, try getsockname */
- if (m_fd == INVALID_SOCKET)
- {
- m_error = wxSOCKET_INVSOCK;
- return NULL;
- }
-
- if (getsockname(m_fd, (sockaddr*)&addr, &size) == SOCKET_ERROR)
- {
- m_error = wxSOCKET_IOERR;
- return NULL;
- }
-
- /* got a valid address from getsockname, create a GAddress object */
- if ((address = GAddress_new()) == NULL)
- {
- m_error = wxSOCKET_MEMERR;
- return NULL;
- }
+ if ( !peer.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
- if ((err = _GAddress_translate_from(address, (sockaddr*)&addr, size)) != wxSOCKET_NOERROR)
- {
- GAddress_destroy(address);
- m_error = err;
- return NULL;
- }
+ m_peer = peer;
- return address;
+ return wxSOCKET_NOERROR;
}
-GAddress *wxSocketImpl::GetPeer()
+const wxSockAddressImpl& wxSocketImpl::GetLocal()
{
- /* try to get it from the m_peer var */
- if (m_peer)
- return GAddress_copy(m_peer);
+ if ( !m_local.IsOk() )
+ UpdateLocalAddress();
- return NULL;
+ return m_local;
}
// ----------------------------------------------------------------------------
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<const char *>(buffer), size,
wxSOCKET_MSG_NOSIGNAL) );
int wxSocketImpl::RecvDgram(void *buffer, int size)
{
- wxSockAddr from;
+ wxSockAddressStorage from;
WX_SOCKLEN_T fromlen = sizeof(from);
int ret;
DO_WHILE_EINTR( ret, recvfrom(m_fd, static_cast<char *>(buffer), size,
- 0, &from, &fromlen) );
+ 0, &from.addr, &fromlen) );
if ( ret == SOCKET_ERROR )
return SOCKET_ERROR;
- /* Translate a system address into a wxSocketImpl address */
- if ( !m_peer )
- m_peer = GAddress_new();
-
- m_error = _GAddress_translate_from(m_peer, &from, fromlen);
- if ( m_error != wxSOCKET_NOERROR )
- {
- GAddress_destroy(m_peer);
- m_peer = NULL;
+ 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 )
+ if ( !m_peer.IsOk() )
{
m_error = wxSOCKET_INVADDR;
return -1;
}
- struct sockaddr *addr;
- int len;
- m_error = _GAddress_translate_to(m_peer, &addr, &len);
- if ( m_error != wxSOCKET_NOERROR )
- return -1;
-
int ret;
DO_WHILE_EINTR( ret, sendto(m_fd, static_cast<const char *>(buffer), size,
- 0, addr, len) );
-
- free(addr);
+ 0, m_peer.GetAddr(), m_peer.GetLen()) );
return ret;
}
// 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++ )
+ wxCHECK_MSG( wxIsMainThread(), false,
+ "must be called from the main thread" );
+
+ if ( !gs_socketInitCount )
{
wxSocketManager * const manager = wxSocketManager::Get();
if ( !manager || !manager->OnInit() )
- {
- m_countInit--;
-
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 )
{
wxSocketManager * const manager = wxSocketManager::Get();
wxCHECK_RET( manager, "should have a socket manager" );
void wxSocketBase::Init()
{
- m_impl = NULL;
+ m_impl = NULL;
m_type = wxSOCKET_UNINIT;
// state
m_writing =
m_closed = false;
m_lcount = 0;
+ m_lcount_read = 0;
+ m_lcount_write = 0;
m_timeout = 600;
m_beingDeleted = false;
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"));
+ }
}
}
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();
delete m_impl;
// Free the pushback buffer
- if (m_unread)
- free(m_unread);
+ free(m_unread);
}
bool wxSocketBase::Destroy()
// 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
+ // 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 )
{
- // 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;
// Interrupt pending waits
InterruptWait();
- if (m_impl)
- m_impl->Shutdown();
+ ShutdownOutput();
m_connected = false;
m_establishing = false;
return true;
}
-wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
+void wxSocketBase::ShutdownOutput()
{
- // Mask read events
- m_reading = true;
+ if ( m_impl )
+ m_impl->Shutdown();
+}
- m_lcount = DoRead(buffer, nbytes);
+wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
+{
+ wxSocketReadGuard read(this);
- // Allow read events from now on
- m_reading = false;
+ m_lcount_read = DoRead(buffer, nbytes);
+ m_lcount = m_lcount_read;
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<char *>(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
nbytes -= total;
buffer += total;
- // If it's indeed closed or if read everything, there is nothing more to do.
- if ( !m_impl || !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 )
+ while ( nbytes )
{
- int ret = m_impl->Read(buffer, nbytes);
+ // 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 )
{
- if ( m_impl->GetLastError() != wxSOCKET_WOULDBLOCK )
- SetError(wxSOCKET_IOERR);
- }
- else // not an error, even if we didn't read anything
- {
- total += ret;
- }
- }
- else // blocking socket
- {
- for ( ;; )
- {
- // Wait until socket becomes ready for reading
- if ( !WaitForRead() )
- break;
-
- const int ret = m_impl->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_READ )
+ {
+ // this shouldn't be counted as an error in this case
+ SetError(wxSOCKET_NOERROR);
+ break;
+ }
- if ( ret == -1 )
+ // 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;
+ }
+ else // "real" error
{
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_READ) || !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;
-
- // Otherwise continue reading until we do read everything.
- nbytes -= ret;
- if ( !nbytes )
- break;
+ total += ret;
- buffer += ret;
- }
+ // if we are happy to read something and not the entire nbytes bytes,
+ // then we're done
+ if ( !(m_flags & wxSOCKET_WAITALL_READ) )
+ break;
- // it's an error to not read everything in wxSOCKET_WAITALL mode or to
- // not read anything otherwise
- if ( ((m_flags & wxSOCKET_WAITALL) && nbytes) || !total )
- SetError(wxSOCKET_IOERR);
+ nbytes -= ret;
+ buffer += ret;
}
return total;
unsigned char len[4];
} msg;
- // Mask read events
- m_reading = true;
+ wxSocketReadGuard read(this);
- int old_flags = m_flags;
- SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL_READ);
bool ok = false;
if ( DoRead(&msg, sizeof(msg)) == sizeof(msg) )
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 ( !ok )
SetError(wxSOCKET_IOERR);
- m_reading = false;
- SetFlags(old_flags);
-
return *this;
}
wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
- // Mask read events
- m_reading = true;
+ wxSocketReadGuard read(this);
+
+ // Peek() should never block
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT);
m_lcount = DoRead(buffer, nbytes);
- Pushback(buffer, m_lcount);
- // 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;
-
- m_lcount = DoWrite(buffer, nbytes);
+ wxSocketWriteGuard write(this);
- // Allow write events again
- m_writing = false;
+ m_lcount_write = DoWrite(buffer, nbytes);
+ m_lcount = m_lcount_write;
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<const char *>(buffer_);
-
- // Return if there is nothing to read or the socket is (already?) closed.
- if ( !m_impl || !nbytes )
- return 0;
+ wxCHECK_MSG( m_impl, 0, "socket must be valid" );
+ const char *buffer = static_cast<const char *>(buffer_);
wxCHECK_MSG( buffer, 0, "NULL buffer" );
wxUint32 total = 0;
- if ( m_flags & wxSOCKET_NOWAIT )
+ while ( nbytes )
{
- const int ret = m_impl->Write(buffer, nbytes);
- if ( ret == -1 )
+ if ( m_impl->m_stream && !m_connected )
{
- if ( m_impl->GetLastError() != wxSOCKET_WOULDBLOCK )
+ if ( (m_flags & wxSOCKET_WAITALL_WRITE) || !total )
SetError(wxSOCKET_IOERR);
+ break;
}
- else
- {
- total += ret;
- }
- }
- else // blocking socket
- {
- for ( ;; )
- {
- if ( !WaitForWrite() )
- break;
- const int ret = m_impl->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_WRITE )
+ break;
+
+ if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) )
+ {
+ SetError(wxSOCKET_TIMEDOUT);
+ break;
+ }
- if ( ret == -1 )
+ continue;
+ }
+ else // "real" error
{
SetError(wxSOCKET_IOERR);
break;
}
+ }
- total += ret;
- if ( !(m_flags & wxSOCKET_WAITALL) )
- break;
-
- nbytes -= ret;
- if ( !nbytes )
- break;
+ total += ret;
- buffer += ret;
- }
+ if ( !(m_flags & wxSOCKET_WAITALL_WRITE) )
+ break;
- if ( ((m_flags & wxSOCKET_WAITALL) && nbytes) || !total )
- SetError(wxSOCKET_IOERR);
+ nbytes -= ret;
+ buffer += ret;
}
return total;
unsigned char len[4];
} msg;
- // Mask write events
- m_writing = true;
+ wxSocketWriteGuard write(this);
- const int old_flags = m_flags;
- SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL_WRITE);
msg.sig[0] = (unsigned char) 0xad;
msg.sig[1] = (unsigned char) 0xde;
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;
if ( !ok )
SetError(wxSOCKET_IOERR);
- m_writing = false;
- SetFlags(old_flags);
-
return *this;
}
wxUint32 ret;
wxUint32 total = 0;
- // Mask read events
- m_reading = true;
+ wxSocketReadGuard read(this);
- const int old_flags = m_flags;
- SetFlags(wxSOCKET_NOWAIT);
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT);
do
{
m_lcount = total;
SetError(wxSOCKET_NOERROR);
- // Allow read events again
- m_reading = false;
-
- SetFlags(old_flags);
-
return *this;
}
exceptfds; // always want to know about errors
if ( flags & wxSOCKET_INPUT_FLAG )
- {
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);
}
- // 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);
}
return detected & flags;
}
-bool
+int
wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags)
{
- wxCHECK_MSG( m_impl, false, "can't wait on invalid socket" );
-
- // This can be set to true from Interrupt() to exit this function a.s.a.p.
- m_interrupt = false;
-
-
// 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 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.
+ m_interrupt = false;
+
+
const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout;
// Get the active event loop which we'll use for the message dispatching
eventLoop = NULL;
}
+ // 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));
+
+
// 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)
- bool gotEvent = false;
- for ( bool firstTime = true; !m_interrupt ; firstTime = false )
+ int rc = 0;
+ for ( bool firstTime = true; !m_interrupt; firstTime = false )
{
long timeLeft = wxMilliClockToLong(timeEnd - wxGetLocalTimeMillis());
if ( timeLeft < 0 )
timeLeft = 0;
}
- // This function is only called if wxSOCKET_BLOCK flag was not used and
- // so we should dispatch the events if there is an event loop capable
- // of doing it.
wxSocketEventFlags events;
if ( eventLoop )
{
{
m_connected = false;
m_establishing = false;
- if ( flags & wxSOCKET_LOST_FLAG )
- gotEvent = true;
+ rc = -1;
break;
}
{
m_connected = true;
m_establishing = false;
- gotEvent = true;
+ rc = true;
break;
}
// Data available or output buffer ready?
if ( (events & wxSOCKET_INPUT_FLAG) || (events & wxSOCKET_OUTPUT_FLAG) )
{
- gotEvent = true;
+ rc = true;
break;
}
}
- return gotEvent;
+ return rc;
}
bool wxSocketBase::Wait(long seconds, long milliseconds)
{
return DoWait(seconds, milliseconds,
- wxSOCKET_INPUT_FLAG |
- wxSOCKET_OUTPUT_FLAG |
- wxSOCKET_CONNECTION_FLAG |
- wxSOCKET_LOST_FLAG
- );
+ wxSOCKET_INPUT_FLAG |
+ wxSOCKET_OUTPUT_FLAG |
+ wxSOCKET_CONNECTION_FLAG) != 0;
}
bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
if ( m_unread )
return true;
- // Note that wxSOCKET_INPUT_LOST has to be explicitly passed to DoWait
- // because of the semantics of WaitForRead: a return value of true means
- // that a Read call will return immediately, not that there is
- // actually data to read.
- return DoWait(seconds, milliseconds, wxSOCKET_INPUT_FLAG | wxSOCKET_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, wxSOCKET_OUTPUT_FLAG | wxSOCKET_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, wxSOCKET_LOST_FLAG);
+ return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG) == -1;
}
// --------------------------------------------------------------------------
// Get local or peer address
//
-bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
+bool wxSocketBase::GetPeer(wxSockAddress& addr) const
{
- GAddress *peer;
-
- if (!m_impl)
- return false;
-
- peer = m_impl->GetPeer();
-
- // copying a null address would just trigger an assert anyway
+ wxCHECK_MSG( m_impl, false, "invalid socket" );
- 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_impl)
+ const wxSockAddressImpl& local = m_impl->GetLocal();
+ if ( !local.IsOk() )
return false;
- local = m_impl->GetLocal();
- addr_man.SetAddress(local);
- GAddress_destroy(local);
+ addr.SetAddress(local);
return true;
}
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;
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;
default:
wxFAIL_MSG( "unknown wxSocket notification" );
}
- // if we lost the connection the socket is now closed
- if ( notification == wxSOCKET_LOST )
- m_closed = true;
-
// 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 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.
- if ( notification == wxSOCKET_INPUT )
+ // 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) )
{
- if ( m_reading || !m_impl->Select(wxSOCKET_INPUT_FLAG) )
- return;
- }
- else if ( notification == wxSOCKET_OUTPUT )
- {
- if ( m_writing || !m_impl->Select(wxSOCKET_OUTPUT_FLAG) )
- return;
+ return;
}
wxSocketEvent event(m_id);
// 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_impl = wxSocketImpl::Create(*this);
+ wxSocketManager * const manager = wxSocketManager::Get();
+ m_impl = manager ? manager->CreateSocket(*this) : NULL;
if (!m_impl)
{
- wxLogTrace( wxTRACE_Socket, _T("*** Failed to create m_impl") );
+ wxLogTrace( wxTRACE_Socket, wxT("*** Failed to create m_impl") );
return;
}
// Setup the socket as server
- m_impl->SetLocal(addr_man.GetAddress());
+ m_impl->SetLocal(addr.GetAddress());
if (GetFlags() & wxSOCKET_REUSEADDR) {
m_impl->SetReusable();
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;
}
- wxLogTrace( wxTRACE_Socket, _T("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) );
}
// --------------------------------------------------------------------------
bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
- return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG);
+ 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, _T("Socket not initialised") );
+ wxASSERT_MSG( m_impl, wxT("Socket not initialised") );
SOCKOPTLEN_T lenreal = *optlen;
if ( getsockopt(m_impl->m_fd, level, optname,
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;
bool wxSocketBase::SetLocal(const wxIPV4address& local)
{
- GAddress* la = local.GetAddress();
+ m_localAddress = local;
- // If the address is valid, save it for use when we call Connect
- if (la && la->m_addr)
- {
- m_localAddress = local;
-
- return true;
- }
-
- return false;
+ return true;
}
// ==========================================================================
m_initialSendBufferSize = -1;
}
-wxSocketClient::~wxSocketClient()
-{
-}
-
// --------------------------------------------------------------------------
// Connect
// --------------------------------------------------------------------------
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;
// Bind to the local IP address and port, when provided or if one had been
// set before
- if ( !local && m_localAddress.GetAddress() )
+ if ( !local && m_localAddress.GetAddress().IsOk() )
local = &m_localAddress;
if ( local )
wxCHECK_MSG( m_establishing && m_impl, false,
"No connection establishment attempt in progress" );
- // we must specify wxSOCKET_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,
- wxSOCKET_CONNECTION_FLAG | wxSOCKET_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;
}
// ==========================================================================
: 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->CreateUDP() != wxSOCKET_NOERROR )
{
- delete m_impl;
- m_impl = NULL;
+ wxDELETE(m_impl);
return;
}
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);
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 __WINDOWS__
+ wxFORCE_LINK_MODULE( mswsocket )
+#endif
+
+// and for OSXManagerSetter in the OS X one
+#ifdef __WXOSX__
+ wxFORCE_LINK_MODULE( osxsocket )
+#endif
+
#endif // wxUSE_SOCKETS
projects / wxWidgets.git / blobdiff