-////////////////////////////////////////////////////////////////////////////////
-// Name: socket.cpp
+/////////////////////////////////////////////////////////////////////////////
+// Name: src/common/socket.cpp
// Purpose: Socket handler classes
-// Authors: Guilhem Lavaux (completely rewritten from a basic API of Andrew
-// Davidson(1995) in wxWeb)
+// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
// Created: April 1997
-// Updated: April 1999
-// Copyright: (C) 1999 1998, 1997, Guilhem Lavaux
+// Copyright: (C) 1999-1997, Guilhem Lavaux
+// (C) 1999-2000, Guillermo Rodriguez Garcia
+// (C) 2008 Vadim Zeitlin
// RCS_ID: $Id$
-// License: see wxWindows license
-////////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "socket.h"
-#endif
+// Licence: wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
-#ifdef __MWERKS__
-typedef int socklen_t ;
-#endif
+// ==========================================================================
+// Declarations
+// ==========================================================================
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
#if wxUSE_SOCKETS
-/////////////////////////////////////////////////////////////////////////////
-// wxWindows headers
-/////////////////////////////////////////////////////////////////////////////
-#include <wx/defs.h>
-#include <wx/object.h>
-#include <wx/string.h>
-#include <wx/timer.h>
-#include <wx/utils.h>
+#include "wx/socket.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/object.h"
+ #include "wx/string.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/event.h"
+ #include "wx/app.h"
+ #include "wx/utils.h"
+ #include "wx/timer.h"
+ #include "wx/module.h"
+#endif
-// IRIX requires bstring.h be included to use select()
-#ifdef sgi
- #include <bstring.h>
-#endif // IRIX
+#include "wx/apptrait.h"
+#include "wx/sckaddr.h"
+#include "wx/stopwatch.h"
+#include "wx/thread.h"
+#include "wx/evtloop.h"
+#include "wx/link.h"
-// Not enough OS behaviour defined for wxStubs
-#ifndef __WXSTUBS__
+#include "wx/private/fd.h"
+#include "wx/private/socket.h"
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
+#ifdef __UNIX__
+ #include <errno.h>
+#endif
-/////////////////////////////////////////////////////////////////////////////
-// System specific headers
-/////////////////////////////////////////////////////////////////////////////
-#ifdef __WXMAC__
-// in order to avoid problems with our c library and double definitions
-#define close closesocket
-#define ioctl ioctlsocket
+// 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
-#include <wx/mac/macsock.h>
+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxNet")
-#endif
+// --------------------------------------------------------------------------
+// macros and constants
+// --------------------------------------------------------------------------
-#if defined(__WINDOWS__)
-#include <winsock.h>
-#endif // __WINDOWS__
+// event
+wxDEFINE_EVENT(wxEVT_SOCKET, wxSocketEvent);
-#if defined(__UNIX__)
+// discard buffer
+#define MAX_DISCARD_SIZE (10 * 1024)
-#ifdef VMS
-#include <socket.h>
-#else
-#include <sys/socket.h>
-#endif
-#include <sys/ioctl.h>
+#define wxTRACE_Socket wxT("wxSocket")
-#include <sys/time.h>
-#include <unistd.h>
+// --------------------------------------------------------------------------
+// wxWin macros
+// --------------------------------------------------------------------------
-#ifdef sun
-#include <sys/filio.h>
-#endif
+IMPLEMENT_CLASS(wxSocketBase, wxObject)
+IMPLEMENT_CLASS(wxSocketServer, wxSocketBase)
+IMPLEMENT_CLASS(wxSocketClient, wxSocketBase)
+IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase)
+IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
-#endif // __UNIX__
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
-#include <signal.h>
-#include <errno.h>
+namespace
+{
-#ifdef __VISUALC__
-#include <io.h>
-#endif
+void SetTimeValFromMS(timeval& tv, unsigned long ms)
+{
+ tv.tv_sec = (ms / 1000);
+ tv.tv_usec = (ms % 1000) * 1000;
+}
-/////////////////////////////////////////////////////////////////////////////
-// wxSocket headers
-/////////////////////////////////////////////////////////////////////////////
-#include <wx/module.h>
-#define WXSOCK_INTERNAL
-#include <wx/sckaddr.h>
-#include <wx/socket.h>
-#include <wx/sckint.h>
-
-// ----------------------
-// Some patch ----- BEGIN
-// ----------------------
-#ifdef __WINDOWS__
-#define close closesocket
-#define ioctl ioctlsocket
-#ifdef errno
-#undef errno
-#endif
-#define errno WSAGetLastError()
-#ifdef EWOULDBLOCK
-#undef EWOULDBLOCK
-#endif
-#define EWOULDBLOCK WSAEWOULDBLOCK
-#define ETIMEDOUT WSAETIMEDOUT
-#undef EINTR
-#define EINTR WSAEINTR
-#endif
+} // anonymous namespace
-#ifndef __WINDOWS__
-#define INVALID_SOCKET -1
-#endif
+// --------------------------------------------------------------------------
+// private classes
+// --------------------------------------------------------------------------
-#ifdef __WINDOWS__
-// This is an MS TCP/IP routine and is not needed here. Some WinSock
-// implementations (such as PC-NFS) will require you to include this
-// or a similar routine (see appendix in WinSock doc or help file).
+class wxSocketState : public wxObject
+{
+public:
+ wxSocketFlags m_flags;
+ wxSocketEventFlags m_eventmask;
+ bool m_notify;
+ void *m_clientData;
+
+public:
+ wxSocketState() : wxObject() {}
-#if defined( NEED_WSAFDIsSet ) || defined( __VISUALC__ )
-int PASCAL FAR __WSAFDIsSet(SOCKET fd, fd_set FAR *set)
+ wxDECLARE_NO_COPY_CLASS(wxSocketState);
+};
+
+// wxSocketWaitModeChanger: temporarily change the socket flags affecting its
+// wait mode
+class wxSocketWaitModeChanger
{
- int i = set->fd_count;
+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())
- while (i--)
- {
- if (set->fd_array[i] == fd)
- return 1;
- }
+ {
+ // 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);
+ }
- return 0;
-}
-#endif
-#endif
+ ~wxSocketWaitModeChanger()
+ {
+ m_socket->SetFlags(m_oldflags);
+ }
-// -------------------
-// Some patch ---- END
-// -------------------
+private:
+ wxSocketBase * const m_socket;
+ const int m_oldflags;
-#ifdef GetClassInfo
-#undef GetClassInfo
-#endif
+ wxDECLARE_NO_COPY_CLASS(wxSocketWaitModeChanger);
+};
-// --------------------------------------------------------------
-// Module
-// --------------------------------------------------------------
-class wxSocketModule: public wxModule
+// wxSocketRead/WriteGuard are instantiated before starting reading
+// from/writing to the socket
+class wxSocketReadGuard
{
- DECLARE_DYNAMIC_CLASS(wxSocketModule)
public:
- wxSocketModule() {}
- bool OnInit();
- void OnExit();
-};
+ wxSocketReadGuard(wxSocketBase *socket)
+ : m_socket(socket)
+ {
+ wxASSERT_MSG( !m_socket->m_reading, "read reentrancy?" );
-// --------------------------------------------------------------
-// ClassInfos
-// --------------------------------------------------------------
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_CLASS(wxSocketBase, wxObject)
-IMPLEMENT_CLASS(wxSocketServer, wxSocketBase)
-IMPLEMENT_CLASS(wxSocketClient, wxSocketBase)
-IMPLEMENT_CLASS(wxSocketHandler, wxObject)
-IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
-IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
-#endif
+ m_socket->m_reading = true;
+ }
-// --------------------------------------------------------------
-// --------- wxSocketBase CONSTRUCTOR ---------------------------
-// --------------------------------------------------------------
-wxSocketBase::wxSocketBase(wxSocketBase::wxSockFlags _flags,
- wxSocketBase::wxSockType _type) :
- wxEvtHandler(),
- m_flags(_flags), m_type(_type), m_connected(FALSE), m_connecting(FALSE),
- m_fd(INVALID_SOCKET), m_id(-1),
- m_handler(0),
- m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)),
- m_timeout(3600),
- m_unread(NULL), m_unrd_size(0),
- m_cbk(NULL), m_cdata(NULL),
- m_notify_state(FALSE)
-{
- m_internal = new wxSocketInternal(this);
-}
-
-wxSocketBase::wxSocketBase() :
- wxEvtHandler(),
- m_flags(WAITALL), m_type(SOCK_UNINIT), m_connected(FALSE),
- m_connecting(FALSE), m_fd(INVALID_SOCKET),
- m_id(-1), m_handler(0),
- m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)),
- m_timeout(3600),
- m_unread(NULL), m_unrd_size(0),
- m_cbk(NULL), m_cdata(NULL),
- m_notify_state(FALSE)
-{
- m_internal = new wxSocketInternal(this);
-}
-
-// --------------------------------------------------------------
-// wxSocketBase
-// --------------------------------------------------------------
+ ~wxSocketReadGuard()
+ {
+ m_socket->m_reading = false;
-wxSocketBase::~wxSocketBase()
+ // 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
{
- // First, close the file descriptor.
- Close();
+public:
+ wxSocketWriteGuard(wxSocketBase *socket)
+ : m_socket(socket)
+ {
+ wxASSERT_MSG( !m_socket->m_writing, "write reentrancy?" );
- if (m_unread)
- free(m_unread);
- // Unregister from the handler database.
- if (m_handler)
- m_handler->UnRegister(this);
+ m_socket->m_writing = true;
+ }
- // Destroy all saved states.
- m_states.DeleteContents(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);
+ }
- // Destroy the socket manager.
- delete m_internal;
+private:
+ wxSocketBase * const m_socket;
+
+ wxDECLARE_NO_COPY_CLASS(wxSocketWriteGuard);
+};
+
+// ============================================================================
+// wxSocketManager
+// ============================================================================
+
+wxSocketManager *wxSocketManager::ms_manager = NULL;
+
+/* static */
+void wxSocketManager::Set(wxSocketManager *manager)
+{
+ wxASSERT_MSG( !ms_manager, "too late to set manager now" );
+
+ ms_manager = manager;
}
-bool wxSocketBase::Close()
+/* static */
+void wxSocketManager::Init()
{
- if (m_fd != INVALID_SOCKET)
- {
- if (m_notify_state == TRUE)
- Notify(FALSE);
+ wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" );
+
+ /*
+ Details: Initialize() creates a hidden window as a sink for socket
+ events, such as 'read completed'. wxMSW has only one message loop
+ for the main thread. If Initialize is called in a secondary thread,
+ the socket window will be created for the secondary thread, but
+ since there is no message loop on this thread, it will never
+ receive events and all socket operations will time out.
+ BTW, the main thread must not be stopped using sleep or block
+ on a semaphore (a bad idea in any case) or socket operations
+ will time out.
+
+ On the Mac side, Initialize() stores a pointer to the CFRunLoop for
+ the main thread. Because secondary threads do not have run loops,
+ adding event notifications to the "Current" loop would have no
+ effect at all, events would never fire.
+ */
+ wxASSERT_MSG( wxIsMainThread(),
+ "sockets must be initialized from the main thread" );
+
+ wxAppConsole * const app = wxAppConsole::GetInstance();
+ wxCHECK_RET( app, "sockets can't be initialized without wxApp" );
+
+ ms_manager = app->GetTraits()->GetSocketManager();
+}
- // Shutdown the connection.
- shutdown(m_fd, 2);
- close(m_fd);
- m_fd = INVALID_SOCKET;
- m_connected = FALSE;
- }
+// ==========================================================================
+// wxSocketImpl
+// ==========================================================================
- return TRUE;
+wxSocketImpl::wxSocketImpl(wxSocketBase& wxsocket)
+ : m_wxsocket(&wxsocket)
+{
+ m_fd = INVALID_SOCKET;
+ m_error = wxSOCKET_NOERROR;
+ m_server = false;
+ m_stream = true;
+
+ SetTimeout(wxsocket.GetTimeout() * 1000);
+
+ m_establishing = false;
+ m_reusable = false;
+ m_broadcast = false;
+ m_dobind = true;
+ m_initialRecvBufferSize = -1;
+ m_initialSendBufferSize = -1;
}
-// --------------------------------------------------------------
-// wxSocketBase base IO function
-// --------------------------------------------------------------
+wxSocketImpl::~wxSocketImpl()
+{
+ if ( m_fd != INVALID_SOCKET )
+ Shutdown();
+}
+
+bool wxSocketImpl::PreCreateCheck(const wxSockAddressImpl& addr)
+{
+ if ( m_fd != INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return false;
+ }
+
+ if ( !addr.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return false;
+ }
+
+ return true;
+}
-wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes)
+void wxSocketImpl::PostCreation()
{
- m_lcount = GetPushback(buffer, nbytes, FALSE);
- nbytes -= m_lcount;
- buffer += m_lcount;
+ // FreeBSD variants can't use MSG_NOSIGNAL, and instead use a socket option
+#ifdef SO_NOSIGPIPE
+ EnableSocketOption(SO_NOSIGPIPE);
+#endif
- // If we have got the whole needed buffer or if we don't want to
- // wait then it returns immediately.
- if (!nbytes || (m_lcount && !(m_flags & WAITALL)) ) {
- return *this;
- }
+ if ( m_reusable )
+ EnableSocketOption(SO_REUSEADDR);
+
+ if ( m_broadcast )
+ {
+ wxASSERT_MSG( !m_stream, "broadcasting is for datagram sockets only" );
- WantBuffer(buffer, nbytes, EVT_READ);
+ EnableSocketOption(SO_BROADCAST);
+ }
- return *this;
+ if ( m_initialRecvBufferSize >= 0 )
+ SetSocketOption(SO_RCVBUF, m_initialRecvBufferSize);
+ if ( m_initialSendBufferSize >= 0 )
+ SetSocketOption(SO_SNDBUF, m_initialSendBufferSize);
+
+ // we always put our sockets in unblocked mode and handle blocking
+ // ourselves in DoRead/Write() if wxSOCKET_WAITALL is specified
+ UnblockAndRegisterWithEventLoop();
}
-wxSocketBase& wxSocketBase::ReadMsg(char* buffer, size_t nbytes)
+wxSocketError wxSocketImpl::UpdateLocalAddress()
{
- unsigned long len, len2, sig;
- struct {
- char sig[4];
- char len[4];
- } msg;
+ 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());
+ }
- // sig should be an explicit 32-bit unsigned integer; I've seen
- // compilers in which size_t was actually a 16-bit unsigned integer
+ WX_SOCKLEN_T lenAddr = m_local.GetLen();
+ if ( getsockname(m_fd, m_local.GetWritableAddr(), &lenAddr) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
- Read((char *)&msg, sizeof(msg));
- if (m_lcount != sizeof(msg))
- return *this;
+ return wxSOCKET_NOERROR;
+}
- sig = msg.sig[0] & 0xff;
- sig |= (size_t)(msg.sig[1] & 0xff) << 8;
- sig |= (size_t)(msg.sig[2] & 0xff) << 16;
- sig |= (size_t)(msg.sig[3] & 0xff) << 24;
+wxSocketError wxSocketImpl::CreateServer()
+{
+ if ( !PreCreateCheck(m_local) )
+ return m_error;
- if (sig != 0xfeeddead)
- return *this;
- len = msg.len[0] & 0xff;
- len |= (size_t)(msg.len[1] & 0xff) << 8;
- len |= (size_t)(msg.len[2] & 0xff) << 16;
- len |= (size_t)(msg.len[3] & 0xff) << 24;
-
- // len2 is incorrectly computed in the original; this sequence is
- // the fix
- if (len > nbytes) {
- len2 = len - nbytes;
- len = nbytes;
- }
- else
- len2 = 0;
-
- // the "len &&" in the following statement is necessary so that
- // we don't attempt to read (and possibly hang the system)
- // if the message was zero bytes long
- if (len && Read(buffer, len).LastCount() != len)
- return *this;
- if (len2 && (Read(NULL, len2).LastCount() != len2))
- return *this;
- if (Read((char *)&msg, sizeof(msg)).LastCount() != sizeof(msg))
- return *this;
+ m_server = true;
+ m_stream = true;
- sig = msg.sig[0] & 0xff;
- sig |= (size_t)(msg.sig[1] & 0xff) << 8;
- sig |= (size_t)(msg.sig[2] & 0xff) << 16;
- sig |= (size_t)(msg.sig[3] & 0xff) << 24;
-// ERROR
-// we return *this either way, so a smart optimizer will
-// optimize the following sequence out; I'm leaving it in anyway
- if (sig != 0xdeadfeed)
- return *this;
+ // do create the socket
+ m_fd = socket(m_local.GetFamily(), SOCK_STREAM, 0);
+
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
+
+ PostCreation();
- return *this;
+ // and then bind to and listen on it
+ //
+ // FIXME: should we test for m_dobind here?
+ if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 )
+ m_error = wxSOCKET_IOERR;
+
+ if ( IsOk() )
+ {
+ if ( listen(m_fd, 5) != 0 )
+ m_error = wxSOCKET_IOERR;
+ }
+
+ if ( !IsOk() )
+ {
+ Close();
+ return m_error;
+ }
+
+ // finally retrieve the address we effectively bound to
+ return UpdateLocalAddress();
}
-wxSocketBase& wxSocketBase::Peek(char* buffer, size_t nbytes)
+wxSocketError wxSocketImpl::CreateClient(bool wait)
{
- m_lcount = GetPushback(buffer, nbytes, TRUE);
- if (nbytes-m_lcount == 0)
- {
- return *this;
- }
- buffer += m_lcount;
- nbytes -= m_lcount;
+ if ( !PreCreateCheck(m_peer) )
+ return m_error;
- WantBuffer(buffer, nbytes, EVT_PEEK);
+ m_fd = socket(m_peer.GetFamily(), SOCK_STREAM, 0);
+
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
+
+ PostCreation();
+
+ // If a local address has been set, then bind to it before calling connect
+ if ( m_local.IsOk() )
+ {
+ if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+ }
- return *this;
+ // 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;
}
-wxSocketBase& wxSocketBase::Write(const char *buffer, size_t nbytes)
+
+wxSocketError wxSocketImpl::CreateUDP()
{
- m_lcount = 0;
- WantBuffer((char *)buffer, nbytes, EVT_WRITE);
- return *this;
+ if ( !PreCreateCheck(m_local) )
+ return m_error;
+
+ m_stream = false;
+ m_server = false;
+
+ m_fd = socket(m_local.GetFamily(), SOCK_DGRAM, 0);
+
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
+
+ PostCreation();
+
+ if ( m_dobind )
+ {
+ if ( bind(m_fd, m_local.GetAddr(), m_local.GetLen()) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+
+ return UpdateLocalAddress();
+ }
+
+ return wxSOCKET_NOERROR;
}
-wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, size_t nbytes)
+wxSocketImpl *wxSocketImpl::Accept(wxSocketBase& wxsocket)
{
- struct {
- char sig[4];
- char len[4];
- } msg;
+ wxSockAddressStorage from;
+ WX_SOCKLEN_T fromlen = sizeof(from);
+ const wxSOCKET_T fd = accept(m_fd, &from.addr, &fromlen);
- // warning about 'cast truncates constant value'
-#ifdef __VISUALC__
- #pragma warning(disable: 4310)
-#endif // __VISUALC__
+ // accepting is similar to reading in the sense that it resets "ready for
+ // read" flag on the socket
+ ReenableEvents(wxSOCKET_INPUT_FLAG);
- msg.sig[0] = (char) 0xad;
- msg.sig[1] = (char) 0xde;
- msg.sig[2] = (char) 0xed;
- msg.sig[3] = (char) 0xfe;
+ if ( fd == INVALID_SOCKET )
+ return NULL;
- msg.len[0] = (char) nbytes & 0xff;
- msg.len[1] = (char) (nbytes >> 8) & 0xff;
- msg.len[2] = (char) (nbytes >> 16) & 0xff;
- msg.len[3] = (char) (nbytes >> 24) & 0xff;
+ wxSocketManager * const manager = wxSocketManager::Get();
+ if ( !manager )
+ return NULL;
- if (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg))
- return *this;
- if (Write(buffer, nbytes).LastCount() < nbytes)
- return *this;
+ wxSocketImpl * const sock = manager->CreateSocket(wxsocket);
+ if ( !sock )
+ return NULL;
- msg.sig[0] = (char) 0xed;
- msg.sig[1] = (char) 0xfe;
- msg.sig[2] = (char) 0xad;
- msg.sig[3] = (char) 0xde;
- msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = (char) 0;
- Write((char *)&msg, sizeof(msg));
+ sock->m_fd = fd;
+ sock->m_peer = wxSockAddressImpl(from.addr, fromlen);
- return *this;
+ sock->UnblockAndRegisterWithEventLoop();
-#ifdef __VISUALC__
- #pragma warning(default: 4310)
-#endif // __VISUALC__
+ return sock;
}
-wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes)
+
+void wxSocketImpl::Close()
{
- m_lcount = 0;
- if (nbytes != 0) {
- CreatePushbackAfter(buffer, nbytes);
- m_lcount = nbytes;
- }
- return *this;
+ if ( m_fd != INVALID_SOCKET )
+ {
+ DoClose();
+ m_fd = INVALID_SOCKET;
+ }
}
-bool wxSocketBase::IsData() const
+void wxSocketImpl::Shutdown()
{
- struct timeval tv;
- fd_set sock_set;
+ if ( m_fd != INVALID_SOCKET )
+ {
+ shutdown(m_fd, 1 /* SD_SEND */);
+ Close();
+ }
+}
- if (m_fd < 0)
- return FALSE;
- if (m_unrd_size > 0)
- return TRUE;
+/*
+ * Sets the timeout for blocking calls. Time is expressed in
+ * milliseconds.
+ */
+void wxSocketImpl::SetTimeout(unsigned long millis)
+{
+ SetTimeValFromMS(m_timeout, millis);
+}
- m_internal->AcquireFD();
+void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event)
+{
+ m_wxsocket->OnRequest(event);
+}
- tv.tv_sec = 0;
- tv.tv_usec = 0;
- FD_ZERO(&sock_set);
- FD_SET(m_fd, &sock_set);
- select(m_fd+1, &sock_set, NULL, NULL, &tv);
+/* 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;
+ }
- m_internal->ReleaseFD();
+ if ( !local.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
+
+ m_local = local;
- return (FD_ISSET(m_fd, &sock_set) != 0);
+ return wxSOCKET_NOERROR;
}
-// ---------------------------------------------------------------------
-// --------- wxSocketBase Discard(): deletes all byte in the input queue
-// ---------------------------------------------------------------------
-void wxSocketBase::Discard()
+wxSocketError wxSocketImpl::SetPeer(const wxSockAddressImpl& peer)
{
-#define MAX_BUFSIZE (10*1024)
- char *my_data = new char[MAX_BUFSIZE];
- size_t recv_size = MAX_BUFSIZE;
+ if ( !peer.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
- SaveState();
- SetFlags((wxSockFlags)(NOWAIT | SPEED));
+ m_peer = peer;
- while (recv_size == MAX_BUFSIZE)
- {
- recv_size = Read(my_data, MAX_BUFSIZE).LastCount();
- }
+ return wxSOCKET_NOERROR;
+}
- RestoreState();
- delete [] my_data;
+const wxSockAddressImpl& wxSocketImpl::GetLocal()
+{
+ if ( !m_local.IsOk() )
+ UpdateLocalAddress();
-#undef MAX_BUFSIZE
+ return m_local;
}
-// If what? Who seems to need unsigned int?
-// BTW uint isn't even defined on wxMSW for VC++ for some reason. Even if it
-// were, getpeername/getsockname don't take unsigned int*, they take int*.
-//
-// Under glibc 2.0.7, socketbits.h declares socklen_t to be unsigned int
-// and it uses *socklen_t as the 3rd parameter. Robert.
+// ----------------------------------------------------------------------------
+// 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
-// JACS - How can we detect this?
-// Meanwhile, if your compiler complains about socklen_t,
-// switch lines below.
+int wxSocketImpl::RecvStream(void *buffer, int size)
+{
+ int ret;
+ DO_WHILE_EINTR( ret, recv(m_fd, static_cast<char *>(buffer), size, 0) );
-#if wxHAVE_GLIBC2
-# define wxSOCKET_INT socklen_t
-#else
-# define wxSOCKET_INT int
+ if ( !ret )
+ {
+ // receiving 0 bytes for a TCP socket indicates that the connection was
+ // closed by peer so shut down our end as well (for UDP sockets empty
+ // datagrams are also possible)
+ m_establishing = false;
+ NotifyOnStateChange(wxSOCKET_LOST);
+
+ Shutdown();
+
+ // do not return an error in this case however
+ }
+
+ return ret;
+}
+
+int wxSocketImpl::SendStream(const void *buffer, int size)
+{
+#ifdef wxNEEDS_IGNORE_SIGPIPE
+ IgnoreSignal ignore(SIGPIPE);
#endif
-// --------------------------------------------------------------
-// wxSocketBase socket info functions
-// --------------------------------------------------------------
+ int ret;
+ DO_WHILE_EINTR( ret, send(m_fd, static_cast<const char *>(buffer), size,
+ wxSOCKET_MSG_NOSIGNAL) );
+
+ return ret;
+}
-bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
+int wxSocketImpl::RecvDgram(void *buffer, int size)
{
- struct sockaddr my_addr;
- wxSOCKET_INT len_addr = sizeof(my_addr);
+ wxSockAddressStorage from;
+ WX_SOCKLEN_T fromlen = sizeof(from);
- if (m_fd < 0)
- return FALSE;
+ int ret;
+ DO_WHILE_EINTR( ret, recvfrom(m_fd, static_cast<char *>(buffer), size,
+ 0, &from.addr, &fromlen) );
- m_internal->AcquireFD();
+ if ( ret == SOCKET_ERROR )
+ return SOCKET_ERROR;
- if (getpeername(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) {
- m_internal->ReleaseFD();
- return FALSE;
- }
+ m_peer = wxSockAddressImpl(from.addr, fromlen);
+ if ( !m_peer.IsOk() )
+ return -1;
- m_internal->ReleaseFD();
- addr_man.Disassemble(&my_addr, len_addr);
- return TRUE;
+ return ret;
}
-bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
+int wxSocketImpl::SendDgram(const void *buffer, int size)
{
- struct sockaddr my_addr;
- wxSOCKET_INT len_addr = sizeof(my_addr);
+ if ( !m_peer.IsOk() )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return -1;
+ }
- if (m_fd < 0)
- return FALSE;
+ int ret;
+ DO_WHILE_EINTR( ret, sendto(m_fd, static_cast<const char *>(buffer), size,
+ 0, m_peer.GetAddr(), m_peer.GetLen()) );
- m_internal->AcquireFD();
+ return ret;
+}
- if (getsockname(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) {
- m_internal->ReleaseFD();
- return FALSE;
- }
- m_internal->ReleaseFD();
+int wxSocketImpl::Read(void *buffer, int size)
+{
+ // server sockets can't be used for IO, only to accept new connections
+ if ( m_fd == INVALID_SOCKET || m_server )
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return -1;
+ }
- addr_man.Disassemble(&my_addr, len_addr);
- return TRUE;
-}
+ int ret = m_stream ? RecvStream(buffer, size)
+ : RecvDgram(buffer, size);
-// --------------------------------------------------------------
-// wxSocketBase wait functions
-// --------------------------------------------------------------
+ m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR;
-void wxSocketBase::SaveState()
+ return ret;
+}
+
+int wxSocketImpl::Write(const void *buffer, int size)
{
- SocketState *state = new SocketState;
+ if ( m_fd == INVALID_SOCKET || m_server )
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return -1;
+ }
+
+ int ret = m_stream ? SendStream(buffer, size)
+ : SendDgram(buffer, size);
- state->notify_state = m_notify_state;
- state->evt_notify_state = m_neededreq;
- state->socket_flags = m_flags;
- state->c_callback = m_cbk;
- state->c_callback_data = m_cdata;
+ m_error = ret == SOCKET_ERROR ? GetLastError() : wxSOCKET_NOERROR;
- m_states.Append((wxObject *)state);
+ return ret;
}
-void wxSocketBase::RestoreState()
+// ==========================================================================
+// wxSocketBase
+// ==========================================================================
+
+// --------------------------------------------------------------------------
+// Initialization and shutdown
+// --------------------------------------------------------------------------
+
+namespace
{
- wxNode *node;
- SocketState *state;
- node = m_states.Last();
- if (!node)
- return;
+// 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;
- state = (SocketState *)node->Data();
+} // anonymous namespace
- SetFlags(state->socket_flags);
- m_internal->AcquireData();
- m_neededreq = state->evt_notify_state;
- m_internal->ReleaseData();
- m_cbk = state->c_callback;
- m_cdata = state->c_callback_data;
- Notify(state->notify_state);
+bool wxSocketBase::IsInitialized()
+{
+ wxASSERT_MSG( wxIsMainThread(), "unsafe to call from other threads" );
- delete node;
- delete state;
+ return gs_socketInitCount != 0;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase callback functions --------------------
-// --------------------------------------------------------------
-
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
+bool wxSocketBase::Initialize()
{
- wxSockCbk old_cbk = cbk_;
+ wxCHECK_MSG( wxIsMainThread(), false,
+ "must be called from the main thread" );
+
+ if ( !gs_socketInitCount )
+ {
+ wxSocketManager * const manager = wxSocketManager::Get();
+ if ( !manager || !manager->OnInit() )
+ return false;
+ }
- m_cbk = cbk_;
- return old_cbk;
+ gs_socketInitCount++;
+
+ return true;
}
-char *wxSocketBase::CallbackData(char *data)
+void wxSocketBase::Shutdown()
{
- char *old_data = m_cdata;
+ 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" );
- m_cdata = data;
- return old_data;
+ manager->OnExit();
+ }
}
-// --------------------------------------------------------------
-// --------- wxSocketBase wait functions ------------------------
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
-bool wxSocketBase::_Wait(long seconds, long milliseconds, int type)
+void wxSocketBase::Init()
{
- SockRequest *req;
+ m_impl = NULL;
+ m_type = wxSOCKET_UNINIT;
+
+ // state
+ m_flags = 0;
+ m_connected =
+ m_establishing =
+ m_reading =
+ m_writing =
+ m_closed = false;
+ m_lcount = 0;
+ m_lcount_read = 0;
+ m_lcount_write = 0;
+ m_timeout = 600;
+ m_beingDeleted = false;
+
+ // pushback buffer
+ m_unread = NULL;
+ m_unrd_size = 0;
+ m_unrd_cur = 0;
+
+ // events
+ m_id = wxID_ANY;
+ m_handler = NULL;
+ m_clientData = NULL;
+ m_notify = false;
+ m_eventmask =
+ m_eventsgot = 0;
+
+ // 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() )
+ {
+ if ( !Initialize() )
+ {
+ wxLogError(_("Cannot initialize sockets"));
+ }
+ }
+}
- if ((!m_connected && !m_connecting) || m_fd < 0)
- return FALSE;
+wxSocketBase::wxSocketBase()
+{
+ Init();
+}
- req = new SockRequest;
+wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
+{
+ Init();
- req->type = REQ_WAIT | type;
- req->timeout = seconds * 1000 + milliseconds;
- req->done = FALSE;
- req->buffer = NULL;
- req->size = 0;
- req->error = 0;
- req->wait = TRUE;
- m_internal->QueueRequest(req, TRUE);
+ SetFlags(flags);
- return (req->io_nbytes != 0);
+ m_type = type;
}
-bool wxSocketBase::Wait(long seconds, long milliseconds)
+wxSocketBase::~wxSocketBase()
{
- return _Wait(seconds, milliseconds, REQ_ACCEPT | REQ_CONNECT |
- REQ_READ | REQ_WRITE | REQ_LOST);
+ // Shutdown and close the socket
+ if (!m_beingDeleted)
+ Close();
+
+ // Destroy the implementation object
+ delete m_impl;
+
+ // Free the pushback buffer
+ free(m_unread);
}
-bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
+bool wxSocketBase::Destroy()
{
- return _Wait(seconds, milliseconds, REQ_READ | REQ_LOST);
+ // Delayed destruction: the socket will be deleted during the next idle
+ // loop iteration. This ensures that all pending events have been
+ // processed.
+ m_beingDeleted = true;
+
+ // Shutdown and close the socket
+ Close();
+
+ // Suppress events from now on
+ Notify(false);
+
+ // 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 )
+ {
+ wxTheApp->ScheduleForDestruction(this);
+ }
+ else // no app
+ {
+ // in wxBase we might have no app object at all, don't leak memory
+ delete this;
+ }
+
+ return true;
}
-bool wxSocketBase::WaitForWrite(long seconds, long milliseconds)
+// ----------------------------------------------------------------------------
+// simple accessors
+// ----------------------------------------------------------------------------
+
+void wxSocketBase::SetError(wxSocketError error)
{
- return _Wait(seconds, milliseconds, REQ_WRITE);
+ m_impl->m_error = error;
}
-bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
+wxSocketError wxSocketBase::LastError() const
{
- return _Wait(seconds, milliseconds, REQ_LOST);
+ return m_impl->GetError();
}
-// --------------------------------------------------------------
-// --------- wxSocketBase callback management -------------------
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Basic IO calls
+// --------------------------------------------------------------------------
-wxSocketBase::wxRequestNotify wxSocketBase::EventToNotify(wxRequestEvent evt)
+// The following IO operations update m_lcount:
+// {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard}
+bool wxSocketBase::Close()
{
- switch (evt)
- {
- case EVT_READ:
- return REQ_READ;
- case EVT_PEEK:
- return REQ_PEEK;
- case EVT_WRITE:
- return REQ_WRITE;
- case EVT_LOST:
- return REQ_LOST;
- case EVT_ACCEPT:
- return REQ_ACCEPT;
- case EVT_CONNECT:
- return REQ_CONNECT;
- }
- return 0;
+ // Interrupt pending waits
+ InterruptWait();
+
+ ShutdownOutput();
+
+ m_connected = false;
+ m_establishing = false;
+ return true;
}
-void wxSocketBase::SetFlags(wxSockFlags _flags)
+void wxSocketBase::ShutdownOutput()
{
- m_flags = _flags;
- if (_flags & SPEED) {
- // SPEED and WAITALL are antagonists.
- m_flags = (wxSockFlags)(m_flags & ~WAITALL);
- }
+ if ( m_impl )
+ m_impl->Shutdown();
}
-wxSocketBase::wxSockFlags wxSocketBase::GetFlags() const
+wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
{
- return m_flags;
+ wxSocketReadGuard read(this);
+
+ m_lcount_read = DoRead(buffer, nbytes);
+ m_lcount = m_lcount_read;
+
+ return *this;
}
-void wxSocketBase::SetNotify(wxRequestNotify flags)
+wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
{
- /* Check if server */
- if (m_type != SOCK_SERVER)
- flags &= ~REQ_ACCEPT;
+ 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" );
- m_internal->AcquireData();
- m_neededreq = flags;
- m_internal->ReleaseData();
- if (m_neededreq == 0)
- m_internal->StopWaiter();
- else
- Notify(m_notify_state);
+ // Try the push back buffer first, even before checking whether the socket
+ // is valid to allow reading previously pushed back data from an already
+ // closed socket.
+ wxUint32 total = GetPushback(buffer, nbytes, false);
+ nbytes -= total;
+ buffer += total;
+
+ while ( 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 )
+ {
+ // 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;
+ }
+
+ // 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 we are happy to read something and not the entire nbytes bytes,
+ // then we're done
+ if ( !(m_flags & wxSOCKET_WAITALL_READ) )
+ break;
+
+ nbytes -= ret;
+ buffer += ret;
+ }
+
+ return total;
}
-void wxSocketBase::Notify(bool notify)
+wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
{
- m_notify_state = notify;
- if (m_fd == INVALID_SOCKET)
- return;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
+
+ wxSocketReadGuard read(this);
+
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL_READ);
+
+ bool ok = false;
+ if ( DoRead(&msg, sizeof(msg)) == sizeof(msg) )
+ {
+ wxUint32 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 )
+ {
+ wxUint32 len = (wxUint32)msg.len[0];
+ len |= (wxUint32)(msg.len[1] << 8);
+ len |= (wxUint32)(msg.len[2] << 16);
+ len |= (wxUint32)(msg.len[3] << 24);
+
+ 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.
+ m_lcount_read = len ? DoRead(buffer, len) : 0;
+ m_lcount = m_lcount_read;
+
+ 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 && 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);
+
+ if ( sig == 0xdeadfeed )
+ ok = true;
+ }
+ }
+ }
+
+ if ( !ok )
+ SetError(wxSOCKET_IOERR);
- if (notify)
- m_internal->ResumeWaiter();
- else
- m_internal->StopWaiter();
+ return *this;
}
-void wxSocketBase::OnRequest(wxRequestEvent req_evt)
+wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
- wxSocketEvent event(m_id);
- wxRequestNotify notify = EventToNotify(req_evt);
+ wxSocketReadGuard read(this);
+
+ // Peek() should never block
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT);
- if ((m_neededreq & notify) == notify) {
- event.m_socket = this;
- event.m_skevt = req_evt;
- ProcessEvent(event);
- // TODOTODO
- // OldOnNotify(req_evt);
+ m_lcount = DoRead(buffer, nbytes);
- // We disable the event reporting.
- m_neededreq &= ~notify;
- }
+ Pushback(buffer, m_lcount);
+
+ return *this;
}
-wxSocketEvent::wxSocketEvent(int id)
- : wxEvent(id)
+wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
{
- wxEventType type = (wxEventType)wxEVT_SOCKET;
+ wxSocketWriteGuard write(this);
+
+ m_lcount_write = DoWrite(buffer, nbytes);
+ m_lcount = m_lcount_write;
- SetEventType(type);
+ return *this;
}
-void wxSocketEvent::CopyObject(wxObject& obj_d) const
+// This function is a mirror image of DoRead() except that it doesn't use the
+// 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)
{
- wxSocketEvent *event = (wxSocketEvent *)&obj_d;
+ wxCHECK_MSG( m_impl, 0, "socket must be valid" );
+
+ const char *buffer = static_cast<const char *>(buffer_);
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
- wxEvent::CopyObject(obj_d);
+ wxUint32 total = 0;
+ while ( nbytes )
+ {
+ if ( m_impl->m_stream && !m_connected )
+ {
+ if ( (m_flags & wxSOCKET_WAITALL_WRITE) || !total )
+ SetError(wxSOCKET_IOERR);
+ break;
+ }
+
+ const int ret = m_impl->Write(buffer, nbytes);
+ if ( ret == -1 )
+ {
+ if ( m_impl->GetLastError() == wxSOCKET_WOULDBLOCK )
+ {
+ if ( m_flags & wxSOCKET_NOWAIT_WRITE )
+ break;
+
+ if ( !DoWaitWithTimeout(wxSOCKET_OUTPUT_FLAG) )
+ {
+ SetError(wxSOCKET_TIMEDOUT);
+ break;
+ }
+
+ continue;
+ }
+ else // "real" error
+ {
+ SetError(wxSOCKET_IOERR);
+ break;
+ }
+ }
+
+ total += ret;
+
+ if ( !(m_flags & wxSOCKET_WAITALL_WRITE) )
+ break;
+
+ nbytes -= ret;
+ buffer += ret;
+ }
- event->m_skevt = m_skevt;
- event->m_socket = m_socket;
+ return total;
}
-void wxSocketBase::OldOnNotify(wxRequestEvent evt)
+wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
{
-}
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
-// --------------------------------------------------------------
-// --------- wxSocketBase functions [Callback, CallbackData] ----
-// --------------------------------------------------------------
+ wxSocketWriteGuard write(this);
-void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id)
-{
- SetNextHandler(&h_evt);
- m_id = id;
-}
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_WAITALL_WRITE);
-// --------------------------------------------------------------
-// --------- wxSocketBase pushback library ----------------------
-// --------------------------------------------------------------
+ msg.sig[0] = (unsigned char) 0xad;
+ msg.sig[1] = (unsigned char) 0xde;
+ msg.sig[2] = (unsigned char) 0xed;
+ msg.sig[3] = (unsigned char) 0xfe;
-void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size)
-{
- char *curr_pos;
+ msg.len[0] = (unsigned char) (nbytes & 0xff);
+ msg.len[1] = (unsigned char) ((nbytes >> 8) & 0xff);
+ msg.len[2] = (unsigned char) ((nbytes >> 16) & 0xff);
+ msg.len[3] = (unsigned char) ((nbytes >> 24) & 0xff);
+
+ bool ok = false;
+ if ( DoWrite(&msg, sizeof(msg)) == sizeof(msg) )
+ {
+ m_lcount_write = DoWrite(buffer, nbytes);
+ m_lcount = m_lcount_write;
+ if ( m_lcount_write == nbytes )
+ {
+ msg.sig[0] = (unsigned char) 0xed;
+ msg.sig[1] = (unsigned char) 0xfe;
+ msg.sig[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;
+ }
+ }
- if (m_unread != NULL)
- m_unread = (char *) realloc(m_unread, m_unrd_size+size);
- else
- m_unread = (char *) malloc(size);
- curr_pos = m_unread + m_unrd_size;
+ if ( !ok )
+ SetError(wxSOCKET_IOERR);
- memcpy(curr_pos, buffer, size);
- m_unrd_size += size;
+ return *this;
}
-void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size)
+wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
{
- char *curr_pos, *new_buf;
+ if (nbytes != 0)
+ Pushback(buffer, nbytes);
- new_buf = (char *) malloc(m_unrd_size+size);
- curr_pos = new_buf + size;
+ SetError(wxSOCKET_NOERROR);
+ m_lcount = nbytes;
- memcpy(new_buf, buffer, size);
- if (m_unrd_size != 0) {
- memcpy(curr_pos, m_unread, m_unrd_size);
- free(m_unread);
- }
- m_unread = new_buf;
- m_unrd_size += size;
+ return *this;
}
-size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek)
+wxSocketBase& wxSocketBase::Discard()
{
- if (!m_unrd_size)
- return 0;
+ char *buffer = new char[MAX_DISCARD_SIZE];
+ wxUint32 ret;
+ wxUint32 total = 0;
+
+ wxSocketReadGuard read(this);
- if (size > m_unrd_size)
- size = m_unrd_size;
- memcpy(buffer, m_unread, size);
+ wxSocketWaitModeChanger changeFlags(this, wxSOCKET_NOWAIT);
- if (!peek) {
- m_unrd_size -= size;
- if (m_unrd_size == 0) {
- free(m_unread);
- m_unread = NULL;
+ do
+ {
+ ret = DoRead(buffer, MAX_DISCARD_SIZE);
+ total += ret;
}
- }
+ while (ret == MAX_DISCARD_SIZE);
+
+ delete[] buffer;
+ m_lcount = total;
+ SetError(wxSOCKET_NOERROR);
- return size;
+ return *this;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase buffer core requester -----------------
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Wait functions
+// --------------------------------------------------------------------------
-void wxSocketBase::WantBuffer(char *buffer, size_t nbytes,
- wxRequestEvent evt)
+/*
+ This function will check for the events specified in the flags parameter,
+ and it will return a mask indicating which operations can be performed.
+ */
+wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags,
+ const timeval *timeout)
{
- bool buf_timed_out;
+ if ( m_fd == INVALID_SOCKET )
+ return (wxSOCKET_LOST_FLAG & flags);
+
+ struct timeval tv;
+ if ( timeout )
+ tv = *timeout;
+ else
+ tv.tv_sec = tv.tv_usec = 0;
+
+ // prepare the FD sets, passing NULL for the one(s) we don't use
+ fd_set
+ readfds, *preadfds = NULL,
+ writefds, *pwritefds = NULL,
+ exceptfds; // always want to know about errors
+
+ if ( flags & wxSOCKET_INPUT_FLAG )
+ preadfds = &readfds;
+
+ 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 (m_fd == INVALID_SOCKET || !m_handler || !m_connected)
- return;
+ if ( preadfds )
+ {
+ wxFD_ZERO(preadfds);
+ wxFD_SET(m_fd, preadfds);
+ }
- SockRequest *buf = new SockRequest;
+ if ( pwritefds )
+ {
+ wxFD_ZERO(pwritefds);
+ wxFD_SET(m_fd, pwritefds);
+ }
- SaveState();
- buf->buffer = buffer;
- buf->size = nbytes;
- buf->done = FALSE;
- buf->type = EventToNotify(evt);
- buf->io_nbytes = 0;
- buf->error = 0;
- buf->wait = TRUE;
- buf->timeout = 1000;
- buf_timed_out = FALSE;
+ wxFD_ZERO(&exceptfds);
+ wxFD_SET(m_fd, &exceptfds);
- if ((m_flags & SPEED) != 0)
- m_internal->QueueRequest(buf, FALSE);
- else
- if ((m_flags & NOWAIT) != 0)
- m_internal->QueueRequest(buf, TRUE);
- else
- m_internal->QueueRequest(buf, TRUE);
- m_lcount += buf->io_nbytes;
- if (buf_timed_out)
- m_error = ETIMEDOUT;
- else
- m_error = buf->error;
+ const int rc = select(m_fd + 1, preadfds, pwritefds, &exceptfds, &tv);
- delete buf;
- RestoreState();
+ // check for errors first
+ if ( rc == -1 || wxFD_ISSET(m_fd, &exceptfds) )
+ {
+ m_establishing = false;
+
+ return wxSOCKET_LOST_FLAG & flags;
+ }
+
+ if ( rc == 0 )
+ return 0;
+
+ wxASSERT_MSG( rc == 1, "unexpected select() return value" );
+
+ wxSocketEventFlags detected = 0;
+ if ( preadfds && wxFD_ISSET(m_fd, preadfds) )
+ detected |= wxSOCKET_INPUT_FLAG;
+
+ if ( pwritefds && wxFD_ISSET(m_fd, pwritefds) )
+ {
+ // check for the case of non-blocking connect()
+ if ( m_establishing && !m_server )
+ {
+ int error;
+ SOCKOPTLEN_T len = sizeof(error);
+ m_establishing = false;
+ getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len);
+
+ if ( error )
+ detected = wxSOCKET_LOST_FLAG;
+ else
+ detected |= wxSOCKET_CONNECTION_FLAG;
+ }
+ else // not called to get non-blocking connect() status
+ {
+ detected |= wxSOCKET_OUTPUT_FLAG;
+ }
+ }
+
+ return detected & flags;
}
-// --------------------------------------------------------------
-// wxSocketServer
-// --------------------------------------------------------------
+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);
+}
-wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
- wxSockFlags flags) :
- wxSocketBase(flags, SOCK_SERVER)
+int
+wxSocketBase::DoWait(long timeout, wxSocketEventFlags flags)
{
- m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0);
+ wxCHECK_MSG( m_impl, -1, "can't wait on invalid socket" );
- if (m_fd == INVALID_SOCKET)
- return;
+ // 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;
- int flag = 1;
- setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (char*)&flag, sizeof(int));
+ // This can be set to true from Interrupt() to exit this function a.s.a.p.
+ m_interrupt = false;
- struct sockaddr *myaddr;
- size_t len;
- addr_man.Build(myaddr, len);
- if (bind(m_fd, myaddr, addr_man.SockAddrLen()) < 0)
- return;
+ const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout;
- if (listen(m_fd, 5) < 0) {
- m_fd = INVALID_SOCKET;
- return;
- }
+ // Get the active event loop which we'll use for the message dispatching
+ // when running in the main thread unless this was explicitly disabled by
+ // setting wxSOCKET_BLOCK flag
+ wxEventLoopBase *eventLoop;
+ if ( !(m_flags & wxSOCKET_BLOCK) && wxIsMainThread() )
+ {
+ eventLoop = wxEventLoop::GetActive();
+ }
+ else // in worker thread
+ {
+ // We never dispatch messages from threads other than the main one.
+ eventLoop = NULL;
+ }
- m_internal->SetFD(m_fd);
+ // 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)
+ 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 )
+ {
+ // reset them before starting to wait
+ m_eventsgot = 0;
+
+ eventLoop->DispatchTimeout(timeLeft);
+
+ events = m_eventsgot;
+ }
+ else // no event loop or waiting in another thread
+ {
+ // as explained below, we should always check for wxSOCKET_LOST_FLAG
+ timeval tv;
+ SetTimeValFromMS(tv, timeLeft);
+ events = m_impl->Select(flags | wxSOCKET_LOST_FLAG, &tv);
+ }
+
+ // always check for wxSOCKET_LOST_FLAG, even if flags doesn't include
+ // it, as continuing to wait for anything else after getting it is
+ // pointless
+ if ( events & wxSOCKET_LOST_FLAG )
+ {
+ m_connected = false;
+ m_establishing = false;
+ rc = -1;
+ break;
+ }
+
+ // otherwise mask out the bits we're not interested in
+ events &= flags;
+
+ // Incoming connection (server) or connection established (client)?
+ if ( events & wxSOCKET_CONNECTION_FLAG )
+ {
+ m_connected = true;
+ m_establishing = false;
+ rc = true;
+ break;
+ }
+
+ // Data available or output buffer ready?
+ if ( (events & wxSOCKET_INPUT_FLAG) || (events & wxSOCKET_OUTPUT_FLAG) )
+ {
+ rc = true;
+ break;
+ }
+ }
- Notify(TRUE);
+ return rc;
}
-// --------------------------------------------------------------
-// wxSocketServer Accept
-// --------------------------------------------------------------
+bool wxSocketBase::Wait(long seconds, long milliseconds)
+{
+ return DoWait(seconds, milliseconds,
+ wxSOCKET_INPUT_FLAG |
+ wxSOCKET_OUTPUT_FLAG |
+ wxSOCKET_CONNECTION_FLAG) != 0;
+}
-bool wxSocketServer::AcceptWith(wxSocketBase& sock)
+bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
{
- int fd2;
+ // Check pushback buffer before entering DoWait
+ if ( m_unread )
+ return true;
+
+ // 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;
+}
- m_internal->AcquireFD();
- if ((fd2 = accept(m_fd, 0, 0)) < 0) {
- m_internal->ReleaseFD();
- return FALSE;
- }
- m_internal->ReleaseFD();
- struct linger linger;
- linger.l_onoff = 0;
- linger.l_linger = 1;
+bool wxSocketBase::WaitForWrite(long seconds, long milliseconds)
+{
+ if ( m_impl->Select(wxSOCKET_OUTPUT_FLAG) )
+ return true;
- setsockopt(fd2, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger));
+ return DoWait(seconds, milliseconds, wxSOCKET_OUTPUT_FLAG) != 0;
+}
- int flag = 0;
- setsockopt(fd2, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int));
+bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
+{
+ return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG) == -1;
+}
- sock.m_type = SOCK_INTERNAL;
- sock.m_fd = fd2;
- sock.m_connected = TRUE;
+// --------------------------------------------------------------------------
+// Miscellaneous
+// --------------------------------------------------------------------------
- sock.m_internal->SetFD(fd2);
+//
+// Get local or peer address
+//
- sock.m_internal->ResumeWaiter();
+bool wxSocketBase::GetPeer(wxSockAddress& addr) const
+{
+ wxCHECK_MSG( m_impl, false, "invalid socket" );
+
+ const wxSockAddressImpl& peer = m_impl->GetPeer();
+ if ( !peer.IsOk() )
+ return false;
- return TRUE;
+ addr.SetAddress(peer);
+
+ return true;
}
-wxSocketBase *wxSocketServer::Accept()
+bool wxSocketBase::GetLocal(wxSockAddress& addr) const
{
- wxSocketBase* sock = new wxSocketBase();
-
- sock->SetFlags((wxSockFlags)m_flags);
+ wxCHECK_MSG( m_impl, false, "invalid socket" );
- if (!AcceptWith(*sock))
- return NULL;
+ const wxSockAddressImpl& local = m_impl->GetLocal();
+ if ( !local.IsOk() )
+ return false;
- if (m_handler)
- m_handler->Register(sock);
+ addr.SetAddress(local);
- return sock;
+ return true;
}
-// --------------------------------------------------------------
-// wxSocketClient
-// --------------------------------------------------------------
+//
+// Save and restore socket state
+//
-// --------- wxSocketClient CONSTRUCTOR -------------------------
-// --------------------------------------------------------------
-wxSocketClient::wxSocketClient(wxSockFlags _flags) :
- wxSocketBase(_flags, SOCK_CLIENT)
+void wxSocketBase::SaveState()
{
+ wxSocketState *state;
+
+ state = new wxSocketState();
+
+ state->m_flags = m_flags;
+ state->m_notify = m_notify;
+ state->m_eventmask = m_eventmask;
+ state->m_clientData = m_clientData;
+
+ m_states.Append(state);
}
-// --------------------------------------------------------------
-// --------- wxSocketClient DESTRUCTOR --------------------------
-// --------------------------------------------------------------
-wxSocketClient::~wxSocketClient()
+void wxSocketBase::RestoreState()
{
+ wxList::compatibility_iterator node;
+ wxSocketState *state;
+
+ node = m_states.GetLast();
+ if (!node)
+ return;
+
+ state = (wxSocketState *)node->GetData();
+
+ m_flags = state->m_flags;
+ m_notify = state->m_notify;
+ m_eventmask = state->m_eventmask;
+ m_clientData = state->m_clientData;
+
+ m_states.Erase(node);
+ delete state;
}
-// --------------------------------------------------------------
-// --------- wxSocketClient Connect functions -------------------
-// --------------------------------------------------------------
-bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) )
-{
- struct linger linger;
+//
+// Timeout and flags
+//
- if (IsConnected())
- Close();
+void wxSocketBase::SetTimeout(long seconds)
+{
+ m_timeout = seconds;
- // Initializes all socket stuff ...
- // --------------------------------
- m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0);
+ if (m_impl)
+ m_impl->SetTimeout(m_timeout * 1000);
+}
- if (m_fd < 0)
- return FALSE;
+void wxSocketBase::SetFlags(wxSocketFlags flags)
+{
+ // Do some sanity checking on the flags used: not all values can be used
+ // together.
+ wxASSERT_MSG( !(flags & wxSOCKET_NOWAIT) ||
+ !(flags & (wxSOCKET_WAITALL | wxSOCKET_BLOCK)),
+ "Using wxSOCKET_WAITALL or wxSOCKET_BLOCK with "
+ "wxSOCKET_NOWAIT doesn't make sense" );
+
+ m_flags = flags;
+}
- m_connected = FALSE;
- linger.l_onoff = 1;
- linger.l_linger = 5;
- setsockopt(m_fd, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger));
+// --------------------------------------------------------------------------
+// Event handling
+// --------------------------------------------------------------------------
- // Stay in touch with the state of things...
+void wxSocketBase::OnRequest(wxSocketNotify notification)
+{
+ wxSocketEventFlags flag = 0;
+ switch ( notification )
+ {
+ case wxSOCKET_INPUT:
+ flag = wxSOCKET_INPUT_FLAG;
+ break;
- unsigned long flag = 1;
- setsockopt(m_fd, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int));
+ case wxSOCKET_OUTPUT:
+ flag = wxSOCKET_OUTPUT_FLAG;
+ break;
- // Disable the nagle algorithm, which delays sends till the
- // buffer is full (or a certain time period has passed?)...
+ case wxSOCKET_CONNECTION:
+ flag = wxSOCKET_CONNECTION_FLAG;
-#if defined(__WINDOWS__) || (defined(IPPROTO_TCP) && defined(TCP_NODELAY))
- flag = 1;
- setsockopt(m_fd, IPPROTO_TCP, TCP_NODELAY, (char*)&flag, sizeof(int));
-#endif
+ // we're now successfully connected
+ m_connected = true;
+ m_establishing = false;
- struct sockaddr *remote;
- size_t len;
+ // error was previously set to wxSOCKET_WOULDBLOCK, but this is not
+ // the case any longer
+ SetError(wxSOCKET_NOERROR);
+ break;
- addr_man.Build(remote, len);
+ case wxSOCKET_LOST:
+ flag = wxSOCKET_LOST_FLAG;
- if (connect(m_fd, remote, len) != 0)
- return FALSE;
+ // if we lost the connection the socket is now closed and not
+ // connected any more
+ m_connected = false;
+ m_closed = true;
+ break;
- m_internal->SetFD(m_fd);
+ default:
+ wxFAIL_MSG( "unknown wxSocket notification" );
+ }
- // Enables bg events.
- // ------------------
- Notify(TRUE);
+ // remember the events which were generated for this socket, we're going to
+ // use this in DoWait()
+ m_eventsgot |= flag;
- m_connected = TRUE;
- return TRUE;
+ // 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;
+ event.SetEventObject(this);
+
+ m_handler->AddPendingEvent(event);
+ }
}
-bool wxSocketClient::WaitOnConnect(long seconds, long microseconds)
+void wxSocketBase::Notify(bool notify)
{
- int ret = _Wait(seconds, microseconds, REQ_CONNECT | REQ_LOST);
+ m_notify = notify;
+}
- if (ret)
- m_connected = TRUE;
+void wxSocketBase::SetNotify(wxSocketEventFlags flags)
+{
+ m_eventmask = flags;
+}
- return m_connected;
+void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
+{
+ m_handler = &handler;
+ m_id = id;
}
-void wxSocketClient::OnRequest(wxRequestEvent evt)
+// --------------------------------------------------------------------------
+// Pushback buffer
+// --------------------------------------------------------------------------
+
+void wxSocketBase::Pushback(const void *buffer, wxUint32 size)
{
- if (evt == EVT_CONNECT)
- {
- if (m_connected)
+ if (!size) return;
+
+ if (m_unread == NULL)
+ m_unread = malloc(size);
+ else
{
- m_neededreq &= ~REQ_CONNECT;
- return;
+ void *tmp;
+
+ tmp = malloc(m_unrd_size + size);
+ memcpy((char *)tmp + size, m_unread, m_unrd_size);
+ free(m_unread);
+
+ m_unread = tmp;
}
- m_connected = TRUE;
- return;
- }
- wxSocketBase::OnRequest(evt);
-}
-/////////////////////////////////////////////////////////////////
-// wxSocketHandler ///////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////
+ m_unrd_size += size;
-wxSocketHandler *wxSocketHandler::master = NULL;
-#if defined(__WINDOWS__)
-static int win_initialized = 0;
-#endif
+ memcpy(m_unread, buffer, size);
+}
-// --------------------------------------------------------------
-// --------- wxSocketHandler CONSTRUCTOR ------------------------
-// --------------------------------------------------------------
-wxSocketHandler::wxSocketHandler()
+wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek)
{
-#if defined(__WINDOWS__)
- if (!win_initialized)
- {
- WSADATA wsaData;
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
- WSAStartup((1 << 8) | 1, &wsaData);
- win_initialized = 1;
- }
-#endif
+ if (!m_unrd_size)
+ return 0;
- socks = new wxList;
+ if (size > (m_unrd_size-m_unrd_cur))
+ size = m_unrd_size-m_unrd_cur;
-#ifndef __WINDOWS__
- signal(SIGPIPE, SIG_IGN);
-#endif
+ memcpy(buffer, (char *)m_unread + m_unrd_cur, size);
+
+ if (!peek)
+ {
+ m_unrd_cur += size;
+ if (m_unrd_size == m_unrd_cur)
+ {
+ free(m_unread);
+ m_unread = NULL;
+ m_unrd_size = 0;
+ m_unrd_cur = 0;
+ }
+ }
+
+ return size;
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler DESTRUCTOR -------------------------
-// --------------------------------------------------------------
-wxSocketHandler::~wxSocketHandler()
+
+// ==========================================================================
+// wxSocketServer
+// ==========================================================================
+
+// --------------------------------------------------------------------------
+// Ctor
+// --------------------------------------------------------------------------
+
+wxSocketServer::wxSocketServer(const wxSockAddress& addr,
+ wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_SERVER)
{
- wxNode *next_node, *node = socks->First();
+ wxLogTrace( wxTRACE_Socket, wxT("Opening wxSocketServer") );
- while (node)
- {
- wxSocketBase* sock = (wxSocketBase*)node->Data();
+ wxSocketManager * const manager = wxSocketManager::Get();
+ m_impl = manager ? manager->CreateSocket(*this) : NULL;
- delete sock;
- next_node = node->Next();
- delete node;
- node = next_node;
- }
+ if (!m_impl)
+ {
+ wxLogTrace( wxTRACE_Socket, wxT("*** Failed to create m_impl") );
+ return;
+ }
- delete socks;
+ // Setup the socket as server
+ m_impl->SetLocal(addr.GetAddress());
-#ifdef __WINDOWS__
- WSACleanup();
- win_initialized = 0;
-#endif
+ if (GetFlags() & wxSOCKET_REUSEADDR) {
+ m_impl->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST) {
+ m_impl->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND) {
+ m_impl->DontDoBind();
+ }
+
+ if (m_impl->CreateServer() != wxSOCKET_NOERROR)
+ {
+ wxDELETE(m_impl);
+
+ wxLogTrace( wxTRACE_Socket, wxT("*** CreateServer() failed") );
+ return;
+ }
+
+ // 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) );
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler registering functions --------------
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Accept
+// --------------------------------------------------------------------------
-void wxSocketHandler::Register(wxSocketBase* sock)
+bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
- wxNode *node;
+ if ( !m_impl || (m_impl->m_fd == INVALID_SOCKET) || !m_impl->IsServer() )
+ {
+ wxFAIL_MSG( "can only be called for a valid server socket" );
- for (node = socks->First(); node != NULL; node = node->Next())
- {
- wxSocketBase* s = (wxSocketBase*)node->Data();
+ SetError(wxSOCKET_INVSOCK);
- if (s == sock)
- return;
- }
+ return false;
+ }
+
+ if ( wait )
+ {
+ // wait until we get a connection
+ if ( !m_impl->SelectWithTimeout(wxSOCKET_INPUT_FLAG) )
+ {
+ SetError(wxSOCKET_TIMEDOUT);
- if (sock)
- {
- socks->Append(sock);
- sock->SetHandler(this);
- }
+ return false;
+ }
+ }
+
+ 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;
+
+ return true;
}
-void wxSocketHandler::UnRegister(wxSocketBase* sock)
+wxSocketBase *wxSocketServer::Accept(bool wait)
{
- wxNode *node;
+ wxSocketBase* sock = new wxSocketBase();
- for (node = socks->First(); node; node = node->Next())
- {
- wxSocketBase* s = (wxSocketBase*)node->Data();
+ sock->SetFlags(m_flags);
- if (s == sock)
+ if (!AcceptWith(*sock, wait))
{
- delete node;
- sock->SetHandler(NULL);
- return;
+ sock->Destroy();
+ sock = NULL;
}
- }
+
+ return sock;
+}
+
+bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
+{
+ return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG) == 1;
}
-unsigned long wxSocketHandler::Count() const
+wxSOCKET_T wxSocketBase::GetSocket() const
{
- return socks->Number();
+ wxASSERT_MSG( m_impl, wxS("Socket not initialised") );
+
+ return m_impl->m_fd;
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler "big" wait functions ---------------
-// --------------------------------------------------------------
-int wxSocketHandler::Wait(long seconds, long microseconds)
+bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
{
- // TODO Needs the completely asynchronous notifier.
+ wxASSERT_MSG( m_impl, wxT("Socket not initialised") );
- /*
- int i;
- int on_wait;
- wxNode *node;
- for (node = socks->First(), i=0; node; node = node->Next(), i++)
- {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+ SOCKOPTLEN_T lenreal = *optlen;
+ if ( getsockopt(m_impl->m_fd, level, optname,
+ static_cast<char *>(optval), &lenreal) != 0 )
+ return false;
- sock->SaveState();
+ *optlen = lenreal;
- sock->SetupCallbacks();
+ return true;
+}
- sock->Callback(handler_cbk);
- sock->CallbackData((char *)&on_wait);
- }
- on_wait = 0;
- if (seconds != -1)
- s_wake.Start((seconds*1000) + (microseconds/1000), TRUE);
+bool
+wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen)
+{
+ wxASSERT_MSG( m_impl, wxT("Socket not initialised") );
- while (!on_wait)
- PROCESS_EVENTS();
+ return setsockopt(m_impl->m_fd, level, optname,
+ static_cast<const char *>(optval), optlen) == 0;
+}
- for (node = socks->First(), i=0; node; node = node->Next(), i++)
- {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+bool wxSocketBase::SetLocal(const wxIPV4address& local)
+{
+ m_localAddress = local;
- sock->RestoreState();
- }
+ return true;
+}
- if (on_wait == -2)
- return 0;
+// ==========================================================================
+// wxSocketClient
+// ==========================================================================
+
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
- return on_wait;
- */
- return 0;
+wxSocketClient::wxSocketClient(wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_CLIENT)
+{
+ m_initialRecvBufferSize =
+ m_initialSendBufferSize = -1;
}
-void wxSocketHandler::YieldSock()
+// --------------------------------------------------------------------------
+// Connect
+// --------------------------------------------------------------------------
+
+bool wxSocketClient::DoConnect(const wxSockAddress& remote,
+ const wxSockAddress* local,
+ bool wait)
{
- wxNode *node;
+ if ( m_impl )
+ {
+ // Shutdown and destroy the old socket
+ Close();
+ delete m_impl;
+ }
+
+ m_connected = false;
+ m_establishing = false;
+
+ // Create and set up the new one
+ wxSocketManager * const manager = wxSocketManager::Get();
+ m_impl = manager ? manager->CreateSocket(*this) : NULL;
+ if ( !m_impl )
+ return false;
- // Nothing to do anymore here except waiting for the queue emptying.
- for (node = socks->First(); node; node=node->Next()) {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+ // 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();
+
+ // 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;
+
+ if ( local )
+ m_impl->SetLocal(local->GetAddress());
+
+ m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
+
+ m_impl->SetPeer(remote.GetAddress());
+
+ // Finally do create the socket and connect to the peer
+ const wxSocketError err = m_impl->CreateClient(wait);
+
+ if ( err != wxSOCKET_NOERROR )
+ {
+ if ( err == wxSOCKET_WOULDBLOCK )
+ {
+ wxASSERT_MSG( !wait, "shouldn't get this for blocking connect" );
- sock->m_internal->WaitForEnd(NULL);
- }
+ m_establishing = true;
+ }
+
+ return false;
+ }
+
+ m_connected = true;
+ return true;
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler: create and register the socket ----
-// --------------------------------------------------------------
-wxSocketServer *wxSocketHandler::CreateServer(wxSockAddress& addr,
- wxSocketBase::wxSockFlags flags)
+bool wxSocketClient::Connect(const wxSockAddress& remote, bool wait)
{
- wxSocketServer *serv = new wxSocketServer(addr, flags);
+ return DoConnect(remote, NULL, wait);
+}
- Register(serv);
- return serv;
+bool wxSocketClient::Connect(const wxSockAddress& remote,
+ const wxSockAddress& local,
+ bool wait)
+{
+ return DoConnect(remote, &local, wait);
}
-wxSocketClient *wxSocketHandler::CreateClient(wxSocketBase::wxSockFlags flags)
+bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds)
{
- wxSocketClient *client = new wxSocketClient(flags);
+ if ( m_connected )
+ {
+ // this happens if the initial attempt to connect succeeded without
+ // blocking
+ return true;
+ }
- Register(client);
- return client;
+ wxCHECK_MSG( m_establishing && m_impl, false,
+ "No connection establishment attempt in progress" );
+
+ // 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;
}
-bool wxSocketModule::OnInit()
+// ==========================================================================
+// wxDatagramSocket
+// ==========================================================================
+
+wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
+ wxSocketFlags flags )
+ : wxSocketBase( flags, wxSOCKET_DATAGRAM )
{
- wxSocketHandler::master = new wxSocketHandler();
- return TRUE;
+ // Create the socket
+ wxSocketManager * const manager = wxSocketManager::Get();
+ m_impl = manager ? manager->CreateSocket(*this) : NULL;
+
+ if (!m_impl)
+ return;
+
+ // Setup the socket as non connection oriented
+ m_impl->SetLocal(addr.GetAddress());
+ if (flags & wxSOCKET_REUSEADDR)
+ {
+ m_impl->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST)
+ {
+ m_impl->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND)
+ {
+ m_impl->DontDoBind();
+ }
+
+ if ( m_impl->CreateUDP() != wxSOCKET_NOERROR )
+ {
+ wxDELETE(m_impl);
+ return;
+ }
+
+ // Initialize all stuff
+ m_connected = false;
+ m_establishing = false;
}
-void wxSocketModule::OnExit()
+wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr,
+ void* buf,
+ wxUint32 nBytes )
{
- delete wxSocketHandler::master;
- wxSocketHandler::master = NULL;
+ Read(buf, nBytes);
+ GetPeer(addr);
+ return (*this);
}
+wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr,
+ const void* buf,
+ wxUint32 nBytes )
+{
+ wxASSERT_MSG( m_impl, wxT("Socket not initialised") );
+
+ m_impl->SetPeer(addr.GetAddress());
+ Write(buf, nBytes);
+ return (*this);
+}
+
+// ==========================================================================
+// wxSocketModule
+// ==========================================================================
+
+class wxSocketModule : public wxModule
+{
+public:
+ virtual bool OnInit()
+ {
+ // wxSocketBase will call Initialize() itself only if sockets are
+ // really used, don't do it from here
+ return true;
+ }
+
+ virtual void OnExit()
+ {
+ if ( wxSocketBase::IsInitialized() )
+ wxSocketBase::Shutdown();
+ }
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxSocketModule)
+};
+
+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
- // __WXSTUBS__
+// same for ManagerSetter in the MSW file
+#ifdef __WINDOWS__
+ wxFORCE_LINK_MODULE( mswsocket )
#endif
- // wxUSE_SOCKETS
+
+// and for OSXManagerSetter in the OS X one
+#ifdef __WXOSX__
+ wxFORCE_LINK_MODULE( osxsocket )
+#endif
+
+#endif // wxUSE_SOCKETS
projects / wxWidgets.git / blobdiff