-////////////////////////////////////////////////////////////////////////////////
-// 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) 2000-1999, Guillermo Rodriguez Garcia
// RCS_ID: $Id$
-// License: see wxWindows license
-////////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "socket.h"
-#endif
+// License: 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
-// Not enough OS behaviour defined for wxStubs
-#ifndef __WXSTUBS__
+#include "wx/apptrait.h"
+#include "wx/sckaddr.h"
+#include "wx/stopwatch.h"
+#include "wx/thread.h"
+#include "wx/evtloop.h"
+
+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxNet")
+
+// --------------------------------------------------------------------------
+// macros and constants
+// --------------------------------------------------------------------------
+
+// discard buffer
+#define MAX_DISCARD_SIZE (10 * 1024)
+
+// what to do within waits: we have 2 cases: from the main thread itself we
+// have to call wxYield() to let the events (including the GUI events and the
+// low-level (not wxWidgets) events from GSocket) be processed. From another
+// thread it is enough to just call wxThread::Yield() which will give away the
+// rest of our time slice: the explanation is that the events will be processed
+// by the main thread anyhow, without calling wxYield(), but we don't want to
+// eat the CPU time uselessly while sitting in the loop waiting for the data
+#if wxUSE_THREADS
+ #define PROCESS_EVENTS() \
+ { \
+ if ( wxThread::IsMain() ) \
+ wxYield(); \
+ else \
+ wxThread::Yield(); \
+ }
+#else // !wxUSE_THREADS
+ #define PROCESS_EVENTS() wxYield()
+#endif // wxUSE_THREADS/!wxUSE_THREADS
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
+#define wxTRACE_Socket _T("wxSocket")
-/////////////////////////////////////////////////////////////////////////////
-// System specific headers
-/////////////////////////////////////////////////////////////////////////////
-#ifdef __WXMAC__
-// in order to avoid problems with our c library and double definitions
-#define close closesocket
-#define ioctl ioctlsocket
+// --------------------------------------------------------------------------
+// wxWin macros
+// --------------------------------------------------------------------------
-#include <wx/mac/macsock.h>
+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(__WINDOWS__)
-#include <winsock.h>
-#endif // __WINDOWS__
+class wxSocketState : public wxObject
+{
+public:
+ wxSocketFlags m_flags;
+ wxSocketEventFlags m_eventmask;
+ bool m_notify;
+ void *m_clientData;
-#if defined(__UNIX__)
+public:
+ wxSocketState() : wxObject() {}
-#ifdef VMS
-#include <socket.h>
-#else
-#include <sys/socket.h>
-#endif
-#include <sys/ioctl.h>
+ DECLARE_NO_COPY_CLASS(wxSocketState)
+};
-#include <sys/time.h>
-#include <unistd.h>
+// ============================================================================
+// GSocketManager
+// ============================================================================
-#ifdef sun
-#include <sys/filio.h>
-#endif
+GSocketManager *GSocketManager::ms_manager = NULL;
-#endif // __UNIX__
+/* static */
+void GSocketManager::Set(GSocketManager *manager)
+{
+ wxASSERT_MSG( !ms_manager, "too late to set manager now" );
-#include <signal.h>
-#include <errno.h>
+ ms_manager = manager;
+}
-#ifdef __VISUALC__
-#include <io.h>
-#endif
+/* static */
+void GSocketManager::Init()
+{
+ 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();
+}
-/////////////////////////////////////////////////////////////////////////////
-// 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
+// ==========================================================================
+// wxSocketBase
+// ==========================================================================
-#ifndef __WINDOWS__
-#define INVALID_SOCKET -1
-#endif
+// --------------------------------------------------------------------------
+// Initialization and shutdown
+// --------------------------------------------------------------------------
-#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).
+// 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;
-#if defined( NEED_WSAFDIsSet ) || defined( __VISUALC__ )
-int PASCAL FAR __WSAFDIsSet(SOCKET fd, fd_set FAR *set)
+bool wxSocketBase::IsInitialized()
{
- int i = set->fd_count;
-
- while (i--)
- {
- if (set->fd_array[i] == fd)
- return 1;
- }
-
- return 0;
+ return m_countInit > 0;
}
-#endif
-#endif
-// -------------------
-// Some patch ---- END
-// -------------------
+bool wxSocketBase::Initialize()
+{
+ if ( !m_countInit++ )
+ {
+ if ( !GSocket_Init() )
+ {
+ m_countInit--;
-#ifdef GetClassInfo
-#undef GetClassInfo
-#endif
+ return false;
+ }
+ }
+
+ return true;
+}
-// --------------------------------------------------------------
-// Module
-// --------------------------------------------------------------
-class wxSocketModule: public wxModule
+void wxSocketBase::Shutdown()
{
- DECLARE_DYNAMIC_CLASS(wxSocketModule)
-public:
- wxSocketModule() {}
- bool OnInit();
- void OnExit();
-};
+ // we should be initialized
+ wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") );
+ if ( --m_countInit == 0 )
+ {
+ GSocket_Cleanup();
+ }
+}
-// --------------------------------------------------------------
-// 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
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
-// --------------------------------------------------------------
-// --------- 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)
+void wxSocketBase::Init()
{
- m_internal = new wxSocketInternal(this);
+ m_socket = NULL;
+ m_type = wxSOCKET_UNINIT;
+
+ // state
+ m_flags = 0;
+ m_connected =
+ m_establishing =
+ m_reading =
+ m_writing =
+ m_error = 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();
+ }
}
-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)
+wxSocketBase::wxSocketBase()
{
- m_internal = new wxSocketInternal(this);
+ Init();
}
-// --------------------------------------------------------------
-// wxSocketBase
-// --------------------------------------------------------------
+wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
+{
+ Init();
+
+ m_flags = flags;
+ m_type = type;
+}
wxSocketBase::~wxSocketBase()
{
- // First, close the file descriptor.
- Close();
+ // Just in case the app called Destroy() *and* then deleted
+ // the socket immediately: don't leave dangling pointers.
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits )
+ traits->RemoveFromPendingDelete(this);
+
+ // Shutdown and close the socket
+ if (!m_beingDeleted)
+ Close();
- m_internal->FinalizeSocket();
+ // Destroy the GSocket object
+ if (m_socket)
+ delete m_socket;
+ // Free the pushback buffer
if (m_unread)
free(m_unread);
- // Unregister from the handler database.
- if (m_handler)
- m_handler->UnRegister(this);
+}
+
+bool wxSocketBase::Destroy()
+{
+ // 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();
- // Destroy all saved states.
- m_states.DeleteContents(TRUE);
+ // Supress events from now on
+ Notify(false);
+
+ // 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;
+ }
- // Destroy the socket manager.
- delete m_internal;
+ return true;
}
+// --------------------------------------------------------------------------
+// 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()
{
- if (m_fd != INVALID_SOCKET)
+ // Interrupt pending waits
+ InterruptWait();
+
+ if (m_socket)
{
- // Pause all running socket thread.
- m_internal->PauseSocket();
-
- // Shutdown the connection.
- shutdown(m_fd, 2);
- close(m_fd);
- m_fd = INVALID_SOCKET;
- m_connected = FALSE;
+ // Disable callbacks
+ m_socket->UnsetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG);
+
+ // Shutdown the connection
+ m_socket->Shutdown();
}
- return TRUE;
+ m_connected = false;
+ m_establishing = false;
+ return true;
}
-// --------------------------------------------------------------
-// wxSocketBase base IO function
-// --------------------------------------------------------------
-
-wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes)
+wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
{
- m_lcount = GetPushback(buffer, nbytes, FALSE);
- nbytes -= m_lcount;
- buffer += m_lcount;
-
- // 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;
- }
+ // Mask read events
+ m_reading = true;
+
+ m_lcount = _Read(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);
- WantBuffer(buffer, nbytes, EVT_READ);
+ // Allow read events from now on
+ m_reading = false;
return *this;
}
-wxSocketBase& wxSocketBase::Peek(char* buffer, size_t nbytes)
+wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
{
- m_lcount = GetPushback(buffer, nbytes, TRUE);
- if (nbytes-m_lcount == 0)
+ int total;
+
+ // Try the pushback buffer first
+ total = GetPushback(buffer, nbytes, false);
+ nbytes -= total;
+ buffer = (char *)buffer + total;
+
+ // Return now in one of the following cases:
+ // - the socket is invalid,
+ // - we got all the data
+ if ( !m_socket ||
+ !nbytes )
+ return total;
+
+ // Possible combinations (they are checked in this order)
+ // wxSOCKET_NOWAIT
+ // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
+ // wxSOCKET_BLOCK
+ // wxSOCKET_NONE
+ //
+ int ret;
+ if (m_flags & wxSOCKET_NOWAIT)
{
- return *this;
+ m_socket->SetNonBlocking(1);
+ ret = m_socket->Read((char *)buffer, nbytes);
+ m_socket->SetNonBlocking(0);
+
+ if (ret > 0)
+ total += ret;
}
- buffer += m_lcount;
- nbytes -= m_lcount;
+ else
+ {
+ bool more = true;
- WantBuffer(buffer, nbytes, EVT_PEEK);
+ while (more)
+ {
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() )
+ break;
+
+ ret = m_socket->Read((char *)buffer, nbytes);
+
+ if (ret > 0)
+ {
+ total += ret;
+ nbytes -= ret;
+ buffer = (char *)buffer + ret;
+ }
+
+ // If we got here and wxSOCKET_WAITALL is not set, we can leave
+ // now. Otherwise, wait until we recv all the data or until there
+ // is an error.
+ //
+ more = (ret > 0 && nbytes > 0 && (m_flags & wxSOCKET_WAITALL));
+ }
+ }
- return *this;
+ return total;
}
-wxSocketBase& wxSocketBase::Write(const char *buffer, size_t nbytes)
+wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
{
- m_lcount = 0;
- WantBuffer((char *)buffer, nbytes, EVT_WRITE);
+ wxUint32 len, len2, sig, total;
+ bool error;
+ int old_flags;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
+
+ // Mask read events
+ m_reading = true;
+
+ total = 0;
+ error = true;
+ old_flags = m_flags;
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+
+ if (_Read(&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;
+ }
+
+ len = (wxUint32)msg.len[0];
+ len |= (wxUint32)(msg.len[1] << 8);
+ len |= (wxUint32)(msg.len[2] << 16);
+ len |= (wxUint32)(msg.len[3] << 24);
+
+ if (len > nbytes)
+ {
+ len2 = len - nbytes;
+ len = nbytes;
+ }
+ else
+ len2 = 0;
+
+ // Don't attemp to read if the msg was zero bytes long.
+ if (len)
+ {
+ total = _Read(buffer, len);
+
+ 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 = _Read(discard_buffer, (wxUint32)discard_len);
+ len2 -= (wxUint32)discard_len;
+ }
+ while ((discard_len > 0) && len2);
+
+ delete [] discard_buffer;
+
+ if (len2 != 0)
+ goto exit;
+ }
+ if (_Read(&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;
}
-wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes)
+wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
- CreatePushbackAfter(buffer, nbytes);
+ // Mask read events
+ m_reading = true;
+
+ m_lcount = _Read(buffer, nbytes);
+ Pushback(buffer, m_lcount);
+
+ // 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;
}
-bool wxSocketBase::IsData() const
+wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
{
- struct timeval tv;
- fd_set sock_set;
-
- if (m_fd < 0)
- return FALSE;
- if (m_unrd_size > 0)
- return TRUE;
+ // Mask write events
+ m_writing = true;
- m_internal->AcquireFD();
+ m_lcount = _Write(buffer, nbytes);
- 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);
+ // 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);
- m_internal->ReleaseFD();
+ // Allow write events again
+ m_writing = false;
- return (FD_ISSET(m_fd, &sock_set) != 0);
+ return *this;
}
-// ---------------------------------------------------------------------
-// --------- wxSocketBase Discard(): deletes all byte in the input queue
-// ---------------------------------------------------------------------
-void wxSocketBase::Discard()
+wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
{
-#define MAX_BUFSIZE (10*1024)
- char *my_data = new char[MAX_BUFSIZE];
- size_t recv_size = MAX_BUFSIZE;
+ wxUint32 total = 0;
- SaveState();
- SetFlags((wxSockFlags)(NOWAIT | SPEED));
+ // If the socket is invalid or parameters are ill, return immediately
+ if (!m_socket || !buffer || !nbytes)
+ return 0;
- while (recv_size == MAX_BUFSIZE)
+ // Possible combinations (they are checked in this order)
+ // wxSOCKET_NOWAIT
+ // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
+ // wxSOCKET_BLOCK
+ // wxSOCKET_NONE
+ //
+ int ret;
+ if (m_flags & wxSOCKET_NOWAIT)
{
- recv_size = Read(my_data, MAX_BUFSIZE).LastCount();
+ m_socket->SetNonBlocking(1);
+ ret = m_socket->Write((const char *)buffer, nbytes);
+ m_socket->SetNonBlocking(0);
+
+ if (ret > 0)
+ total = ret;
}
+ else
+ {
+ bool more = true;
- RestoreState();
- delete [] my_data;
+ while (more)
+ {
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
+ break;
+
+ ret = m_socket->Write((const char *)buffer, nbytes);
+
+ if (ret > 0)
+ {
+ total += ret;
+ nbytes -= ret;
+ buffer = (const char *)buffer + ret;
+ }
+
+ // If we got here and wxSOCKET_WAITALL is not set, we can leave
+ // now. Otherwise, wait until we send all the data or until there
+ // is an error.
+ //
+ more = (ret > 0 && nbytes > 0 && (m_flags & wxSOCKET_WAITALL));
+ }
+ }
-#undef MAX_BUFSIZE
+ return total;
}
-// 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.
+wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
+{
+ wxUint32 total;
+ bool error;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
-// JACS - How can we detect this?
-// Meanwhile, if your compiler complains about socklen_t,
-// switch lines below.
+ // Mask write events
+ m_writing = true;
-#if wxHAVE_GLIBC2
-# define wxSOCKET_INT socklen_t
-#else
-# define wxSOCKET_INT int
-#endif
+ error = true;
+ total = 0;
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
-// --------------------------------------------------------------
-// wxSocketBase socket info functions
-// --------------------------------------------------------------
+ msg.sig[0] = (unsigned char) 0xad;
+ msg.sig[1] = (unsigned char) 0xde;
+ msg.sig[2] = (unsigned char) 0xed;
+ msg.sig[3] = (unsigned char) 0xfe;
-bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
-{
- struct sockaddr my_addr;
- wxSOCKET_INT len_addr = sizeof(my_addr);
+ 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 (m_fd < 0)
- return FALSE;
+ if (_Write(&msg, sizeof(msg)) < sizeof(msg))
+ goto exit;
- m_internal->AcquireFD();
+ total = _Write(buffer, nbytes);
- if (getpeername(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) {
- m_internal->ReleaseFD();
- return FALSE;
- }
+ if (total < nbytes)
+ goto exit;
- m_internal->ReleaseFD();
- addr_man.Disassemble(&my_addr, len_addr);
- return TRUE;
-}
-
-bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
-{
- struct sockaddr my_addr;
- wxSOCKET_INT len_addr = sizeof(my_addr);
+ 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 (m_fd < 0)
- return FALSE;
+ if ((_Write(&msg, sizeof(msg))) < sizeof(msg))
+ goto exit;
- m_internal->AcquireFD();
+ // everything was OK
+ error = false;
- if (getsockname(m_fd, (struct sockaddr *)&my_addr, &len_addr) < 0) {
- m_internal->ReleaseFD();
- return FALSE;
- }
- m_internal->ReleaseFD();
+exit:
+ m_error = error;
+ m_lcount = total;
+ m_writing = false;
- addr_man.Disassemble(&my_addr, len_addr);
- return TRUE;
+ return *this;
}
-// --------------------------------------------------------------
-// wxSocketBase wait functions
-// --------------------------------------------------------------
-
-void wxSocketBase::SaveState()
+wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
{
- SocketState *state = new SocketState;
+ if (nbytes != 0)
+ Pushback(buffer, nbytes);
- 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 = false;
+ m_lcount = nbytes;
- m_states.Append((wxObject *)state);
+ return *this;
}
-void wxSocketBase::RestoreState()
+wxSocketBase& wxSocketBase::Discard()
{
- wxNode *node;
- SocketState *state;
+ char *buffer = new char[MAX_DISCARD_SIZE];
+ wxUint32 ret;
+ wxUint32 total = 0;
+
+ // Mask read events
+ m_reading = true;
+
+ SetFlags(wxSOCKET_NOWAIT);
- node = m_states.Last();
- if (!node)
- return;
+ do
+ {
+ ret = _Read(buffer, MAX_DISCARD_SIZE);
+ total += ret;
+ }
+ while (ret == MAX_DISCARD_SIZE);
- state = (SocketState *)node->Data();
+ delete[] buffer;
+ m_lcount = total;
+ m_error = false;
- SetFlags(state->socket_flags);
- m_neededreq = state->evt_notify_state;
- m_cbk = state->c_callback;
- m_cdata = state->c_callback_data;
- Notify(state->notify_state);
+ // Allow read events again
+ m_reading = false;
- delete node;
- delete state;
+ return *this;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase callback functions --------------------
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Wait functions
+// --------------------------------------------------------------------------
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
+// All Wait functions poll the socket using GSocket_Select() to
+// check for the specified combination of conditions, until one
+// of these conditions become true, an error occurs, or the
+// timeout elapses. The polling loop calls PROCESS_EVENTS(), so
+// this won't block the GUI.
+
+bool wxSocketBase::_Wait(long seconds,
+ long milliseconds,
+ wxSocketEventFlags flags)
{
- wxSockCbk old_cbk = cbk_;
+ GSocketEventFlags result;
+ long timeout; // in ms
- m_cbk = cbk_;
- return old_cbk;
-}
+ // Set this to true to interrupt ongoing waits
+ m_interrupt = false;
-char *wxSocketBase::CallbackData(char *data)
-{
- char *old_data = m_cdata;
+ // Check for valid socket
+ if (!m_socket)
+ return false;
- m_cdata = data;
- return old_data;
-}
+ // Check for valid timeout value.
+ if (seconds != -1)
+ timeout = seconds * 1000 + milliseconds;
+ else
+ timeout = m_timeout * 1000;
+
+ // check if we are using event loop or not: normally we do in GUI but not in
+ // console applications but this can be overridden
+ const bool has_event_loop = wxEventLoop::GetActive() != NULL;
+
+ // Wait in an active polling loop.
+ //
+ // NOTE: We duplicate some of the code in OnRequest, but this doesn't
+ // hurt. It has to be here because the (GSocket) event might arrive
+ // a bit delayed, and it has to be in OnRequest as well because we
+ // don't know whether the Wait functions are being used.
+ //
+ // Do this at least once (important if timeout == 0, when
+ // we are just polling). Also, if just polling, do not yield.
+
+ const wxMilliClock_t time_limit = wxGetLocalTimeMillis() + timeout;
+ bool done = false;
+ bool valid_result = false;
+
+ if (!has_event_loop)
+ {
+ // This is used to avoid a busy loop on wxBase - having a select
+ // timeout of 50 ms per iteration should be enough.
+ if (timeout > 50)
+ m_socket->SetTimeout(50);
+ else
+ m_socket->SetTimeout(timeout);
+ }
-// --------------------------------------------------------------
-// --------- wxSocketBase wait functions ------------------------
-// --------------------------------------------------------------
+ while (!done)
+ {
+ result = m_socket->Select(flags | GSOCK_LOST_FLAG);
-bool wxSocketBase::_Wait(long seconds, long milliseconds, int type)
-{
- SockRequest *req;
+ // Incoming connection (server) or connection established (client)
+ if (result & GSOCK_CONNECTION_FLAG)
+ {
+ m_connected = true;
+ m_establishing = false;
+ valid_result = true;
+ break;
+ }
+
+ // Data available or output buffer ready
+ if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG))
+ {
+ valid_result = true;
+ break;
+ }
- if ((!m_connected && !m_connecting) || m_fd < 0)
- return FALSE;
+ // Connection lost
+ if (result & GSOCK_LOST_FLAG)
+ {
+ m_connected = false;
+ m_establishing = false;
+ valid_result = ((flags & GSOCK_LOST_FLAG) != 0);
+ break;
+ }
- req = new SockRequest;
+ // Wait more?
+ long time_left = wxMilliClockToLong(time_limit - wxGetLocalTimeMillis());
+ if ((!timeout) || (time_left <= 0) || (m_interrupt))
+ done = true;
+ else
+ {
+ if (has_event_loop)
+ {
+ PROCESS_EVENTS();
+ }
+ else
+ {
+ // If there's less than 50 ms left, just call select with that timeout.
+ if (time_left < 50)
+ m_socket->SetTimeout(time_left);
+ }
+ }
+ }
- 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);
+ // Set timeout back to original value (we overwrote it for polling)
+ if (!has_event_loop)
+ m_socket->SetTimeout(m_timeout*1000);
- return (req->io_nbytes != 0);
+ return valid_result;
}
bool wxSocketBase::Wait(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, REQ_ACCEPT | REQ_CONNECT |
- REQ_READ | REQ_WRITE | REQ_LOST);
+ return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG |
+ GSOCK_OUTPUT_FLAG |
+ GSOCK_CONNECTION_FLAG |
+ GSOCK_LOST_FLAG);
}
bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, REQ_READ | REQ_LOST);
+ // Check pushback buffer before entering _Wait
+ if (m_unread)
+ return true;
+
+ // Note that GSOCK_INPUT_LOST has to be explicitly passed to
+ // _Wait because of the semantics of WaitForRead: a return
+ // value of true means that a GSocket_Read call will return
+ // immediately, not that there is actually data to read.
+
+ return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG |
+ GSOCK_LOST_FLAG);
}
+
bool wxSocketBase::WaitForWrite(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, REQ_WRITE);
+ return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG);
}
bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, REQ_LOST);
+ return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG);
}
-// --------------------------------------------------------------
-// --------- wxSocketBase callback management -------------------
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Miscellaneous
+// --------------------------------------------------------------------------
+
+//
+// Get local or peer address
+//
-wxSocketBase::wxRequestNotify wxSocketBase::EventToNotify(wxRequestEvent evt)
+bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
{
- 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;
+ GAddress *peer;
+
+ if (!m_socket)
+ return false;
+
+ peer = m_socket->GetPeer();
+
+ // copying a null address would just trigger an assert anyway
+
+ if (!peer)
+ return false;
+
+ addr_man.SetAddress(peer);
+ GAddress_destroy(peer);
+
+ return true;
}
-void wxSocketBase::SetFlags(wxSockFlags _flags)
+bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
{
- m_flags = _flags;
- if (_flags & SPEED) {
- // SPEED and WAITALL are antagonists.
- m_flags = (wxSockFlags)(m_flags & ~WAITALL);
- }
+ GAddress *local;
+
+ if (!m_socket)
+ return false;
+
+ local = m_socket->GetLocal();
+ addr_man.SetAddress(local);
+ GAddress_destroy(local);
+
+ return true;
}
-wxSocketBase::wxSockFlags wxSocketBase::GetFlags() const
+//
+// Save and restore socket state
+//
+
+void wxSocketBase::SaveState()
{
- return m_flags;
+ 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);
}
-void wxSocketBase::SetNotify(wxRequestNotify flags)
+void wxSocketBase::RestoreState()
{
- /* Check if server */
- if (m_type != SOCK_SERVER)
- flags &= ~REQ_ACCEPT;
+ wxList::compatibility_iterator node;
+ wxSocketState *state;
- m_neededreq = flags;
- if (m_neededreq == 0)
- m_internal->DisableWaiter();
- else
- Notify(m_notify_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;
}
-void wxSocketBase::Notify(bool notify)
+//
+// Timeout and flags
+//
+
+void wxSocketBase::SetTimeout(long seconds)
{
- if (notify)
- m_internal->EnableWaiter();
- else
- m_internal->DisableWaiter();
- m_notify_state = notify;
+ m_timeout = seconds;
+
+ if (m_socket)
+ m_socket->SetTimeout(m_timeout * 1000);
}
-void wxSocketBase::OnRequest(wxRequestEvent req_evt)
+void wxSocketBase::SetFlags(wxSocketFlags flags)
{
- wxSocketEvent event(m_id);
- wxRequestNotify notify = EventToNotify(req_evt);
-
- if ((m_neededreq & notify) == notify) {
- event.m_socket = this;
- event.m_skevt = req_evt;
- ProcessEvent(event);
- // TODOTODO
- // OldOnNotify(req_evt);
-
- // We disable the event reporting.
- SetNotify(m_neededreq & ~notify);
- }
+ m_flags = flags;
}
-wxSocketEvent::wxSocketEvent(int id)
- : wxEvent(id)
+
+// --------------------------------------------------------------------------
+// Event handling
+// --------------------------------------------------------------------------
+
+// A note on how events are processed, which is probably the most
+// difficult thing to get working right while keeping the same API
+// and functionality for all platforms.
+//
+// When GSocket detects an event, it calls wx_socket_callback, which in
+// turn just calls wxSocketBase::OnRequest in the corresponding wxSocket
+// object. OnRequest does some housekeeping, and if the event is to be
+// propagated to the user, it creates a new wxSocketEvent object and
+// posts it. The event is not processed immediately, but delayed with
+// AddPendingEvent instead. This is necessary in order to decouple the
+// event processing from wx_socket_callback; otherwise, subsequent IO
+// calls made from the user event handler would fail, as gtk callbacks
+// are not reentrant.
+//
+// Note that, unlike events, user callbacks (now deprecated) are _not_
+// decoupled from wx_socket_callback and thus they suffer from a variety
+// of problems. Avoid them where possible and use events instead.
+
+extern "C"
+void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
+ GSocketEvent notification,
+ char *cdata)
{
- wxEventType type = (wxEventType)wxEVT_SOCKET;
+ wxSocketBase *sckobj = (wxSocketBase *)cdata;
- SetEventType(type);
+ sckobj->OnRequest((wxSocketNotify) notification);
}
-wxObject *wxSocketEvent::Clone() const
+void wxSocketBase::OnRequest(wxSocketNotify notification)
{
- wxSocketEvent *event = (wxSocketEvent *)wxEvent::Clone();
+ // NOTE: We duplicate some of the code in _Wait, but this doesn't
+ // hurt. It has to be here because the (GSocket) event might arrive
+ // a bit delayed, and it has to be in _Wait as well because we don't
+ // know whether the Wait functions are being used.
+
+ switch(notification)
+ {
+ case wxSOCKET_CONNECTION:
+ m_establishing = false;
+ m_connected = true;
+ break;
+
+ // If we are in the middle of a R/W operation, do not
+ // propagate events to users. Also, filter 'late' events
+ // which are no longer valid.
+
+ case wxSOCKET_INPUT:
+ if (m_reading || !m_socket->Select(GSOCK_INPUT_FLAG))
+ return;
+ break;
+
+ case wxSOCKET_OUTPUT:
+ if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG))
+ return;
+ break;
+
+ case wxSOCKET_LOST:
+ m_connected = false;
+ m_establishing = false;
+ break;
+
+ default:
+ break;
+ }
+
+ // Schedule the event
- event->m_skevt = m_skevt;
- event->m_socket = m_socket;
+ wxSocketEventFlags flag = 0;
+ wxUnusedVar(flag);
+ switch (notification)
+ {
+ case GSOCK_INPUT: flag = GSOCK_INPUT_FLAG; break;
+ case GSOCK_OUTPUT: flag = GSOCK_OUTPUT_FLAG; break;
+ case GSOCK_CONNECTION: flag = GSOCK_CONNECTION_FLAG; break;
+ case GSOCK_LOST: flag = GSOCK_LOST_FLAG; break;
+ default:
+ wxLogWarning(_("wxSocket: unknown event!."));
+ return;
+ }
+
+ 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);
- return event;
+ m_handler->AddPendingEvent(event);
+ }
+ }
}
-void wxSocketBase::OldOnNotify(wxRequestEvent evt)
+void wxSocketBase::Notify(bool notify)
{
+ m_notify = notify;
+ if (m_socket)
+ m_socket->Notify(notify);
}
-// --------------------------------------------------------------
-// --------- wxSocketBase functions [Callback, CallbackData] ----
-// --------------------------------------------------------------
-
-void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id)
+void wxSocketBase::SetNotify(wxSocketEventFlags flags)
{
- SetNextHandler(&h_evt);
- m_id = id;
+ m_eventmask = flags;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase pushback library ----------------------
-// --------------------------------------------------------------
-
-void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size)
+void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
{
- char *curr_pos;
-
- 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;
-
- memcpy(curr_pos, buffer, size);
- m_unrd_size += size;
+ m_handler = &handler;
+ m_id = id;
}
-void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size)
+// --------------------------------------------------------------------------
+// Pushback buffer
+// --------------------------------------------------------------------------
+
+void wxSocketBase::Pushback(const void *buffer, wxUint32 size)
{
- char *curr_pos, *new_buf;
+ if (!size) return;
- new_buf = (char *) malloc(m_unrd_size+size);
- curr_pos = new_buf + size;
+ if (m_unread == NULL)
+ m_unread = malloc(size);
+ else
+ {
+ void *tmp;
- memcpy(new_buf, buffer, size);
- if (m_unrd_size != 0) {
- memcpy(curr_pos, m_unread, m_unrd_size);
+ tmp = malloc(m_unrd_size + size);
+ memcpy((char *)tmp + size, m_unread, m_unrd_size);
free(m_unread);
+
+ m_unread = tmp;
}
- m_unread = new_buf;
+
m_unrd_size += size;
+
+ memcpy(m_unread, buffer, size);
}
-size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek)
+wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek)
{
if (!m_unrd_size)
return 0;
- if (size > m_unrd_size)
- size = m_unrd_size;
- memcpy(buffer, m_unread, size);
+ if (size > (m_unrd_size-m_unrd_cur))
+ size = m_unrd_size-m_unrd_cur;
- if (!peek) {
- m_unrd_size -= size;
- if (m_unrd_size == 0) {
+ 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;
}
-// --------------------------------------------------------------
-// --------- wxSocketBase buffer core requester -----------------
-// --------------------------------------------------------------
-void wxSocketBase::WantBuffer(char *buffer, size_t nbytes,
- wxRequestEvent evt)
-{
- bool buf_timed_out;
-
- if (m_fd == INVALID_SOCKET || !m_handler || !m_connected)
- return;
-
- SockRequest *buf = new SockRequest;
-
- SaveState();
- m_internal->DisableWaiter();
- 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;
-
- if (m_flags & SPEED)
- m_internal->QueueRequest(buf, FALSE);
- else
- if (m_flags & NOWAIT)
- 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;
-
- delete buf;
- RestoreState();
-}
-
-// --------------------------------------------------------------
+// ==========================================================================
// wxSocketServer
-// --------------------------------------------------------------
+// ==========================================================================
-wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
- wxSockFlags flags) :
- wxSocketBase(flags, SOCK_SERVER)
+// --------------------------------------------------------------------------
+// Ctor
+// --------------------------------------------------------------------------
+
+wxSocketServer::wxSocketServer(const wxSockAddress& addr_man,
+ wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_SERVER)
{
- m_fd = socket(addr_man.GetFamily(), SOCK_STREAM, 0);
+ wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") );
+
+ m_socket = GSocket_new();
+
+ if (!m_socket)
+ {
+ wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") );
+ return;
+ }
- if (m_fd == INVALID_SOCKET)
- return;
+ // Setup the socket as server
+ m_socket->Notify(m_notify);
+ m_socket->SetLocal(addr_man.GetAddress());
- int flag = 1;
- setsockopt(m_fd, SOL_SOCKET, SO_REUSEADDR, (char*)&flag, sizeof(int));
+ if (GetFlags() & wxSOCKET_REUSEADDR) {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST) {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND) {
+ m_socket->DontDoBind();
+ }
- struct sockaddr *myaddr;
- size_t len;
+ if (m_socket->SetServer() != GSOCK_NOERROR)
+ {
+ delete m_socket;
+ m_socket = NULL;
- addr_man.Build(myaddr, len);
- if (bind(m_fd, myaddr, addr_man.SockAddrLen()) < 0)
- return;
+ wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") );
+ return;
+ }
- if (listen(m_fd, 5) < 0) {
- m_fd = INVALID_SOCKET;
- return;
- }
+ m_socket->SetTimeout(m_timeout * 1000);
+ m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char *)this);
- m_internal->InitializeSocket();
+ wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_socket->m_fd );
}
-// --------------------------------------------------------------
-// wxSocketServer Accept
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Accept
+// --------------------------------------------------------------------------
-bool wxSocketServer::AcceptWith(wxSocketBase& sock)
+bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
- int fd2;
+ GSocket *child_socket;
+
+ if (!m_socket)
+ return false;
- if ((fd2 = accept(m_fd, 0, 0)) < 0)
- return FALSE;
+ // If wait == false, then the call should be nonblocking.
+ // When we are finished, we put the socket to blocking mode
+ // again.
- struct linger linger;
- linger.l_onoff = 0;
- linger.l_linger = 1;
+ if (!wait)
+ m_socket->SetNonBlocking(1);
- setsockopt(fd2, SOL_SOCKET, SO_LINGER, (char*)&linger, sizeof(linger));
+ child_socket = m_socket->WaitConnection();
- int flag = 0;
- setsockopt(fd2, SOL_SOCKET, SO_KEEPALIVE, (char*)&flag, sizeof(int));
+ if (!wait)
+ m_socket->SetNonBlocking(0);
- sock.m_type = SOCK_INTERNAL;
- sock.m_fd = fd2;
- sock.m_connected = TRUE;
+ if (!child_socket)
+ return false;
- sock.m_internal->InitializeSocket();
+ sock.m_type = wxSOCKET_BASE;
+ sock.m_socket = child_socket;
+ sock.m_connected = true;
- return TRUE;
+ sock.m_socket->SetTimeout(sock.m_timeout * 1000);
+ sock.m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char *)&sock);
+
+ return true;
}
-wxSocketBase *wxSocketServer::Accept()
+wxSocketBase *wxSocketServer::Accept(bool wait)
{
wxSocketBase* sock = new wxSocketBase();
- sock->SetFlags((wxSockFlags)m_flags);
-
- if (!AcceptWith(*sock))
- return NULL;
+ sock->SetFlags(m_flags);
- if (m_handler)
- m_handler->Register(sock);
+ if (!AcceptWith(*sock, wait))
+ {
+ sock->Destroy();
+ sock = NULL;
+ }
return sock;
}
-// --------------------------------------------------------------
-// wxSocketClient
-// --------------------------------------------------------------
-
-// --------- wxSocketClient CONSTRUCTOR -------------------------
-// --------------------------------------------------------------
-wxSocketClient::wxSocketClient(wxSockFlags _flags) :
- wxSocketBase(_flags, SOCK_CLIENT)
-{
-}
-
-// --------------------------------------------------------------
-// --------- wxSocketClient DESTRUCTOR --------------------------
-// --------------------------------------------------------------
-wxSocketClient::~wxSocketClient()
+bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
+ return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
}
-// --------------------------------------------------------------
-// --------- wxSocketClient Connect functions -------------------
-// --------------------------------------------------------------
-bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) )
+bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
{
- struct linger linger;
-
- if (IsConnected())
- Close();
-
- // Initializes all socket stuff ...
- // --------------------------------
- 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));
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
- // 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;
-
- addr_man.Build(remote, len);
-
- if (connect(m_fd, remote, len) != 0)
- return FALSE;
-
- // Initializes the background threads ...
- // --------------------------------------
- m_internal->InitializeSocket();
-
- // Enables bg events.
- // ------------------
- Notify(TRUE);
-
- m_connected = TRUE;
- return TRUE;
+ if (m_socket->GetSockOpt(level, optname, optval, optlen)
+ != GSOCK_NOERROR)
+ {
+ return false;
+ }
+ return true;
}
-bool wxSocketClient::WaitOnConnect(long seconds, long microseconds)
+bool wxSocketBase::SetOption(int level, int optname, const void *optval,
+ int optlen)
{
- int ret = _Wait(seconds, microseconds, REQ_CONNECT | REQ_LOST);
-
- if (ret)
- m_connected = TRUE;
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
- return m_connected;
+ if (m_socket->SetSockOpt(level, optname, optval, optlen)
+ != GSOCK_NOERROR)
+ {
+ return false;
+ }
+ return true;
}
-void wxSocketClient::OnRequest(wxRequestEvent evt)
+bool wxSocketBase::SetLocal(wxIPV4address& local)
{
- if (evt == EVT_CONNECT)
+ GAddress* la = local.GetAddress();
+
+ // If the address is valid, save it for use when we call Connect
+ if (la && la->m_addr)
{
- if (m_connected)
- {
- SetNotify(m_neededreq & ~REQ_CONNECT);
- return;
- }
- m_connected = TRUE;
- OldOnNotify(EVT_CONNECT);
- return;
+ m_localAddress = local;
+
+ return true;
}
- wxSocketBase::OnRequest(evt);
+
+ return false;
}
-/////////////////////////////////////////////////////////////////
-// wxSocketHandler ///////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////
+// ==========================================================================
+// wxSocketClient
+// ==========================================================================
-wxSocketHandler *wxSocketHandler::master = NULL;
-#if defined(__WINDOWS__)
-static int win_initialized = 0;
-#endif
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
-// --------------------------------------------------------------
-// --------- wxSocketHandler CONSTRUCTOR ------------------------
-// --------------------------------------------------------------
-wxSocketHandler::wxSocketHandler()
+wxSocketClient::wxSocketClient(wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_CLIENT)
{
-#if defined(__WINDOWS__)
- if (!win_initialized)
- {
- WSADATA wsaData;
-
- WSAStartup((1 << 8) | 1, &wsaData);
- win_initialized = 1;
- }
-#endif
-
- socks = new wxList;
+ m_initialRecvBufferSize =
+ m_initialSendBufferSize = -1;
+}
-#ifndef __WINDOWS__
- signal(SIGPIPE, SIG_IGN);
-#endif
+wxSocketClient::~wxSocketClient()
+{
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler DESTRUCTOR -------------------------
-// --------------------------------------------------------------
-wxSocketHandler::~wxSocketHandler()
+// --------------------------------------------------------------------------
+// Connect
+// --------------------------------------------------------------------------
+
+bool wxSocketClient::DoConnect(wxSockAddress& addr_man, wxSockAddress* local, bool wait)
{
- wxNode *next_node, *node = socks->First();
+ GSocketError err;
- while (node)
+ if (m_socket)
{
- wxSocketBase* sock = (wxSocketBase*)node->Data();
-
- delete sock;
- next_node = node->Next();
- delete node;
- node = next_node;
+ // Shutdown and destroy the socket
+ Close();
+ delete m_socket;
}
- delete socks;
+ m_socket = GSocket_new();
+ m_connected = false;
+ m_establishing = false;
-#ifdef __WINDOWS__
- WSACleanup();
- win_initialized = 0;
-#endif
-}
+ if (!m_socket)
+ return false;
-// --------------------------------------------------------------
-// --------- wxSocketHandler registering functions --------------
-// --------------------------------------------------------------
+ m_socket->SetTimeout(m_timeout * 1000);
+ m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char *)this);
-void wxSocketHandler::Register(wxSocketBase* sock)
-{
- wxNode *node;
+ // If wait == false, then the call should be nonblocking.
+ // When we are finished, we put the socket to blocking mode
+ // again.
- for (node = socks->First(); node != NULL; node = node->Next())
- {
- wxSocketBase* s = (wxSocketBase*)node->Data();
+ if (!wait)
+ m_socket->SetNonBlocking(1);
- if (s == sock)
- return;
+ // Reuse makes sense for clients too, if we are trying to rebind to the same port
+ if (GetFlags() & wxSOCKET_REUSEADDR)
+ {
+ m_socket->SetReusable();
}
-
- if (sock)
+ if (GetFlags() & wxSOCKET_BROADCAST)
{
- socks->Append(sock);
- sock->SetHandler(this);
+ m_socket->SetBroadcast();
}
-}
-
-void wxSocketHandler::UnRegister(wxSocketBase* sock)
-{
- wxNode *node;
-
- for (node = socks->First(); node; node = node->Next())
+ if (GetFlags() & wxSOCKET_NOBIND)
{
- wxSocketBase* s = (wxSocketBase*)node->Data();
-
- if (s == sock)
- {
- delete node;
- sock->SetHandler(NULL);
- return;
- }
+ m_socket->DontDoBind();
}
-}
-
-unsigned long wxSocketHandler::Count() const
-{
- return socks->Number();
-}
-
-// --------------------------------------------------------------
-// --------- wxSocketHandler "big" wait functions ---------------
-// --------------------------------------------------------------
-int wxSocketHandler::Wait(long seconds, long microseconds)
-{
- // TODO Needs the completely asynchronous notifier.
+ // 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;
+ }
- /*
- int i;
- int on_wait;
- wxNode *node;
- for (node = socks->First(), i=0; node; node = node->Next(), i++)
+ // Bind to the local IP address and port, when provided
+ if (local)
{
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+ GAddress* la = local->GetAddress();
- sock->SaveState();
+ if (la && la->m_addr)
+ m_socket->SetLocal(la);
+ }
- sock->SetupCallbacks();
+#if defined(__WXMSW__) || defined(__WXGTK__)
+ m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
+#endif
- sock->Callback(handler_cbk);
- sock->CallbackData((char *)&on_wait);
- }
- on_wait = 0;
- if (seconds != -1)
- s_wake.Start((seconds*1000) + (microseconds/1000), TRUE);
+ m_socket->SetPeer(addr_man.GetAddress());
+ err = m_socket->Connect(GSOCK_STREAMED);
- while (!on_wait)
- PROCESS_EVENTS();
+ //this will register for callbacks - must be called after m_socket->m_fd was initialized
+ m_socket->Notify(m_notify);
- for (node = socks->First(), i=0; node; node = node->Next(), i++)
+ if (!wait)
+ m_socket->SetNonBlocking(0);
+
+ if (err != GSOCK_NOERROR)
{
- wxSocketBase *sock = (wxSocketBase *)node->Data();
+ if (err == GSOCK_WOULDBLOCK)
+ m_establishing = true;
- sock->RestoreState();
+ return false;
}
- if (on_wait == -2)
- return 0;
-
- return on_wait;
- */
- return 0;
+ m_connected = true;
+ return true;
}
-void wxSocketHandler::YieldSock()
+bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait)
{
- wxNode *node;
-
- // Nothing to do anymore here except waiting for the queue emptying.
- for (node = socks->First(); node; node=node->Next()) {
- wxSocketBase *sock = (wxSocketBase *)node->Data();
-
- sock->m_internal->WaitForEnd(NULL);
- }
+ return (DoConnect(addr_man, NULL, wait));
}
-// --------------------------------------------------------------
-// --------- wxSocketHandler: create and register the socket ----
-// --------------------------------------------------------------
-wxSocketServer *wxSocketHandler::CreateServer(wxSockAddress& addr,
- wxSocketBase::wxSockFlags flags)
+bool wxSocketClient::Connect(wxSockAddress& addr_man, wxSockAddress& local, bool wait)
{
- wxSocketServer *serv = new wxSocketServer(addr, flags);
-
- Register(serv);
- return serv;
+ 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) // Already connected
+ return true;
+
+ if (!m_establishing || !m_socket) // No connection in progress
+ return false;
- Register(client);
- return client;
+ return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG |
+ GSOCK_LOST_FLAG);
}
-#ifdef __WINDOWS__
-// --------------------------------------------------------------
-// --------- wxSocketHandler: Windows specific methods ----------
-// --------------------------------------------------------------
+// ==========================================================================
+// wxDatagramSocket
+// ==========================================================================
+
+/* NOTE: experimental stuff - might change */
-UINT wxSocketHandler::NewMessage(wxSocketBase *sock)
+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_socket = GSocket_new();
+
+ if (!m_socket)
+ {
+ wxFAIL_MSG( _T("datagram socket not new'd") );
+ return;
+ }
+ m_socket->Notify(m_notify);
+ // Setup the socket as non connection oriented
+ m_socket->SetLocal(addr.GetAddress());
+ if (flags & wxSOCKET_REUSEADDR)
+ {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST)
+ {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND)
+ {
+ m_socket->DontDoBind();
+ }
+ if ( m_socket->SetNonOriented() != GSOCK_NOERROR )
+ {
+ delete m_socket;
+ m_socket = NULL;
+ return;
+ }
+
+ // Initialize all stuff
+ m_connected = false;
+ m_establishing = false;
+ m_socket->SetTimeout( m_timeout );
+ m_socket->SetCallback( GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char*)this );
}
-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_socket, _T("Socket not initialised") );
+
+ m_socket->SetPeer(addr.GetAddress());
+ Write(buf, nBytes);
+ return (*this);
}
-#endif
+// ==========================================================================
+// wxSocketModule
+// ==========================================================================
-bool wxSocketModule::OnInit()
+class wxSocketModule : public wxModule
{
- wxSocketHandler::master = new wxSocketHandler();
- return TRUE;
-}
+public:
+ virtual bool OnInit()
+ {
+ // wxSocketBase will call GSocket_Init() itself when/if needed
+ return true;
+ }
-void wxSocketModule::OnExit()
-{
- delete wxSocketHandler::master;
- wxSocketHandler::master = NULL;
-}
+ virtual void OnExit()
+ {
+ if ( wxSocketBase::IsInitialized() )
+ wxSocketBase::Shutdown();
+ }
-#endif
- // __WXSTUBS__
+private:
+ DECLARE_DYNAMIC_CLASS(wxSocketModule)
+};
+
+IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
#endif
// wxUSE_SOCKETS