#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 <errno.h>
+#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"
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
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
// --------------------------------------------------------------------------
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())
+
+ {
+ 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);
};
-// Conditionally make the socket non-blocking for the lifetime of this object.
-class wxSocketUnblocker
+class wxSocketWriteGuard
{
public:
- wxSocketUnblocker(wxSocketImpl *socket, bool unblock = true)
- : m_impl(socket),
- m_unblock(unblock)
+ wxSocketWriteGuard(wxSocketBase *socket)
+ : m_socket(socket)
{
- if ( m_unblock )
- m_impl->SetNonBlocking(true);
+ wxASSERT_MSG( !m_socket->m_writing, "write reentrancy?" );
+
+ m_socket->m_writing = true;
}
- ~wxSocketUnblocker()
+ ~wxSocketWriteGuard()
{
- if ( m_unblock )
- m_impl->SetNonBlocking(false);
+ 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:
- wxSocketImpl * const m_impl;
- bool m_unblock;
+ wxSocketBase * const m_socket;
- DECLARE_NO_COPY_CLASS(wxSocketUnblocker)
+ wxDECLARE_NO_COPY_CLASS(wxSocketWriteGuard);
};
// ============================================================================
: m_wxsocket(&wxsocket)
{
m_fd = INVALID_SOCKET;
- m_detected = 0;
- m_local = NULL;
- m_peer = NULL;
m_error = wxSOCKET_NOERROR;
m_server = false;
m_stream = true;
- m_non_blocking = false;
SetTimeout(wxsocket.GetTimeout() * 1000);
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;
if ( m_initialSendBufferSize >= 0 )
SetSocketOption(SO_SNDBUF, m_initialSendBufferSize);
- // FIXME: shouldn't we check for m_non_blocking here? as it is now, all our
- // sockets are non-blocking
+ // we always put our sockets in unblocked mode and handle blocking
+ // ourselves in DoRead/Write() if wxSOCKET_WAITALL is specified
UnblockAndRegisterWithEventLoop();
}
wxSocketError wxSocketImpl::UpdateLocalAddress()
{
- WX_SOCKLEN_T lenAddr;
- 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() )
return UpdateLocalAddress();
}
-wxSocketError wxSocketImpl::CreateClient()
+wxSocketError wxSocketImpl::CreateClient(bool wait)
{
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 )
{
- m_error = wxSOCKET_IOERR;
- return wxSOCKET_IOERR;
+ 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 && 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;
}
}
- // Connect to the peer and handle the EWOULDBLOCK return value in
- // platform-specific code
- return DoHandleConnect(connect(m_fd, m_peer->m_addr, m_peer->m_len));
+ // 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;
}
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;
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()
{
}
}
-/*
- * Disallow further read/write operations on this socket, close
- * the fd and disable all callbacks.
- */
void wxSocketImpl::Shutdown()
{
if ( m_fd != INVALID_SOCKET )
shutdown(m_fd, 1 /* SD_SEND */);
Close();
}
-
- m_detected = wxSOCKET_LOST_FLAG;
}
/*
*/
void wxSocketImpl::SetTimeout(unsigned long millis)
{
- m_timeout.tv_sec = (millis / 1000);
- m_timeout.tv_usec = (millis % 1000) * 1000;
+ SetTimeValFromMS(m_timeout, millis);
}
void wxSocketImpl::NotifyOnStateChange(wxSocketNotify 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;
+ }
-/*
- * 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)
+ if ( !local.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
+
+ m_local = local;
+
+ return wxSOCKET_NOERROR;
+}
+
+wxSocketError wxSocketImpl::SetPeer(const wxSockAddressImpl& peer)
{
- /* 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 ( !peer.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
- /* check address */
- if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
- {
- m_error = wxSOCKET_INVADDR;
- return wxSOCKET_INVADDR;
- }
+ m_peer = peer;
- if (m_local)
- GAddress_destroy(m_local);
+ return wxSOCKET_NOERROR;
+}
- m_local = GAddress_copy(address);
+const wxSockAddressImpl& wxSocketImpl::GetLocal()
+{
+ if ( !m_local.IsOk() )
+ UpdateLocalAddress();
- return wxSOCKET_NOERROR;
+ return m_local;
}
-wxSocketError wxSocketImpl::SetPeer(GAddress *address)
+// ----------------------------------------------------------------------------
+// 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)
{
- /* check address */
- if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
- {
- m_error = wxSOCKET_INVADDR;
- return wxSOCKET_INVADDR;
- }
+ int ret;
+ DO_WHILE_EINTR( ret, recv(m_fd, static_cast<char *>(buffer), size, 0) );
- if (m_peer)
- GAddress_destroy(m_peer);
+ 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);
- m_peer = GAddress_copy(address);
+ Shutdown();
- return wxSOCKET_NOERROR;
+ // do not return an error in this case however
+ }
+
+ return ret;
}
-GAddress *wxSocketImpl::GetLocal()
+int wxSocketImpl::SendStream(const void *buffer, int size)
{
- GAddress *address;
- wxSockAddr addr;
- WX_SOCKLEN_T size = sizeof(addr);
- wxSocketError err;
+#ifdef wxNEEDS_IGNORE_SIGPIPE
+ IgnoreSignal ignore(SIGPIPE);
+#endif
- /* try to get it from the m_local var first */
- if (m_local)
- return GAddress_copy(m_local);
+ int ret;
+ DO_WHILE_EINTR( ret, send(m_fd, static_cast<const char *>(buffer), size,
+ wxSOCKET_MSG_NOSIGNAL) );
- /* else, if the socket is initialized, try getsockname */
- if (m_fd == INVALID_SOCKET)
- {
- m_error = wxSOCKET_INVSOCK;
- return NULL;
- }
+ return ret;
+}
- if (getsockname(m_fd, (sockaddr*)&addr, &size) == SOCKET_ERROR)
- {
- m_error = wxSOCKET_IOERR;
- return NULL;
- }
+int wxSocketImpl::RecvDgram(void *buffer, int size)
+{
+ wxSockAddressStorage from;
+ WX_SOCKLEN_T fromlen = sizeof(from);
- /* got a valid address from getsockname, create a GAddress object */
- if ((address = GAddress_new()) == NULL)
- {
- m_error = wxSOCKET_MEMERR;
- return NULL;
- }
+ int ret;
+ DO_WHILE_EINTR( ret, recvfrom(m_fd, static_cast<char *>(buffer), size,
+ 0, &from.addr, &fromlen) );
- if ((err = _GAddress_translate_from(address, (sockaddr*)&addr, size)) != wxSOCKET_NOERROR)
- {
- GAddress_destroy(address);
- m_error = err;
- return NULL;
- }
+ if ( ret == SOCKET_ERROR )
+ return SOCKET_ERROR;
- return address;
+ m_peer = wxSockAddressImpl(from.addr, fromlen);
+ if ( !m_peer.IsOk() )
+ return -1;
+
+ return ret;
}
-GAddress *wxSocketImpl::GetPeer()
+int wxSocketImpl::SendDgram(const void *buffer, int size)
{
- /* try to get it from the m_peer var */
- if (m_peer)
- return GAddress_copy(m_peer);
+ if ( !m_peer.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return -1;
+ }
+
+ int ret;
+ DO_WHILE_EINTR( ret, sendto(m_fd, static_cast<const char *>(buffer), size,
+ 0, m_peer.GetAddr(), m_peer.GetLen()) );
- return NULL;
+ return ret;
}
-bool wxSocketImpl::DoBlockWithTimeout(wxSocketEventFlags flags)
+int wxSocketImpl::Read(void *buffer, int size)
{
- if ( !m_non_blocking )
+ // server sockets can't be used for IO, only to accept new connections
+ if ( m_fd == INVALID_SOCKET || m_server )
{
- fd_set fds;
- wxFD_ZERO(&fds);
- wxFD_SET(m_fd, &fds);
+ m_error = wxSOCKET_INVSOCK;
+ return -1;
+ }
- fd_set
- *readfds = flags & wxSOCKET_INPUT_FLAG ? &fds : NULL,
- *writefds = flags & wxSOCKET_OUTPUT_FLAG ? &fds : NULL;
+ int ret = m_stream ? RecvStream(buffer, size)
+ : RecvDgram(buffer, size);
- // make a copy as it can be modified by select()
- struct timeval tv = m_timeout;
- int ret = select(m_fd + 1, readfds, writefds, NULL, &tv);
+ m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR;
- switch ( ret )
- {
- case 0:
- m_error = wxSOCKET_TIMEDOUT;
- return false;
+ return ret;
+}
- case -1:
- m_error = wxSOCKET_IOERR;
- return false;
- }
+int wxSocketImpl::Write(const void *buffer, int size)
+{
+ if ( m_fd == INVALID_SOCKET || m_server )
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return -1;
}
- //else: we're non-blocking, never block
- return true;
+ int ret = m_stream ? SendStream(buffer, size)
+ : SendDgram(buffer, size);
+
+ m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR;
+
+ 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_establishing =
m_reading =
m_writing =
- m_error =
m_closed = false;
m_lcount = 0;
m_timeout = 600;
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()
// 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;
}
// ----------------------------------------------------------------------------
-// simply accessors
+// 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_impl)
- m_impl->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<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 )
{
- wxSocketUnblocker unblock(m_impl);
- int ret = m_impl->Read(buffer, nbytes);
- if ( ret < 0 )
- return 0;
-
- total += ret;
- }
- else // blocking socket
- {
- 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_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 )
+ 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;
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;
+ wxSocketReadGuard read(this);
- total = 0;
- error = true;
- old_flags = m_flags;
- SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL);
- 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 != 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<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 )
{
- wxSocketUnblocker unblock(m_impl);
+ if ( m_impl->m_stream && !m_connected )
+ {
+ if ( (m_flags & wxSOCKET_WAITALL) || !total )
+ SetError(wxSOCKET_IOERR);
+ break;
+ }
+
const int ret = m_impl->Write(buffer, nbytes);
- if ( ret > 0 )
- total += ret;
- }
- else // blocking socket
- {
- for ( ;; )
+ if ( ret == -1 )
{
- if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
- break;
+ if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK )
+ {
+ if ( m_flags & wxSOCKET_NOWAIT )
+ break;
- const int ret = m_impl->Write(buffer, nbytes);
- if ( ret == 0 )
+ if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) )
+ {
+ SetError(wxSOCKET_TIMEDOUT);
+ break;
+ }
+
+ continue;
+ }
+ else // "real" error
{
- m_closed = true;
+ SetError(wxSOCKET_IOERR);
break;
}
+ }
- if ( ret < 0 )
- return 0;
-
- total += ret;
- if ( !(m_flags & wxSOCKET_WAITALL) )
- break;
+ total += ret;
- nbytes -= ret;
- if ( !nbytes )
- break;
+ if ( !(m_flags & wxSOCKET_WAITALL) )
+ break;
- buffer += ret;
- }
+ nbytes -= ret;
+ buffer += ret;
}
return total;
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;
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;
+ 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;
+ }
+ }
- // everything was OK
- error = false;
-
-exit:
- m_error = error;
- m_lcount = total;
- m_writing = false;
+ if ( !ok )
+ SetError(wxSOCKET_IOERR);
return *this;
}
if (nbytes != 0)
Pushback(buffer, nbytes);
- m_error = false;
+ SetError(wxSOCKET_NOERROR);
m_lcount = nbytes;
return *this;
wxUint32 ret;
wxUint32 total = 0;
- // Mask read events
- m_reading = true;
+ wxSocketReadGuard read(this);
- SetFlags(wxSOCKET_NOWAIT);
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT);
do
{
delete[] buffer;
m_lcount = total;
- m_error = false;
-
- // Allow read events again
- m_reading = false;
+ SetError(wxSOCKET_NOERROR);
return *this;
}
// --------------------------------------------------------------------------
/*
- * Polls the socket to determine its status. This function will
- * check for the events specified in the 'flags' parameter, and
- * it will return a mask indicating which operations can be
- * performed. This function won't block, regardless of the
- * mode (blocking | nonblocking) of the socket.
+ 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)
-{
- assert(this);
-
- wxSocketEventFlags result = 0;
- fd_set readfds;
- fd_set writefds;
- fd_set exceptfds;
- struct timeval tv;
-
- if (m_fd == INVALID_SOCKET)
- return (wxSOCKET_LOST_FLAG & flags);
-
- /* Do not use a static struct, Linux can garble it */
- tv.tv_sec = 0;
- tv.tv_usec = 0;
-
- wxFD_ZERO(&readfds);
- wxFD_ZERO(&writefds);
- wxFD_ZERO(&exceptfds);
- wxFD_SET(m_fd, &readfds);
- if (flags & wxSOCKET_OUTPUT_FLAG || flags & wxSOCKET_CONNECTION_FLAG)
- wxFD_SET(m_fd, &writefds);
- wxFD_SET(m_fd, &exceptfds);
-
- /* Check 'sticky' CONNECTION flag first */
- result |= wxSOCKET_CONNECTION_FLAG & m_detected;
-
- /* If we have already detected a LOST event, then don't try
- * to do any further processing.
- */
- if ((m_detected & wxSOCKET_LOST_FLAG) != 0)
- {
- m_establishing = false;
- return (wxSOCKET_LOST_FLAG & flags);
- }
-
- /* Try select now */
- if (select(m_fd + 1, &readfds, &writefds, &exceptfds, &tv) < 0)
- {
- /* What to do here? */
- return (result & flags);
- }
-
- /* Check for exceptions and errors */
- if (wxFD_ISSET(m_fd, &exceptfds))
- {
- m_establishing = false;
- m_detected = wxSOCKET_LOST_FLAG;
+wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags,
+ const timeval *timeout)
+{
+ if ( m_fd == INVALID_SOCKET )
+ return (wxSOCKET_LOST_FLAG & flags);
- /* LOST event: Abort any further processing */
- return (wxSOCKET_LOST_FLAG & flags);
- }
+ struct timeval tv;
+ if ( timeout )
+ tv = *timeout;
+ else
+ tv.tv_sec = tv.tv_usec = 0;
- /* Check for readability */
- if (wxFD_ISSET(m_fd, &readfds))
- {
- result |= wxSOCKET_INPUT_FLAG;
+ // 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 (m_server && m_stream)
+ if ( flags & wxSOCKET_INPUT_FLAG )
{
- /* This is a TCP server socket that detected a connection.
- While the INPUT_FLAG is also set, it doesn't matter on
- this kind of sockets, as we can only Accept() from them. */
- m_detected |= wxSOCKET_CONNECTION_FLAG;
+ preadfds = &readfds;
+ wxFD_ZERO(preadfds);
+ wxFD_SET(m_fd, preadfds);
}
- }
- /* Check for writability */
- if (wxFD_ISSET(m_fd, &writefds))
- {
- if (m_establishing && !m_server)
+ // when using non-blocking connect() the socket becomes connected
+ // (successfully or not) when it becomes writable
+ if ( flags & (wxSOCKET_OUTPUT_FLAG | wxSOCKET_CONNECTION_FLAG) )
{
- int error;
- SOCKOPTLEN_T len = sizeof(error);
- m_establishing = false;
- getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len);
+ pwritefds = &writefds;
+ wxFD_ZERO(pwritefds);
+ wxFD_SET(m_fd, pwritefds);
+ }
- if (error)
- {
- m_detected = wxSOCKET_LOST_FLAG;
+ wxFD_ZERO(&exceptfds);
+ wxFD_SET(m_fd, &exceptfds);
- /* LOST event: Abort any further processing */
- return (wxSOCKET_LOST_FLAG & flags);
- }
- else
- {
- m_detected |= wxSOCKET_CONNECTION_FLAG;
- }
- }
- else
+ const int rc = select(m_fd + 1, preadfds, pwritefds, &exceptfds, &tv);
+
+ // check for errors first
+ if ( rc == -1 || wxFD_ISSET(m_fd, &exceptfds) )
{
- result |= wxSOCKET_OUTPUT_FLAG;
+ m_establishing = false;
+
+ return wxSOCKET_LOST_FLAG & flags;
}
- }
- return (result | m_detected) & flags;
-}
+ if ( rc == 0 )
+ return 0;
-// All Wait functions poll the socket using 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.
+ wxASSERT_MSG( rc == 1, "unexpected select() return value" );
-bool
-wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags)
-{
- wxCHECK_MSG( m_impl, false, "can't wait on invalid socket" );
+ wxSocketEventFlags detected = 0;
+ if ( preadfds && wxFD_ISSET(m_fd, preadfds) )
+ detected |= wxSOCKET_INPUT_FLAG;
- // This can be set to true from Interrupt() to exit this function a.s.a.p.
- m_interrupt = false;
+ 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();
}
eventLoop = NULL;
}
- // reset them before starting to wait
- m_eventsgot = 0;
+ // 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 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 ( ;; )
+ // 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 )
+ {
+ if ( !firstTime )
+ break; // timed out
+
+ timeLeft = 0;
+ }
+
wxSocketEventFlags events;
if ( eventLoop )
{
- // 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.
- if ( eventLoop->Pending() )
- eventLoop->Dispatch();
+ // reset them before starting to wait
+ m_eventsgot = 0;
+
+ eventLoop->DispatchTimeout(timeLeft);
events = m_eventsgot;
}
- else
+ else // no event loop or waiting in another thread
{
- // We always stop waiting when the connection is lost as it doesn't
- // make sense to continue further, even if wxSOCKET_LOST_FLAG is
- // not specified in flags to wait for.
- events = m_impl->Select(flags | wxSOCKET_LOST_FLAG);
+ // 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);
}
- // Incoming connection (server) or connection established (client)?
- if ( events & wxSOCKET_CONNECTION_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 = true;
+ m_connected = false;
m_establishing = false;
- gotEvent = true;
+ rc = -1;
break;
}
- // Data available or output buffer ready?
- if ( (events & wxSOCKET_INPUT_FLAG) || (events & wxSOCKET_OUTPUT_FLAG) )
- {
- gotEvent = true;
- break;
- }
+ // otherwise mask out the bits we're not interested in
+ events &= flags;
- // Connection lost
- if ( events & wxSOCKET_LOST_FLAG )
+ // Incoming connection (server) or connection established (client)?
+ if ( events & wxSOCKET_CONNECTION_FLAG )
{
- m_connected = false;
+ m_connected = true;
m_establishing = false;
- if ( flags & wxSOCKET_LOST_FLAG )
- gotEvent = true;
+ rc = true;
break;
}
- if ( m_interrupt )
- break;
-
- // Wait more?
- const wxMilliClock_t timeNow = wxGetLocalTimeMillis();
- if ( timeNow >= timeEnd )
- break;
-
-#if wxUSE_THREADS
- // no event loop or waiting in another thread
- if ( !eventLoop )
+ // 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,
- 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;
+ wxCHECK_MSG( m_impl, false, "invalid socket" );
- if (!m_impl)
+ const wxSockAddressImpl& peer = m_impl->GetPeer();
+ if ( !peer.IsOk() )
return false;
- peer = m_impl->GetPeer();
-
- // copying a null address would just trigger an assert anyway
-
- if (!peer)
- 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;
}
void wxSocketBase::OnRequest(wxSocketNotify notification)
{
- 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_impl->Select(wxSOCKET_INPUT_FLAG))
- return;
- break;
-
- case wxSOCKET_OUTPUT:
- if (m_writing || !m_impl->Select(wxSOCKET_OUTPUT_FLAG))
- return;
- break;
-
- case wxSOCKET_LOST:
- m_connected = false;
- m_establishing = false;
- break;
-
- case wxSOCKET_MAX_EVENT:
- wxFAIL_MSG( "unexpected notification" );
- return;
- }
-
wxSocketEventFlags flag = 0;
switch ( notification )
{
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:
// send the wx event if enabled and we're interested in it
if ( m_notify && (m_eventmask & flag) && 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) )
+ {
+ return;
+ }
+
wxSocketEvent event(m_id);
event.m_event = notification;
event.m_clientData = m_clientData;
void wxSocketBase::Notify(bool notify)
{
m_notify = notify;
- if (m_impl)
- m_impl->Notify(notify);
}
void wxSocketBase::SetNotify(wxSocketEventFlags flags)
// 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->Notify(m_notify);
- m_impl->SetLocal(addr_man.GetAddress());
+ m_impl->SetLocal(addr.GetAddress());
if (GetFlags() & wxSOCKET_REUSEADDR) {
m_impl->SetReusable();
delete m_impl;
m_impl = NULL;
- 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 );
+ wxLogTrace( wxTRACE_Socket, wxT("wxSocketServer on fd %d"), m_impl->m_fd );
}
// --------------------------------------------------------------------------
bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
- if (!m_impl)
+ 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);
+
+ return false;
+ }
+ }
- // If wait == false, then the call should be nonblocking.
- // When we are finished, we put the socket to blocking mode
- // again.
- wxSocketUnblocker unblock(m_impl, !wait);
- sock.m_impl = m_impl->WaitConnection(sock);
+ sock.m_impl = m_impl->Accept(sock);
if ( !sock.m_impl )
+ {
+ SetError(m_impl->GetLastError());
+
return false;
+ }
sock.m_type = wxSOCKET_BASE;
sock.m_connected = true;
bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
- return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG);
+ return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) == 1;
}
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;
+ SOCKOPTLEN_T lenreal = *optlen;
if ( getsockopt(m_impl->m_fd, level, optname,
static_cast<char *>(optval), &lenreal) != 0 )
return false;
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
// --------------------------------------------------------------------------
-bool wxSocketClient::DoConnect(const wxSockAddress& addr_man,
+bool wxSocketClient::DoConnect(const wxSockAddress& remote,
const wxSockAddress* local,
bool wait)
{
- if (m_impl)
+ if ( m_impl )
{
- // Shutdown and destroy the socket
+ // Shutdown and destroy the old socket
Close();
delete m_impl;
}
- m_impl = wxSocketImpl::Create(*this);
m_connected = false;
m_establishing = false;
- if (!m_impl)
+ // Create and set up the new one
+ wxSocketManager * const manager = wxSocketManager::Get();
+ m_impl = manager ? manager->CreateSocket(*this) : NULL;
+ if ( !m_impl )
return false;
- // If wait == false, then the call should be nonblocking. When we are
- // finished, we put the socket to blocking mode again.
- wxSocketUnblocker unblock(m_impl, !wait);
-
// Reuse makes sense for clients too, if we are trying to rebind to the same port
if (GetFlags() & wxSOCKET_REUSEADDR)
- {
m_impl->SetReusable();
- }
if (GetFlags() & wxSOCKET_BROADCAST)
- {
m_impl->SetBroadcast();
- }
if (GetFlags() & wxSOCKET_NOBIND)
- {
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_impl->SetLocal(la);
- }
+ if ( local )
+ m_impl->SetLocal(local->GetAddress());
m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
- m_impl->SetPeer(addr_man.GetAddress());
- const wxSocketError err = m_impl->CreateClient();
+ m_impl->SetPeer(remote.GetAddress());
- //this will register for callbacks - must be called after m_impl->m_fd was initialized
- m_impl->Notify(m_notify);
+ // Finally do create the socket and connect to the peer
+ const wxSocketError err = m_impl->CreateClient(wait);
- if (err != wxSOCKET_NOERROR)
+ if ( err != wxSOCKET_NOERROR )
{
- if (err == wxSOCKET_WOULDBLOCK)
+ if ( err == wxSOCKET_WOULDBLOCK )
+ {
+ wxASSERT_MSG( !wait, "shouldn't get this for blocking connect" );
+
m_establishing = true;
+ }
return false;
}
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)
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;
- m_impl->Notify(m_notify);
// Setup the socket as non connection oriented
m_impl->SetLocal(addr.GetAddress());
if (flags & wxSOCKET_REUSEADDR)
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 __WXMSW__
+ 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