-////////////////////////////////////////////////////////////////////////////////
-// 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: March 1998
-// Copyright: (C) 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"
-#pragma interface
-#pragma implementation "socket.cpp"
-#endif
+// License: wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+// ==========================================================================
+// Declarations
+// ==========================================================================
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
-/////////////////////////////////////////////////////////////////////////////
-// wxWindows headers
-/////////////////////////////////////////////////////////////////////////////
-#include <wx/defs.h>
-#include <wx/object.h>
-#include <wx/string.h>
-#include <wx/timer.h>
-#include <wx/utils.h>
+#if wxUSE_SOCKETS
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
+#include "wx/socket.h"
-/////////////////////////////////////////////////////////////////////////////
-// System specific headers
-/////////////////////////////////////////////////////////////////////////////
-#if defined(__WINDOWS__)
-#include <winsock.h>
-#endif // __WINDOWS__
+#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
-#if defined(__UNIX__)
+#include "wx/apptrait.h"
+#include "wx/sckaddr.h"
+#include "wx/stopwatch.h"
+#include "wx/thread.h"
+#include "wx/evtloop.h"
-#ifdef VMS
-#include <socket.h>
-#else
-#include <sys/socket.h>
-#endif
-#include <sys/ioctl.h>
+#include "wx/private/fd.h"
+#include "wx/private/socket.h"
-#include <sys/time.h>
-#include <unistd.h>
+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxNet")
-#endif // __UNIX__
+// --------------------------------------------------------------------------
+// macros and constants
+// --------------------------------------------------------------------------
-#include <signal.h>
-#include <errno.h>
+// discard buffer
+#define MAX_DISCARD_SIZE (10 * 1024)
-#ifdef _MSC_VER
-#include <io.h>
-#endif
+#define wxTRACE_Socket _T("wxSocket")
-#if defined(__WXMOTIF__) || defined(__WXXT__)
-#include <X11/Intrinsic.h>
+// --------------------------------------------------------------------------
+// wxWin macros
+// --------------------------------------------------------------------------
-/////////////////////////////
-// Needs internal variables
-/////////////////////////////
-#ifdef __WXXT__
-#define Uses_XtIntrinsic
-#endif
+IMPLEMENT_CLASS(wxSocketBase, wxObject)
+IMPLEMENT_CLASS(wxSocketServer, wxSocketBase)
+IMPLEMENT_CLASS(wxSocketClient, wxSocketBase)
+IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase)
+IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
-#endif
+// --------------------------------------------------------------------------
+// private classes
+// --------------------------------------------------------------------------
-#if defined(__WXGTK__)
-#include <gtk/gtk.h>
-#endif
+class wxSocketState : public wxObject
+{
+public:
+ wxSocketFlags m_flags;
+ wxSocketEventFlags m_eventmask;
+ bool m_notify;
+ void *m_clientData;
-/////////////////////////////////////////////////////////////////////////////
-// wxSocket headers
-/////////////////////////////////////////////////////////////////////////////
-#define WXSOCK_INTERNAL
-#include "wx/sckaddr.h"
-#include "wx/socket.h"
+public:
+ wxSocketState() : wxObject() {}
-/////////////////////////////////////////////////////////////////////////////
-// Some patch ///// BEGIN
-/////////////////////////////////////////////////////////////////////////////
-#ifdef __WINDOWS__
-#define close closesocket
-#define ioctl ioctlsocket
-#define errno WSAGetLastError()
-#ifdef EWOULDBLOCK
-#undef EWOULDBLOCK
-#endif
-#define EWOULDBLOCK WSAEWOULDBLOCK
-#define ETIMEDOUT WSAETIMEDOUT
-#undef EINTR
-#define EINTR WSAEINTR
-#endif
+ DECLARE_NO_COPY_CLASS(wxSocketState)
+};
-#ifndef __WINDOWS__
-#define INVALID_SOCKET -1
-#endif
+// Conditionally make the socket non-blocking for the lifetime of this object.
+class wxSocketUnblocker
+{
+public:
+ wxSocketUnblocker(wxSocketImpl *socket, bool unblock = true)
+ : m_impl(socket),
+ m_unblock(unblock)
+ {
+ if ( m_unblock )
+ m_impl->SetNonBlocking(true);
+ }
-#ifdef __WXMOTIF__
-#define wxAPP_CONTEXT wxTheApp->appContext
-#endif
+ ~wxSocketUnblocker()
+ {
+ if ( m_unblock )
+ m_impl->SetNonBlocking(false);
+ }
-#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).
+private:
+ wxSocketImpl * const m_impl;
+ bool m_unblock;
-#if defined( NEED_WSAFDIsSet ) || defined( _MSC_VER )
-int PASCAL FAR __WSAFDIsSet(SOCKET fd, fd_set FAR *set)
-{
- int i = set->fd_count;
+ DECLARE_NO_COPY_CLASS(wxSocketUnblocker)
+};
- while (i--)
- {
- if (set->fd_array[i] == fd)
- return 1;
- }
+// ============================================================================
+// wxSocketManager
+// ============================================================================
- return 0;
+wxSocketManager *wxSocketManager::ms_manager = NULL;
+
+/* static */
+void wxSocketManager::Set(wxSocketManager *manager)
+{
+ wxASSERT_MSG( !ms_manager, "too late to set manager now" );
+
+ ms_manager = manager;
}
-#endif
-#endif
-#if defined(__WINDOWS__)
-#define PROCESS_EVENTS() wxYield()
-#elif defined(__WXXT__) || defined(__WXMOTIF__)
-#define PROCESS_EVENTS() XtAppProcessEvent(wxAPP_CONTEXT, XtIMAll)
-#elif defined(__WXGTK__)
-#define PROCESS_EVENTS() gtk_main_iteration()
-#endif
+/* static */
+void wxSocketManager::Init()
+{
+ wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" );
-/////////////////////////////////////////////////////////////////////////////
-// Some patch ///// END
-/////////////////////////////////////////////////////////////////////////////
+ /*
+ 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.
-// --------------------------------------------------------------
-// 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)
-#endif
+ 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" );
-class wxSockWakeUp : public wxTimer {
-public:
- int *my_id;
- int n_val;
- wxSocketBase *sock;
+ wxAppConsole * const app = wxAppConsole::GetInstance();
+ wxCHECK_RET( app, "sockets can't be initialized without wxApp" );
- wxSockWakeUp(wxSocketBase *_sock, int *id, int new_val) {
- my_id = id; n_val = new_val;
- sock = _sock;
- }
- virtual void Notify() {
- *my_id = n_val;
- if (sock) sock->Notify(FALSE);
- }
-};
+ ms_manager = app->GetTraits()->GetSocketManager();
+}
-/// Socket request
-class SockRequest : public wxObject {
-public:
- char *buffer;
- size_t size, nbytes;
- bool done;
- int error;
- wxSockWakeUp *auto_wakeup;
- wxSocketBase::wxRequestNotify type;
-};
-
+// ==========================================================================
+// wxSocketImpl
+// ==========================================================================
-/////////////////////////////////////////////////////////////////////////////
-// Some internal define
-/////////////////////////////////////////////////////////////////////////////
+wxSocketImpl::wxSocketImpl(wxSocketBase& wxsocket)
+ : 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;
-// --------------------------------------------------------------
-// --------- 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_waitflags(0), m_cbk(0), m_cdata(0), m_id(-1),
- m_handler(0),
- m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)),
- m_cbkon(FALSE),
- m_unread(NULL), m_unrd_size(0),
- m_processing(FALSE),
- m_timeout(3600), m_wantbuf(0)
-{
- m_internal = new wxSockInternal;
-#if defined(__WXXT__) || defined(__WXMOTIF__) || defined(__WXGTK__)
- m_internal->sock_inputid = 0;
- m_internal->sock_outputid = 0;
- m_internal->sock_exceptid = 0;
-#endif
-#ifdef __WINDOWS__
- m_internal->my_msg = 0;
-#endif
-}
+ SetTimeout(wxsocket.GetTimeout() * 1000);
-wxSocketBase::wxSocketBase() :
- wxEvtHandler(),
- m_flags(WAITALL), m_type(SOCK_UNINIT), m_connected(FALSE),
- m_connecting(FALSE), m_fd(INVALID_SOCKET), m_waitflags(0),
- m_cbk(0), m_cdata(0),
- m_id(-1), m_handler(0),
- m_neededreq((wxRequestNotify)(REQ_READ | REQ_LOST)),
- m_cbkon(FALSE),
- m_unread(NULL), m_unrd_size(0),
- m_processing(FALSE),
- m_timeout(3600), m_wantbuf(0)
-{
- m_internal = new wxSockInternal;
-#if defined(__WXXT__) || defined(__WXMOTIF__) || defined(__WXGTK__)
- m_internal->sock_inputid = 0;
- m_internal->sock_outputid = 0;
- m_internal->sock_exceptid = 0;
-#endif
-#ifdef __WINDOWS__
- m_internal->my_msg = 0;
-#endif
+ m_establishing = false;
+ m_reusable = false;
+ m_broadcast = false;
+ m_dobind = true;
+ m_initialRecvBufferSize = -1;
+ m_initialSendBufferSize = -1;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase CONSTRUCTOR ---------------------------
-// --------------------------------------------------------------
-wxSocketBase::~wxSocketBase()
+wxSocketImpl::~wxSocketImpl()
{
- DestroyCallbacks();
- Close();
+ if (m_fd != INVALID_SOCKET)
+ Shutdown();
- if (m_unread)
- free(m_unread);
- if (m_handler) {
-#ifdef __WINDOWS__
- if (m_internal->my_msg)
- m_handler->DestroyMessage(m_internal->my_msg);
-#endif
- m_handler->UnRegister(this);
- }
- m_states.DeleteContents(TRUE);
+ if (m_local)
+ GAddress_destroy(m_local);
- delete m_internal;
+ if (m_peer)
+ GAddress_destroy(m_peer);
}
-bool wxSocketBase::Close()
+bool wxSocketImpl::PreCreateCheck(GAddress *addr)
{
- if (m_fd != INVALID_SOCKET) {
- for (int i=0;i<3;i++) {
- wxNode *n, *node = req_list[i].First();
-
- while (node) {
- SockRequest *req = (SockRequest *)node->Data();
- req->done = TRUE;
-
- n = node->Next();
- delete node;
- node = n;
- }
+ if ( m_fd != INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return false;
}
- DestroyCallbacks();
- shutdown(m_fd, 2);
- close(m_fd);
- m_fd = INVALID_SOCKET;
- m_connected = FALSE;
- }
+ if ( !addr || !addr->m_addr )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return false;
+ }
- return TRUE;
+ return true;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase base IO functions ---------------------
-// --------------------------------------------------------------
-wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes)
+void wxSocketImpl::PostCreation()
{
- m_lcount = GetPushback(buffer, nbytes, FALSE);
+ // 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);
+
+ // FIXME: shouldn't we check for m_non_blocking here? as it is now, all our
+ // sockets are non-blocking
+ UnblockAndRegisterWithEventLoop();
}
-wxSocketBase& wxSocketBase::Peek(char* buffer, size_t nbytes)
+wxSocketError wxSocketImpl::UpdateLocalAddress()
{
- size_t nbytes_old = nbytes;
-
- nbytes -= GetPushback(buffer, nbytes, TRUE);
- if (!nbytes) {
- m_lcount = nbytes_old;
- return *this;
- }
+ WX_SOCKLEN_T lenAddr;
+ if ( getsockname(m_fd, m_local->m_addr, &lenAddr) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
- WantBuffer(buffer, nbytes, EVT_PEEK);
+ m_local->m_len = lenAddr;
- return *this;
+ return wxSOCKET_NOERROR;
}
-wxSocketBase& wxSocketBase::Write(const char *buffer, size_t nbytes)
+wxSocketError wxSocketImpl::CreateServer()
{
- WantBuffer((char *)buffer, nbytes, EVT_WRITE);
- return *this;
-}
+ if ( !PreCreateCheck(m_local) )
+ return m_error;
-wxSocketBase& wxSocketBase::ReadMsg(char* buffer, size_t nbytes)
-{
- SockMsg msg;
- size_t len, len2, sig;
-
- Read((char *)&msg, sizeof(msg));
- if (m_lcount != 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;
+ // do create the socket
+ m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0);
- 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 = len;
- if (len > nbytes)
- len = nbytes;
- else
- len2 = 0;
-
- if (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;
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
- 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
- if (sig != 0xdeadfeed)
- return *this;
+ PostCreation();
+
+ // 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 )
+ m_error = wxSOCKET_IOERR;
+
+ if ( IsOk() )
+ {
+ if ( listen(m_fd, 5) != 0 )
+ m_error = wxSOCKET_IOERR;
+ }
- return *this;
+ if ( !IsOk() )
+ {
+ Close();
+ return m_error;
+ }
+
+ // finally retrieve the address we effectively bound to
+ return UpdateLocalAddress();
}
-wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, size_t nbytes)
+wxSocketError wxSocketImpl::CreateClient()
{
- SockMsg msg;
-
- msg.sig[0] = 0xad;
- msg.sig[1] = 0xde;
- msg.sig[2] = 0xed;
- msg.sig[3] = 0xfe;
+ if ( !PreCreateCheck(m_peer) )
+ return m_error;
- msg.len[0] = nbytes & 0xff;
- msg.len[1] = (nbytes >> 8) & 0xff;
- msg.len[2] = (nbytes >> 16) & 0xff;
- msg.len[3] = (nbytes >> 24) & 0xff;
+ m_fd = socket(m_peer->m_realfamily, SOCK_STREAM, 0);
- if (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg))
- return *this;
- if (Write(buffer, nbytes).LastCount() < nbytes)
- return *this;
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
- msg.sig[0] = 0xed;
- msg.sig[1] = 0xfe;
- msg.sig[2] = 0xad;
- msg.sig[3] = 0xde;
- msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = 0;
- Write((char *)&msg, sizeof(msg));
+ PostCreation();
+
+ // If a local address has been set, then bind to it before calling connect
+ if ( m_local && m_local->m_addr )
+ {
+ if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+ }
- return *this;
+ // 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));
}
-wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes)
-{
- CreatePushbackAfter(buffer, nbytes);
- return *this;
-}
-bool wxSocketBase::IsData() const
+wxSocketError wxSocketImpl::CreateUDP()
{
- struct timeval tv;
- fd_set sock_set;
+ if ( !PreCreateCheck(m_local) )
+ return m_error;
- if (m_fd < 0)
- return FALSE;
- if (m_unrd_size > 0)
- return TRUE;
+ m_stream = false;
+ m_server = false;
- tv.tv_sec = 0;
- tv.tv_usec = 0;
- FD_ZERO(&sock_set);
- FD_SET(m_fd, &sock_set);
- select(FD_SETSIZE, &sock_set, NULL, NULL, &tv);
- return FD_ISSET(m_fd, &sock_set);
-}
-
-// ---------------------------------------------------------------------
-// --------- wxSocketBase Discard(): deletes all byte in the input queue
-// ---------------------------------------------------------------------
-void wxSocketBase::Discard()
-{
-#define MAX_BUFSIZE (10*1024)
- char *my_data = new char[MAX_BUFSIZE];
- size_t recv_size = MAX_BUFSIZE;
-
- SaveState();
- SetFlags((wxSockFlags)(NOWAIT | SPEED));
-
- while (recv_size == MAX_BUFSIZE) {
- recv_size = Read(my_data, MAX_BUFSIZE).LastCount();
- }
+ m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0);
- RestoreState();
- delete [] my_data;
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
-#undef MAX_BUFSIZE
-}
+ PostCreation();
-// --------------------------------------------------------------
-// --------- wxSocketBase socket info functions -----------------
-// --------------------------------------------------------------
-bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
-{
- struct sockaddr my_addr;
- size_t len_addr = sizeof(my_addr);
+ if ( m_dobind )
+ {
+ if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+
+ return UpdateLocalAddress();
+ }
- if (m_fd < 0)
- return FALSE;
+ return wxSOCKET_NOERROR;
+}
-#ifdef __WINDOWS__
- if (getpeername(m_fd, (struct sockaddr *)&my_addr, (int *)&len_addr) < 0)
-#else
- if (getpeername(m_fd, (struct sockaddr *)&my_addr, (unsigned int *)&len_addr) < 0)
-#endif
- return FALSE;
- addr_man.Disassemble(&my_addr, len_addr);
- return TRUE;
+void wxSocketImpl::Close()
+{
+ if ( m_fd != INVALID_SOCKET )
+ {
+ DoClose();
+ m_fd = INVALID_SOCKET;
+ }
}
-bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
+/*
+ * Disallow further read/write operations on this socket, close
+ * the fd and disable all callbacks.
+ */
+void wxSocketImpl::Shutdown()
{
- struct sockaddr my_addr;
- size_t len_addr = sizeof(my_addr);
+ if ( m_fd != INVALID_SOCKET )
+ {
+ shutdown(m_fd, 1 /* SD_SEND */);
+ Close();
+ }
- if (m_fd < 0)
- return FALSE;
+ m_detected = wxSOCKET_LOST_FLAG;
+}
-#ifdef __WINDOWS__
- if (getsockname(m_fd, (struct sockaddr *)&my_addr, (int *)&len_addr) < 0)
-#else
- if (getsockname(m_fd, (struct sockaddr *)&my_addr, (unsigned int *)&len_addr) < 0)
-#endif
- return FALSE;
+/*
+ * Sets the timeout for blocking calls. Time is expressed in
+ * milliseconds.
+ */
+void wxSocketImpl::SetTimeout(unsigned long millis)
+{
+ m_timeout.tv_sec = (millis / 1000);
+ m_timeout.tv_usec = (millis % 1000) * 1000;
+}
- addr_man.Disassemble(&my_addr, len_addr);
- return TRUE;
+void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event)
+{
+ m_wxsocket->OnRequest(event);
}
-// --------------------------------------------------------------
-// --------- wxSocketBase wait functions ------------------------
-// --------------------------------------------------------------
-void wxSocketBase::SaveState()
+/* Address handling */
+
+/*
+ * Set or get the local or peer address for this socket. The 'set'
+ * functions return wxSOCKET_NOERROR on success, an error code otherwise.
+ * The 'get' functions return a pointer to a GAddress object on success,
+ * or NULL otherwise, in which case they set the error code of the
+ * corresponding socket.
+ *
+ * Error codes:
+ * wxSOCKET_INVSOCK - the socket is not valid.
+ * wxSOCKET_INVADDR - the address is not valid.
+ */
+wxSocketError wxSocketImpl::SetLocal(GAddress *address)
{
- wxSockState *state = new wxSockState;
+ /* the socket must be initialized, or it must be a server */
+ if (m_fd != INVALID_SOCKET && !m_server)
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return wxSOCKET_INVSOCK;
+ }
+
+ /* check address */
+ if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
- state->cbk_on = m_cbkon;
- state->cbk_set= m_neededreq;
- state->cbk = m_cbk;
- state->cdata = m_cdata;
- state->flags = m_flags;
- state->notif = m_notifyme;
+ if (m_local)
+ GAddress_destroy(m_local);
- m_states.Append(state);
+ m_local = GAddress_copy(address);
+
+ return wxSOCKET_NOERROR;
}
-void wxSocketBase::RestoreState()
+wxSocketError wxSocketImpl::SetPeer(GAddress *address)
{
- wxNode *node;
+ /* check address */
+ if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
- node = m_states.Last();
- if (!node)
- return;
+ if (m_peer)
+ GAddress_destroy(m_peer);
- wxSockState *state = (wxSockState *)node->Data();
-
- SetFlags(state->flags);
- m_neededreq = state->cbk_set;
- m_cbk = state->cbk;
- m_cdata = state->cdata;
- m_notifyme = state->notif;
- if (state->cbk_on)
- SetupCallbacks();
- else
- DestroyCallbacks();
+ m_peer = GAddress_copy(address);
- delete node;
- delete state;
+ return wxSOCKET_NOERROR;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase wait functions ------------------------
-// --------------------------------------------------------------
-//
-bool wxSocketBase::_Wait(long seconds, long microseconds, int type)
+GAddress *wxSocketImpl::GetLocal()
{
- if ((!m_connected && !m_connecting) || m_fd < 0)
- return FALSE;
+ GAddress *address;
+ wxSockAddr addr;
+ WX_SOCKLEN_T size = sizeof(addr);
+ wxSocketError err;
- wxSockWakeUp wakeup(this, &m_waitflags, 0);
+ /* try to get it from the m_local var first */
+ if (m_local)
+ return GAddress_copy(m_local);
- SaveState();
- SetNotify((wxRequestNotify)type);
- SetupCallbacks();
+ /* else, if the socket is initialized, try getsockname */
+ if (m_fd == INVALID_SOCKET)
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return NULL;
+ }
- if (seconds != -1)
- wakeup.Start((int)(seconds*1000 + (microseconds / 1000)), TRUE);
-
- m_waitflags = 0x80 | type;
- while (m_waitflags & 0x80)
- PROCESS_EVENTS();
+ if (getsockname(m_fd, (sockaddr*)&addr, &size) == SOCKET_ERROR)
+ {
+ m_error = wxSOCKET_IOERR;
+ return NULL;
+ }
- RestoreState();
+ /* got a valid address from getsockname, create a GAddress object */
+ if ((address = GAddress_new()) == NULL)
+ {
+ m_error = wxSOCKET_MEMERR;
+ return NULL;
+ }
- if (m_waitflags & 0x40) {
- m_waitflags = 0;
- return TRUE;
+ if ((err = _GAddress_translate_from(address, (sockaddr*)&addr, size)) != wxSOCKET_NOERROR)
+ {
+ GAddress_destroy(address);
+ m_error = err;
+ return NULL;
}
- m_waitflags = 0;
- return FALSE;
+ return address;
}
-bool wxSocketBase::Wait(long seconds, long microseconds)
+GAddress *wxSocketImpl::GetPeer()
{
- return _Wait(seconds, microseconds, REQ_ACCEPT | REQ_CONNECT |
- REQ_READ | REQ_WRITE | REQ_LOST);
-}
+ /* try to get it from the m_peer var */
+ if (m_peer)
+ return GAddress_copy(m_peer);
-bool wxSocketBase::WaitForRead(long seconds, long microseconds)
-{
- return _Wait(seconds, microseconds, REQ_READ | REQ_LOST);
+ return NULL;
}
-bool wxSocketBase::WaitForWrite(long seconds, long microseconds)
-{
- return _Wait(seconds, microseconds, REQ_WRITE);
-}
+// ==========================================================================
+// wxSocketBase
+// ==========================================================================
+
+// --------------------------------------------------------------------------
+// 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;
-bool wxSocketBase::WaitForLost(long seconds, long microseconds)
+bool wxSocketBase::IsInitialized()
{
- return _Wait(seconds, microseconds, REQ_LOST);
+ return m_countInit > 0;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase callback management -------------------
-// --------------------------------------------------------------
-
-#if defined(__WXMOTIF__) || defined(__WXXT__) || defined(__WXGTK__)
-#if defined(__WXMOTIF__) || defined(__WXXT__)
-static void wx_socket_read(XtPointer client, int *fid,
- XtInputId *WXUNUSED(id))
-#define fd *fid
-#else
-static void wx_socket_read(gpointer client, gint fd,
- GdkInputCondition WXUNUSED(cond))
-#define fd fd
-#endif
+bool wxSocketBase::Initialize()
{
- wxSocketBase *sock = (wxSocketBase *)client;
- char c;
- int i;
+ if ( !m_countInit++ )
+ {
+ wxSocketManager * const manager = wxSocketManager::Get();
+ if ( !manager || !manager->OnInit() )
+ {
+ m_countInit--;
- i = recv(fd, &c, 1, MSG_PEEK);
+ return false;
+ }
+ }
- if (i == -1 && (sock->NeededReq() & wxSocketBase::REQ_ACCEPT)) {
- sock->OnRequest(wxSocketBase::EVT_ACCEPT);
- return;
- }
+ return true;
+}
- if (i != 0) {
- if (!(sock->NeededReq() & wxSocketBase::REQ_READ))
- return;
+void wxSocketBase::Shutdown()
+{
+ // we should be initialized
+ wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") );
+ if ( --m_countInit == 0 )
+ {
+ wxSocketManager * const manager = wxSocketManager::Get();
+ wxCHECK_RET( manager, "should have a socket manager" );
- sock->OnRequest(wxSocketBase::EVT_READ);
- } else {
- if (!(sock->NeededReq() & wxSocketBase::REQ_LOST)) {
- sock->Close();
- return;
+ manager->OnExit();
}
+}
- sock->OnRequest(wxSocketBase::EVT_LOST);
- }
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
+
+void wxSocketBase::Init()
+{
+ m_impl = NULL;
+ m_type = wxSOCKET_UNINIT;
+
+ // state
+ m_flags = 0;
+ m_connected =
+ m_establishing =
+ m_reading =
+ m_writing =
+ m_error =
+ m_closed = false;
+ m_lcount = 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 = 0;
+
+ if ( !IsInitialized() )
+ {
+ // this Initialize() will be undone by wxSocketModule::OnExit(), all
+ // the other calls to it should be matched by a call to Shutdown()
+ Initialize();
+ }
}
-#undef fd
-#if defined(__WXMOTIF__) || defined(__WXXT__)
-static void wx_socket_write(XtPointer client, int *WXUNUSED(fid),
- XtInputId *WXUNUSED(id))
-#else
-static void wx_socket_write(gpointer client, gint WXUNUSED(fd),
- GdkInputCondition WXUNUSED(cond))
-#endif
+wxSocketBase::wxSocketBase()
{
- wxSocketBase *sock = (wxSocketBase *)client;
-
- if (!sock->IsConnected())
- sock->OnRequest(wxSocketBase::EVT_CONNECT);
- else
- sock->OnRequest(wxSocketBase::EVT_WRITE);
+ Init();
}
-#endif
-#ifdef wx_xview
-Notify_value wx_sock_read_xview (Notify_client client, int fd)
+wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
{
- wxSocketBase *sock = (wxSocketBase *)client;
- char c;
- int i;
+ Init();
- i = recv(fd, &c, 1, MSG_PEEK);
+ SetFlags(flags);
- if (i == -1 && (sock->NeededReq() & wxSocketBase::REQ_ACCEPT)) {
- sock->OnRequest(wxSocketBase::EVT_ACCEPT);
- return;
- }
+ m_type = type;
+}
- /* Bytes arrived */
- if (i != 0) {
- if (!(sock->NeededReq() & wxSocketBase::REQ_READ))
- return (Notify_value) FALSE;
+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);
- sock->OnRequest(wxSocketBase::EVT_READ);
- } else {
- if (!(sock->NeededReq() & wxSocketBase::REQ_LOST))
- return;
+ // Shutdown and close the socket
+ if (!m_beingDeleted)
+ Close();
- sock->OnRequest(wxSocketBase::EVT_LOST);
- }
+ // Destroy the implementation object
+ delete m_impl;
- return (Notify_value) FALSE;
+ // Free the pushback buffer
+ if (m_unread)
+ free(m_unread);
}
-Notify_value wx_sock_write_xview (Notify_client client, int fd)
+bool wxSocketBase::Destroy()
{
- wxSocketBase *sock = (wxSocketBase *)client;
+ // 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;
- if (!sock->IsConnected())
- sock->OnRequest(wxSocketBase::EVT_CONNECT);
- else
- sock->OnRequest(wxSocketBase::EVT_WRITE);
+ // Shutdown and close the socket
+ Close();
+
+ // Supress events from now on
+ Notify(false);
- return (Notify_value) TRUE;
+ // schedule this object for deletion
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits )
+ {
+ // let the traits object decide what to do with us
+ traits->ScheduleForDestroy(this);
+ }
+ else // no app or no traits
+ {
+ // in wxBase we might have no app object at all, don't leak memory
+ delete this;
+ }
+
+ return true;
}
-#endif
-wxSocketBase::wxRequestNotify wxSocketBase::EventToNotify(wxRequestEvent evt)
-{
- 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;
+// ----------------------------------------------------------------------------
+// simply accessors
+// ----------------------------------------------------------------------------
+
+wxSocketError wxSocketBase::LastError() const
+{
+ return m_impl->GetError();
}
-void wxSocketBase::SetFlags(wxSockFlags _flags)
+// --------------------------------------------------------------------------
+// Basic IO calls
+// --------------------------------------------------------------------------
+
+// The following IO operations update m_error and m_lcount:
+// {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard}
+//
+// TODO: Should Connect, Accept and AcceptWith update m_error?
+
+bool wxSocketBase::Close()
{
- m_flags = _flags;
- if (_flags & SPEED) {
- unsigned long flag = 0;
- ioctl(m_fd, FIONBIO, &flag);
+ // Interrupt pending waits
+ InterruptWait();
- // SPEED and WAITALL are antagonists.
- m_flags = (wxSockFlags)(m_flags & ~WAITALL);
+ if (m_impl)
+ m_impl->Shutdown();
- Notify(FALSE);
- } else {
- unsigned long flag = 1;
- ioctl(m_fd, FIONBIO, &flag);
- }
+ m_connected = false;
+ m_establishing = false;
+ return true;
}
-void wxSocketBase::SetNotify(wxRequestNotify flags)
+wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
{
- wxRequestNotify old_needed_req = m_neededreq;
- if (flags & REQ_ACCEPT) {
- /* Check if server */
- if (!(GetClassInfo()->IsKindOf(CLASSINFO(wxSocketServer))))
- flags &= ~REQ_ACCEPT;
- }
- m_neededreq = flags;
- if (m_cbkon && old_needed_req != flags)
- SetupCallbacks();
-}
-
-void wxSocketBase::SetupCallbacks()
-{
- if (m_fd == INVALID_SOCKET || !m_handler || (m_flags & SPEED))
- return;
-
-#if defined(__WXMOTIF__) || defined(__WXXT__) || defined(__WXGTK__)
- if (m_cbkon)
- DestroyCallbacks();
- if (m_neededreq & (REQ_ACCEPT | REQ_READ | REQ_LOST)) {
-#ifdef __WXGTK__
- m_internal->sock_inputid = gdk_input_add(m_fd, GDK_INPUT_READ,
- wx_socket_read, (gpointer)this);
-#else
- m_internal->sock_inputid = XtAppAddInput (wxAPP_CONTEXT, m_fd,
- (XtPointer *) XtInputReadMask,
- (XtInputCallbackProc) wx_socket_read,
- (XtPointer) this);
-#endif
- }
- if (m_neededreq & (REQ_CONNECT | REQ_WRITE)) {
-#ifdef __WXGTK__
- m_internal->sock_inputid = gdk_input_add(m_fd, GDK_INPUT_WRITE,
- wx_socket_write, (gpointer)this);
-#else
- m_internal->sock_outputid = XtAppAddInput (wxAPP_CONTEXT, m_fd,
- (XtPointer *) XtInputWriteMask,
- (XtInputCallbackProc) wx_socket_write,
- (XtPointer) this);
-#endif
- }
-#endif
-#ifdef __WINDOWS__
- WORD mask = 0;
-
- if (m_neededreq & REQ_READ)
- mask |= FD_READ;
- if (m_neededreq & REQ_WRITE)
- mask |= FD_WRITE;
- if (m_neededreq & REQ_LOST)
- mask |= FD_CLOSE;
- if (m_neededreq & REQ_ACCEPT)
- mask |= FD_ACCEPT;
- if (m_neededreq & REQ_CONNECT)
- mask |= FD_CONNECT;
-
- if (!m_internal->my_msg)
- m_internal->my_msg = m_handler->NewMessage(this);
- WSAAsyncSelect(m_fd, m_handler->GetHWND(), m_internal->my_msg, mask);
-#endif
- m_cbkon = TRUE;
- m_processing = FALSE;
-}
-
-void wxSocketBase::DestroyCallbacks()
-{
- if (!m_cbkon || !m_handler)
- return;
- m_cbkon = FALSE;
- m_processing = FALSE;
-#if defined(__WXMOTIF__) || defined(__WXXT__)
- if (m_internal->sock_inputid > 0)
- XtRemoveInput(m_internal->sock_inputid);
- m_internal->sock_inputid = 0;
- if (m_internal->sock_outputid > 0)
- XtRemoveInput(m_internal->sock_outputid);
- m_internal->sock_outputid = 0;
-#endif
-#ifdef __WXGTK__
- if (m_internal->sock_inputid > 0)
- gdk_input_remove(m_internal->sock_inputid);
- m_internal->sock_inputid = 0;
- if (m_internal->sock_outputid > 0)
- gdk_input_remove(m_internal->sock_outputid);
- m_internal->sock_outputid = 0;
-#endif
-#ifdef __WINDOWS__
- WSAAsyncSelect(m_fd, m_handler->GetHWND(), 0, 0);
-#endif
+ // Mask read events
+ m_reading = true;
+
+ 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;
}
-void wxSocketBase::Notify(bool notify)
+wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
{
- if (m_notifyme == notify)
- return;
- if (notify)
- SetupCallbacks();
- else
- DestroyCallbacks();
- m_notifyme = notify;
+ // We use pointer arithmetic here which doesn't work with void pointers.
+ char *buffer = static_cast<char *>(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
+ // closed socket.
+ wxUint32 total = GetPushback(buffer, nbytes, false);
+ 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 )
+ {
+ wxSocketUnblocker unblock(m_impl);
+ int ret = m_impl->Read(buffer, nbytes);
+ if ( ret < 0 )
+ return 0;
+
+ total += ret;
+ }
+ else // blocking socket
+ {
+ for ( ;; )
+ {
+ // 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 )
+ {
+ // 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 ( ret < 0 )
+ {
+ // this will be always interpreted as error by Read()
+ return 0;
+ }
+
+ total += ret;
+
+ // If wxSOCKET_WAITALL is not set, we can leave now as we did read
+ // something and we don't need to wait for all nbytes bytes to be
+ // read.
+ if ( !(m_flags & wxSOCKET_WAITALL) )
+ break;
+
+ // Otherwise continue reading until we do read everything.
+ nbytes -= ret;
+ if ( !nbytes )
+ break;
+
+ buffer += ret;
+ }
+ }
+
+ return total;
}
-void wxSocketBase::OnRequest(wxRequestEvent req_evt)
+wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
{
- wxRequestNotify req_notif = EventToNotify(req_evt);
+ wxUint32 len, len2, sig, total;
+ bool error;
+ int old_flags;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
- // Mask the current event
- SetNotify(m_neededreq & ~req_notif);
+ // Mask read events
+ m_reading = true;
- if (req_evt <= EVT_WRITE && DoRequests(req_evt))
- return;
+ total = 0;
+ error = true;
+ old_flags = m_flags;
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
- if (m_waitflags & 0xF0) {
- // Wake up
- if ((m_waitflags & 0x0F) == req_evt) {
- m_waitflags = 0x80;
-#ifndef __WXGTK__
- DestroyCallbacks(); // I disable it to prevent infinite loop on X11.
-#endif
+ 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)
+ {
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
+ goto exit;
}
- return;
- }
- if (req_evt == EVT_LOST) {
- m_connected = FALSE;
- Close();
- }
- if (m_notifyme)
- OldOnNotify(req_evt);
+ len = (wxUint32)msg.len[0];
+ len |= (wxUint32)(msg.len[1] << 8);
+ len |= (wxUint32)(msg.len[2] << 16);
+ len |= (wxUint32)(msg.len[3] << 24);
- // Unmask
- SetNotify(m_neededreq | req_notif);
-}
+ if (len > nbytes)
+ {
+ len2 = len - nbytes;
+ len = nbytes;
+ }
+ else
+ len2 = 0;
-wxSocketEvent::wxSocketEvent(int id)
- : wxEvent(id)
-{
- wxEventType type = (wxEventType)wxEVT_SOCKET;
+ // Don't attempt to read if the msg was zero bytes long.
+ if (len)
+ {
+ total = DoRead(buffer, len);
- SetEventType(type);
+ if (total != len)
+ goto exit;
+ }
+
+ if (len2)
+ {
+ char *discard_buffer = new char[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);
+
+ 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);
+
+ return *this;
}
-void wxSocketBase::OldOnNotify(wxRequestEvent evt)
+wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
- wxSocketEvent event(m_id);
+ // Mask read events
+ m_reading = true;
- event.SetEventObject(this);
- event.m_skevt = evt;
- ProcessEvent(event);
+ m_lcount = DoRead(buffer, nbytes);
+ Pushback(buffer, m_lcount);
- if (m_cbk)
- m_cbk(*this, evt, m_cdata);
+ // 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 again
+ m_reading = false;
+
+ return *this;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase functions [Callback, CallbackData] ----
-// --------------------------------------------------------------
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSocketBase::wxSockCbk _cbk)
+wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
{
- wxSockCbk old_cbk = m_cbk;
+ // Mask write events
+ m_writing = true;
- m_cbk = _cbk;
- return old_cbk;
+ 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;
}
-char *wxSocketBase::CallbackData(char *cdata_)
+// This function is a mirror image of DoRead() except that it doesn't use the
+// push back buffer, please see comments there
+wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes)
{
- char *old_cdata = m_cdata;
+ const char *buffer = static_cast<const char *>(buffer_);
- m_cdata = cdata_;
- return old_cdata;
+ // Return if there is nothing to read or the socket is (already?) closed.
+ if ( !m_impl || !nbytes )
+ return 0;
+
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
+
+ wxUint32 total = 0;
+ if ( m_flags & wxSOCKET_NOWAIT )
+ {
+ wxSocketUnblocker unblock(m_impl);
+ const int ret = m_impl->Write(buffer, nbytes);
+ if ( ret > 0 )
+ total += ret;
+ }
+ else // blocking socket
+ {
+ for ( ;; )
+ {
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
+ break;
+
+ const int ret = m_impl->Write(buffer, nbytes);
+ if ( ret == 0 )
+ {
+ m_closed = true;
+ break;
+ }
+
+ if ( ret < 0 )
+ return 0;
+
+ total += ret;
+ if ( !(m_flags & wxSOCKET_WAITALL) )
+ break;
+
+ nbytes -= ret;
+ if ( !nbytes )
+ break;
+
+ buffer += ret;
+ }
+ }
+
+ return total;
}
-void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id)
+wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
{
- SetNextHandler(&h_evt);
- m_id = id;
+ wxUint32 total;
+ bool error;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
+
+ // Mask write events
+ m_writing = true;
+
+ error = true;
+ total = 0;
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+
+ msg.sig[0] = (unsigned char) 0xad;
+ msg.sig[1] = (unsigned char) 0xde;
+ msg.sig[2] = (unsigned char) 0xed;
+ msg.sig[3] = (unsigned char) 0xfe;
+
+ 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);
+
+ if (DoWrite(&msg, sizeof(msg)) < sizeof(msg))
+ goto exit;
+
+ total = DoWrite(buffer, nbytes);
+
+ if (total < nbytes)
+ goto exit;
+
+ msg.sig[0] = (unsigned char) 0xed;
+ msg.sig[1] = (unsigned char) 0xfe;
+ msg.sig[2] = (unsigned char) 0xad;
+ msg.sig[3] = (unsigned char) 0xde;
+ msg.len[0] =
+ msg.len[1] =
+ msg.len[2] =
+ msg.len[3] = (char) 0;
+
+ if ((DoWrite(&msg, sizeof(msg))) < sizeof(msg))
+ goto exit;
+
+ // everything was OK
+ error = false;
+
+exit:
+ m_error = error;
+ m_lcount = total;
+ m_writing = false;
+
+ return *this;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase pushback library ----------------------
-// --------------------------------------------------------------
-void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size)
+wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
{
- char *curr_pos;
+ if (nbytes != 0)
+ Pushback(buffer, nbytes);
- m_unread = (char *) realloc(m_unread, m_unrd_size+size);
- curr_pos = m_unread + m_unrd_size;
+ m_error = false;
+ m_lcount = nbytes;
- memcpy(curr_pos, buffer, size);
- m_unrd_size += size;
+ return *this;
}
-void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size)
+wxSocketBase& wxSocketBase::Discard()
{
- char *curr_pos, *new_buf;
+ char *buffer = new char[MAX_DISCARD_SIZE];
+ wxUint32 ret;
+ wxUint32 total = 0;
+
+ // Mask read events
+ m_reading = true;
+
+ SetFlags(wxSOCKET_NOWAIT);
+
+ do
+ {
+ ret = DoRead(buffer, MAX_DISCARD_SIZE);
+ total += ret;
+ }
+ while (ret == MAX_DISCARD_SIZE);
- new_buf = (char *) malloc(m_unrd_size+size);
- curr_pos = new_buf + size;
+ delete[] buffer;
+ m_lcount = total;
+ m_error = false;
- memcpy(new_buf, buffer, size);
- memcpy(curr_pos, m_unread, m_unrd_size);
+ // Allow read events again
+ m_reading = false;
- free(m_unread);
- m_unread = new_buf;
- m_unrd_size += size;
+ return *this;
}
-size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek)
+// --------------------------------------------------------------------------
+// Wait functions
+// --------------------------------------------------------------------------
+
+/*
+ * 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.
+ */
+wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags)
{
- if (!m_unrd_size)
- return 0;
+ assert(this);
+
+ wxSocketEventFlags result = 0;
+ fd_set readfds;
+ fd_set writefds;
+ fd_set exceptfds;
+ struct timeval tv;
+
+ if (m_fd == -1)
+ 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);
+ }
- if (size > m_unrd_size)
- size = m_unrd_size;
- memcpy(buffer, m_unread, size);
+ /* Check for exceptions and errors */
+ if (wxFD_ISSET(m_fd, &exceptfds))
+ {
+ m_establishing = false;
+ m_detected = wxSOCKET_LOST_FLAG;
- if (!peek) {
- m_unrd_size -= size;
- if (!m_unrd_size) {
- free(m_unread);
- m_unread = NULL;
+ /* LOST event: Abort any further processing */
+ return (wxSOCKET_LOST_FLAG & flags);
+ }
+
+ /* Check for readability */
+ if (wxFD_ISSET(m_fd, &readfds))
+ {
+ result |= wxSOCKET_INPUT_FLAG;
+
+ if (m_server && m_stream)
+ {
+ /* 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;
}
}
- return size;
+ /* Check for writability */
+ if (wxFD_ISSET(m_fd, &writefds))
+ {
+ 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)
+ {
+ m_detected = wxSOCKET_LOST_FLAG;
+
+ /* LOST event: Abort any further processing */
+ return (wxSOCKET_LOST_FLAG & flags);
+ }
+ else
+ {
+ m_detected |= wxSOCKET_CONNECTION_FLAG;
+ }
+ }
+ else
+ {
+ result |= wxSOCKET_OUTPUT_FLAG;
+ }
+ }
+
+ return (result | m_detected) & flags;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase "multi-thread" core -------------------
-// --------------------------------------------------------------
+// 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.
-bool wxSocketBase::DoRequests(wxRequestEvent req_flag)
+bool
+wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags)
{
- wxNode *node = req_list[req_flag].First();
- size_t len;
- int ret;
+ wxCHECK_MSG( m_impl, false, "can't wait on invalid socket" );
- if (!node)
- return FALSE;
+ // This can be set to true from Interrupt() to exit this function a.s.a.p.
+ m_interrupt = false;
- SockRequest *req = (SockRequest *)node->Data();
- delete node;
+ // 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;
+ const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout;
- switch (req->type) {
- case EVT_READ:
- case EVT_PEEK:
- ret = recv(m_fd, req->buffer, req->size,
- (req->type == EVT_PEEK) ? MSG_PEEK : 0);
- if (ret < 0) {
- req->error = errno;
- req->done = TRUE;
- break;
- }
- len = ret;
- if ((len < req->size) && (m_flags & WAITALL)) {
- req->size -= len;
- req->nbytes += len;
- req->buffer += len;
- req->auto_wakeup->Start(m_timeout*1000, TRUE);
- req_list[req_flag].Insert(req);
- break;
+ // Get the active event loop which we'll use for the message dispatching
+ // when running in the main thread
+ wxEventLoopBase *eventLoop;
+ if ( wxIsMainThread() )
+ {
+ eventLoop = wxEventLoop::GetActive();
}
- req->done = TRUE;
- req->nbytes += len;
-#ifndef __WXGTK__
- DestroyCallbacks();
-#endif
- break;
- case EVT_WRITE:
- ret = send(m_fd, req->buffer, req->size, 0);
- if (ret < 0) {
- req->error = errno;
- req->done = TRUE;
- break;
+ else // in worker thread
+ {
+ // We never dispatch messages from threads other than the main one.
+ eventLoop = NULL;
}
- len = ret;
- if ((len < req->size) && (m_flags & WAITALL)) {
- req->size -= len;
- req->nbytes += len;
- req->buffer += len;
- req->auto_wakeup->Start(m_timeout*1000, TRUE);
- req_list[req_flag].Insert(req);
- break;
+
+ // Wait in an active polling loop: notice that the loop is executed at
+ // least once, even if timeout is 0 (i.e. polling).
+ bool gotEvent = false;
+ for ( ;; )
+ {
+ // We always stop waiting when the connection is lost as it doesn't
+ // make sense to continue further, even if wxSOCKET_LOST_FLAG is not
+ // specified in flags to wait for.
+ const wxSocketEventFlags
+ result = m_impl->Select(flags | wxSOCKET_LOST_FLAG);
+
+ // Incoming connection (server) or connection established (client)?
+ if ( result & wxSOCKET_CONNECTION_FLAG )
+ {
+ m_connected = true;
+ m_establishing = false;
+ gotEvent = true;
+ break;
+ }
+
+ // Data available or output buffer ready?
+ if ( (result & wxSOCKET_INPUT_FLAG) || (result & wxSOCKET_OUTPUT_FLAG) )
+ {
+ gotEvent = true;
+ break;
+ }
+
+ // Connection lost
+ if ( result & wxSOCKET_LOST_FLAG )
+ {
+ m_connected = false;
+ m_establishing = false;
+ if ( flags & wxSOCKET_LOST_FLAG )
+ gotEvent = true;
+ break;
+ }
+
+ if ( m_interrupt )
+ break;
+
+ // Wait more?
+ const wxMilliClock_t timeNow = wxGetLocalTimeMillis();
+ if ( timeNow >= timeEnd )
+ break;
+
+ 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();
+ }
+#if wxUSE_THREADS
+ else // no event loop or waiting in another thread
+ {
+ // We're busy waiting but at least give up the rest of our current
+ // time slice.
+ wxThread::Yield();
+ }
+#endif // wxUSE_THREADS
}
- req->done = TRUE;
- req->nbytes += len;
-#ifndef __WXGTK__
- DestroyCallbacks();
-#endif
- break;
- default:
- return FALSE;
- }
- return TRUE;
+
+ return gotEvent;
}
-void wxSocketBase::WantSpeedBuffer(char *buffer, size_t nbytes,
- wxRequestEvent evt)
+bool wxSocketBase::Wait(long seconds, long milliseconds)
{
- int ret = 0;
-
- switch (evt) {
- case EVT_PEEK:
- case EVT_READ:
- ret = read(m_fd, buffer, nbytes);
- break;
- case EVT_WRITE:
- ret = write(m_fd, buffer, nbytes);
- break;
- }
- if (ret < 0) {
- m_lcount = 0;
- m_error = errno;
- } else
- m_lcount = ret;
+ return DoWait(seconds, milliseconds,
+ wxSOCKET_INPUT_FLAG |
+ wxSOCKET_OUTPUT_FLAG |
+ wxSOCKET_CONNECTION_FLAG |
+ wxSOCKET_LOST_FLAG
+ );
}
-void wxSocketBase::WantBuffer(char *buffer, size_t nbytes,
- wxRequestEvent evt)
+bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
{
- bool buf_timed_out;
+ // Check pushback buffer before entering DoWait
+ if ( m_unread )
+ return true;
- if (m_fd == INVALID_SOCKET || !m_handler || !m_connected)
- return;
+ // 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);
+}
- if (m_flags & SPEED) {
- WantSpeedBuffer(buffer, nbytes, evt);
- return;
- }
- SockRequest *buf = new SockRequest;
- wxSockWakeUp s_wake(NULL, (int *)&buf_timed_out, (int)TRUE);
-
- m_wantbuf++;
- req_list[evt].Append(buf);
-
- SaveState();
- SetNotify(REQ_LOST | EventToNotify(evt));
- SetupCallbacks();
- buf->buffer = buffer;
- buf->size = nbytes;
- buf->done = FALSE;
- buf->type = evt;
- buf->nbytes = 0;
- buf->auto_wakeup = &s_wake;
- buf->error = 0;
- buf_timed_out = FALSE;
-
- s_wake.Start(m_timeout*1000, TRUE);
- if (m_flags & NOWAIT) {
- DoRequests(evt);
- } else {
- while (!buf->done && !buf_timed_out)
- PROCESS_EVENTS();
- }
- m_wantbuf--;
- m_lcount = buf->nbytes;
- if (buf_timed_out)
- m_error = ETIMEDOUT;
- else
- m_error = buf->error;
+bool wxSocketBase::WaitForWrite(long seconds, long milliseconds)
+{
+ return DoWait(seconds, milliseconds, wxSOCKET_OUTPUT_FLAG | wxSOCKET_LOST_FLAG);
+}
- delete buf;
- RestoreState();
+bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
+{
+ return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG);
}
-// --------------------------------------------------------------
-// wxSocketServer ///////////////////////////////////////////////
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Miscellaneous
+// --------------------------------------------------------------------------
+
+//
+// Get local or peer address
+//
-// --------------------------------------------------------------
-// --------- wxSocketServer CONSTRUCTOR -------------------------
-// --------------------------------------------------------------
-wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
- wxSockFlags flags) :
- wxSocketBase(flags, SOCK_SERVER)
+bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
{
- m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0);
+ GAddress *peer;
- if (m_fd == INVALID_SOCKET)
- return;
-
- int flag = 1;
- setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (char*)&flag, sizeof(int));
-
- struct sockaddr *myaddr;
- size_t len;
-
- addr_man.Build(myaddr, len);
- if (bind(m_fd, myaddr, addr_man.SockAddrLen()) < 0)
- return;
-
- if (listen(m_fd, 5) < 0) {
- m_fd = INVALID_SOCKET;
- return;
- }
-}
+ if (!m_impl)
+ return false;
-// --------------------------------------------------------------
-// --------- wxSocketServer Accept ------------------------------
-// --------------------------------------------------------------
-bool wxSocketServer::AcceptWith(wxSocketBase& sock)
-{
- int fd2;
-
- if ((fd2 = accept(m_fd, 0, 0)) < 0)
- return FALSE;
-
- struct linger linger;
- linger.l_onoff = 0;
- linger.l_linger = 1;
-
- setsockopt(fd2, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger));
-
- int flag = 0;
- setsockopt(fd2, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int));
-
- if (!(sock.m_flags & SPEED)) {
- unsigned long flag2 = 1;
- ioctl(fd2, FIONBIO, &flag2);
- }
-
- sock.m_type = SOCK_INTERNAL;
- sock.m_fd = fd2;
- sock.m_connected = TRUE;
+ 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);
- return TRUE;
+ return true;
}
-wxSocketBase *wxSocketServer::Accept()
+bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
{
- wxSocketBase* sock = new wxSocketBase();
+ GAddress *local;
- sock->SetFlags((wxSockFlags)m_flags);
+ if (!m_impl)
+ return false;
- if (!AcceptWith(*sock))
- return NULL;
+ local = m_impl->GetLocal();
+ addr_man.SetAddress(local);
+ GAddress_destroy(local);
+
+ return true;
+}
+
+//
+// Save and restore socket state
+//
+
+void wxSocketBase::SaveState()
+{
+ wxSocketState *state;
- if (m_handler)
- m_handler->Register(sock);
+ state = new wxSocketState();
- return sock;
+ state->m_flags = m_flags;
+ state->m_notify = m_notify;
+ state->m_eventmask = m_eventmask;
+ state->m_clientData = m_clientData;
+
+ m_states.Append(state);
}
-// --------------------------------------------------------------
-// --------- wxSocketServer callbacks ---------------------------
-// --------------------------------------------------------------
-void wxSocketServer::OnRequest(wxRequestEvent evt)
+void wxSocketBase::RestoreState()
{
- if (evt == EVT_ACCEPT) {
- OldOnNotify(EVT_ACCEPT);
- }
+ 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 ///////////////////////////////////////////////
-// --------------------------------------------------------------
+//
+// Timeout and flags
+//
-// --------- wxSocketClient CONSTRUCTOR -------------------------
-// --------------------------------------------------------------
-wxSocketClient::wxSocketClient(wxSockFlags _flags) :
- wxSocketBase(_flags, SOCK_CLIENT)
+void wxSocketBase::SetTimeout(long seconds)
{
+ m_timeout = seconds;
+
+ if (m_impl)
+ m_impl->SetTimeout(m_timeout * 1000);
}
-// --------------------------------------------------------------
-// --------- wxSocketClient DESTRUCTOR --------------------------
-// --------------------------------------------------------------
-wxSocketClient::~wxSocketClient()
+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;
}
-// --------------------------------------------------------------
-// --------- wxSocketClient Connect functions -------------------
-// --------------------------------------------------------------
-bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) )
+
+// --------------------------------------------------------------------------
+// Event handling
+// --------------------------------------------------------------------------
+
+void wxSocketBase::OnRequest(wxSocketNotify notification)
{
- struct linger linger;
+ switch(notification)
+ {
+ case wxSOCKET_CONNECTION:
+ m_establishing = false;
+ m_connected = true;
+ break;
- if (IsConnected())
- Close();
+ // 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.
- m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0);
-
- if (m_fd < 0)
- return FALSE;
-
- m_connected = FALSE;
-
- linger.l_onoff = 1;
- linger.l_linger = 5;
- setsockopt(m_fd, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger));
-
- // Stay in touch with the state of things...
-
- unsigned long flag = 1;
- setsockopt(m_fd, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int));
-
- // Disable the nagle algorithm, which delays sends till the
- // buffer is full (or a certain time period has passed?)...
-
-#if defined(__WINDOWS__) || (defined(IPPROTO_TCP) && defined(TCP_NODELAY))
- flag = 1;
- setsockopt(m_fd, IPPROTO_TCP, TCP_NODELAY, (char*)&flag, sizeof(int));
-#endif
-
- struct sockaddr *remote;
- size_t len;
+ case wxSOCKET_INPUT:
+ if (m_reading || !m_impl->Select(wxSOCKET_INPUT_FLAG))
+ return;
+ break;
- addr_man.Build(remote, len);
+ case wxSOCKET_OUTPUT:
+ if (m_writing || !m_impl->Select(wxSOCKET_OUTPUT_FLAG))
+ return;
+ break;
- if (connect(m_fd, remote, len) != 0)
- return FALSE;
+ case wxSOCKET_LOST:
+ m_connected = false;
+ m_establishing = false;
+ break;
- if (!(m_flags & SPEED)) {
- flag = 1;
- ioctl(m_fd, FIONBIO, &flag);
- }
-
- Notify(TRUE);
+ case wxSOCKET_MAX_EVENT:
+ wxFAIL_MSG( "unexpected notification" );
+ return;
+ }
+
+ // Schedule the event
+
+ wxSocketEventFlags flag = 0;
+ wxUnusedVar(flag);
+ switch (notification)
+ {
+ case wxSOCKET_INPUT: flag = wxSOCKET_INPUT_FLAG; break;
+ case wxSOCKET_OUTPUT: flag = wxSOCKET_OUTPUT_FLAG; break;
+ case wxSOCKET_CONNECTION: flag = wxSOCKET_CONNECTION_FLAG; break;
+ case wxSOCKET_LOST: flag = wxSOCKET_LOST_FLAG; break;
+ default:
+ wxLogWarning(_("wxSocket: unknown event!."));
+ return;
+ }
- m_connected = TRUE;
- return TRUE;
+ if (((m_eventmask & flag) == flag) && m_notify)
+ {
+ if (m_handler)
+ {
+ 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)
+void wxSocketBase::Notify(bool notify)
{
- int ret = _Wait(seconds, 0, REQ_CONNECT | REQ_LOST);
-
- if (ret)
- m_connected = TRUE;
-
- return m_connected;
+ m_notify = notify;
+ if (m_impl)
+ m_impl->Notify(notify);
}
-void wxSocketClient::OnRequest(wxRequestEvent evt)
+void wxSocketBase::SetNotify(wxSocketEventFlags flags)
{
- if (evt == EVT_CONNECT) {
- if (m_connected) {
- SetNotify(m_neededreq & ~REQ_CONNECT);
- return;
- }
- m_waitflags = 0x40;
- m_connected = TRUE;
- OldOnNotify(EVT_CONNECT);
- DestroyCallbacks();
- return;
- }
- wxSocketBase::OnRequest(evt);
+ m_eventmask = flags;
}
-/////////////////////////////////////////////////////////////////
-// wxSocketHandler ///////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////
+void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
+{
+ m_handler = &handler;
+ m_id = id;
+}
-wxSocketHandler *wxSocketHandler::master = NULL;
-#if defined(__WINDOWS__)
-static int win_initialized = 0;
-#endif
+// --------------------------------------------------------------------------
+// Pushback buffer
+// --------------------------------------------------------------------------
-// --------------------------------------------------------------
-// --------- wxSocketHandler CONSTRUCTOR ------------------------
-// --------------------------------------------------------------
-#ifdef __WINDOWS__
-
-extern char wxPanelClassName[];
-
-LRESULT APIENTRY _EXPORT wxSocketHandlerWndProc(HWND hWnd, UINT message,
- WPARAM wParam, LPARAM lParam)
-{
- wxSocketHandler *h_sock = (wxSocketHandler *)GetWindowLong(hWnd, GWL_USERDATA);
- wxNode *node = h_sock->smsg_list->Find(message);
- wxSocketBase *sock;
- wxSocketBase::wxRequestEvent sk_req;
- UINT event = WSAGETSELECTEVENT(lParam);
-
- if (!node)
- return DefWindowProc(hWnd, message, wParam, lParam);
-
- sock = (wxSocketBase *)node->Data();
-
- switch (event) {
- case FD_READ:
- sk_req = wxSocketBase::EVT_READ;
- break;
- case FD_WRITE:
- sk_req = wxSocketBase::EVT_WRITE;
- break;
- case FD_CLOSE:
- sk_req = wxSocketBase::EVT_LOST;
- break;
- case FD_ACCEPT:
- sk_req = wxSocketBase::EVT_ACCEPT;
- break;
- case FD_CONNECT:
- sk_req = wxSocketBase::EVT_CONNECT;
- break;
- }
- sock->OnRequest(sk_req);
+void wxSocketBase::Pushback(const void *buffer, wxUint32 size)
+{
+ if (!size) return;
- return (LRESULT)0;
-}
+ if (m_unread == NULL)
+ m_unread = malloc(size);
+ else
+ {
+ void *tmp;
-FARPROC wxSocketSubClassProc = NULL;
+ tmp = malloc(m_unrd_size + size);
+ memcpy((char *)tmp + size, m_unread, m_unrd_size);
+ free(m_unread);
-#endif
+ m_unread = tmp;
+ }
+
+ m_unrd_size += size;
-wxSocketHandler::wxSocketHandler()
+ memcpy(m_unread, buffer, size);
+}
+
+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;
- }
- internal = new wxSockHandlerInternal;
- internal->sockWin = ::CreateWindow(wxPanelClassName, NULL, 0,
- 0, 0, 0, 0, NULL, (HMENU) NULL,
- wxhInstance, 0);
-
- // Subclass the window
- if (!wxSocketSubClassProc)
- wxSocketSubClassProc = MakeProcInstance((FARPROC) wxSocketHandlerWndProc, wxhInstance);
- ::SetWindowLong(internal->sockWin, GWL_WNDPROC, (LONG) wxSocketSubClassProc);
- ::SetWindowLong(internal->sockWin, GWL_USERDATA, (LONG) this);
-
- internal->firstAvailableMsg = 5000;
- smsg_list = new wxList(wxKEY_INTEGER);
-#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_man,
+ wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_SERVER)
{
- wxNode *next_node, *node = socks->First();
+ wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") );
- while (node) {
- wxSocketBase* sock = (wxSocketBase*)node->Data();
+ m_impl = wxSocketImpl::Create(*this);
- delete sock;
- next_node = node->Next();
- delete node;
- node = next_node;
- }
+ if (!m_impl)
+ {
+ wxLogTrace( wxTRACE_Socket, _T("*** Failed to create m_impl") );
+ return;
+ }
- delete socks;
+ // Setup the socket as server
+ m_impl->Notify(m_notify);
+ m_impl->SetLocal(addr_man.GetAddress());
+
+ if (GetFlags() & wxSOCKET_REUSEADDR) {
+ m_impl->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST) {
+ m_impl->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND) {
+ m_impl->DontDoBind();
+ }
-#ifdef __WINDOWS__
- delete smsg_list;
+ if (m_impl->CreateServer() != wxSOCKET_NOERROR)
+ {
+ delete m_impl;
+ m_impl = NULL;
- ::DestroyWindow(internal->sockWin);
- WSACleanup();
- win_initialized = 0;
+ wxLogTrace( wxTRACE_Socket, _T("*** CreateServer() failed") );
+ return;
+ }
- delete internal;
-#endif
+ wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_impl->m_fd );
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler registering functions --------------
-// --------------------------------------------------------------
-void wxSocketHandler::Register(wxSocketBase* sock)
+// --------------------------------------------------------------------------
+// Accept
+// --------------------------------------------------------------------------
+
+bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
- wxNode *node;
+ if (!m_impl)
+ return false;
- for (node = socks->First(); node != NULL; node = node->Next()) {
- wxSocketBase* s = (wxSocketBase*)node->Data();
+ // 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);
- if (s == sock)
- return;
- }
+ if ( !sock.m_impl )
+ return false;
- if (sock) {
- socks->Append(sock);
- sock->SetHandler(this);
- sock->SetupCallbacks();
- }
+ 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();
-
- if (s == sock) {
- delete node;
- sock->DestroyCallbacks();
- sock->SetHandler(NULL);
- return;
+ sock->SetFlags(m_flags);
+
+ if (!AcceptWith(*sock, wait))
+ {
+ sock->Destroy();
+ sock = NULL;
}
- }
+
+ return sock;
}
-unsigned long wxSocketHandler::Count() const
+bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
- return socks->Number();
+ return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG);
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler "big" wait functions ---------------
-// --------------------------------------------------------------
-void handler_cbk(wxSocketBase& sock,
- wxSocketBase::wxRequestEvent WXUNUSED(flags),
- char *cdata)
+bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
{
- int *a_wait = (int *)cdata;
+ wxASSERT_MSG( m_impl, _T("Socket not initialised") );
- (*a_wait)++;
- sock.Notify(FALSE);
+ SOCKOPTLEN_T lenreal;
+ if ( getsockopt(m_impl->m_fd, level, optname,
+ static_cast<char *>(optval), &lenreal) != 0 )
+ return false;
+
+ *optlen = lenreal;
+
+ return true;
}
-int wxSocketHandler::Wait(long seconds, long microseconds)
+bool
+wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen)
{
- int i;
- int on_wait;
- wxSockWakeUp s_wake(NULL, &on_wait, -2);
- wxNode *node;
+ wxASSERT_MSG( m_impl, _T("Socket not initialised") );
- for (node = socks->First(), i=0; node; node = node->Next(), i++) {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+ return setsockopt(m_impl->m_fd, level, optname,
+ static_cast<const char *>(optval), optlen) == 0;
+}
- sock->SaveState();
+bool wxSocketBase::SetLocal(const wxIPV4address& local)
+{
+ GAddress* la = local.GetAddress();
- sock->SetupCallbacks();
+ // If the address is valid, save it for use when we call Connect
+ if (la && la->m_addr)
+ {
+ m_localAddress = local;
- sock->Callback(handler_cbk);
- sock->CallbackData((char *)&on_wait);
- }
- on_wait = 0;
- if (seconds != -1)
- s_wake.Start((seconds*1000) + (microseconds/1000), TRUE);
+ return true;
+ }
- while (!on_wait)
- PROCESS_EVENTS();
+ return false;
+}
- for (node = socks->First(), i=0; node; node = node->Next(), i++) {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+// ==========================================================================
+// wxSocketClient
+// ==========================================================================
- sock->RestoreState();
- }
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
- if (on_wait == -2)
- return 0;
+wxSocketClient::wxSocketClient(wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_CLIENT)
+{
+ m_initialRecvBufferSize =
+ m_initialSendBufferSize = -1;
+}
- return on_wait;
+wxSocketClient::~wxSocketClient()
+{
}
-void wxSocketHandler::YieldSock()
+// --------------------------------------------------------------------------
+// Connect
+// --------------------------------------------------------------------------
+
+bool wxSocketClient::DoConnect(const wxSockAddress& addr_man,
+ const wxSockAddress* local,
+ bool wait)
{
- wxNode *node;
+ if (m_impl)
+ {
+ // Shutdown and destroy the socket
+ Close();
+ delete m_impl;
+ }
- for (node = socks->First(); node; node = node->Next() ) {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+ m_impl = wxSocketImpl::Create(*this);
+ m_connected = false;
+ m_establishing = false;
- sock->SaveState();
+ if (!m_impl)
+ return false;
- sock->SetFlags(wxSocketBase::SPEED);
- if (sock->IsData())
- sock->DoRequests(wxSocketBase::EVT_READ);
- sock->DoRequests(wxSocketBase::EVT_WRITE);
+ // 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->RestoreState();
- }
+ // 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())
+ {
+ 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);
+ }
+
+ m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
+
+ m_impl->SetPeer(addr_man.GetAddress());
+ const wxSocketError err = m_impl->CreateClient();
+
+ //this will register for callbacks - must be called after m_impl->m_fd was initialized
+ m_impl->Notify(m_notify);
+
+ if (err != wxSOCKET_NOERROR)
+ {
+ if (err == wxSOCKET_WOULDBLOCK)
+ 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& addr_man, bool wait)
{
- wxSocketServer *serv = new wxSocketServer(addr, flags);
+ return DoConnect(addr_man, NULL, wait);
+}
- Register(serv);
- return serv;
+bool wxSocketClient::Connect(const wxSockAddress& addr_man,
+ const wxSockAddress& local,
+ bool wait)
+{
+ return DoConnect(addr_man, &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" );
+
+ // 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);
}
-#ifdef __WINDOWS__
-// --------------------------------------------------------------
-// --------- wxSocketHandler: Windows specific methods ----------
-// --------------------------------------------------------------
-UINT wxSocketHandler::NewMessage(wxSocketBase *sock)
+// ==========================================================================
+// wxDatagramSocket
+// ==========================================================================
+
+wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
+ wxSocketFlags flags )
+ : wxSocketBase( flags, wxSOCKET_DATAGRAM )
{
- internal->firstAvailableMsg++;
- smsg_list->Append(internal->firstAvailableMsg, sock);
- return internal->firstAvailableMsg;
+ // Create the socket
+ m_impl = wxSocketImpl::Create(*this);
+
+ 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)
+ {
+ m_impl->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST)
+ {
+ m_impl->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND)
+ {
+ m_impl->DontDoBind();
+ }
+
+ if ( m_impl->CreateUDP() != wxSOCKET_NOERROR )
+ {
+ delete m_impl;
+ m_impl = NULL;
+ return;
+ }
+
+ // Initialize all stuff
+ m_connected = false;
+ m_establishing = false;
}
-void wxSocketHandler::DestroyMessage(UINT msg)
+wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr,
+ void* buf,
+ wxUint32 nBytes )
{
- wxNode *node = smsg_list->Find(msg);
- delete node;
+ Read(buf, nBytes);
+ GetPeer(addr);
+ return (*this);
}
-HWND wxSocketHandler::GetHWND() const
+wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr,
+ const void* buf,
+ wxUint32 nBytes )
{
- return internal->sockWin;
+ wxASSERT_MSG( m_impl, _T("Socket not initialised") );
+
+ m_impl->SetPeer(addr.GetAddress());
+ Write(buf, nBytes);
+ return (*this);
}
-#endif
+// ==========================================================================
+// 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)
+
+#endif // wxUSE_SOCKETS
projects / wxWidgets.git / blobdiff