/////////////////////////////////////////////////////////////////////////////
-// Name: socket.cpp
+// Name: src/common/socket.cpp
// Purpose: Socket handler classes
// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
// Created: April 1997
-// Updated: September 1999
-// Copyright: (C) 1999, 1998, 1997, Guilhem Lavaux
-// (C) 1999, Guillermo Rodriguez Garcia
+// Copyright: (C) 1999-1997, Guilhem Lavaux
+// (C) 2000-1999, Guillermo Rodriguez Garcia
// RCS_ID: $Id$
-// License: see wxWindows license
+// License: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "socket.h"
-#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/module.h"
-#include "wx/log.h"
-
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
+#include "wx/socket.h"
-/////////////////////////////////////////////////////////////////////////////
-// wxSocket headers
-/////////////////////////////////////////////////////////////////////////////
+#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
+
+#include "wx/apptrait.h"
#include "wx/sckaddr.h"
-#include "wx/socket.h"
+#include "wx/stopwatch.h"
+#include "wx/thread.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
+
+#define wxTRACE_Socket _T("wxSocket")
+
+// --------------------------------------------------------------------------
+// wxWin macros
+// --------------------------------------------------------------------------
-// --------------------------------------------------------------
-// ClassInfos
-// --------------------------------------------------------------
-#if !USE_SHARED_LIBRARY
IMPLEMENT_CLASS(wxSocketBase, wxObject)
IMPLEMENT_CLASS(wxSocketServer, wxSocketBase)
IMPLEMENT_CLASS(wxSocketClient, wxSocketBase)
+IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase)
IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
-#endif
+
+// --------------------------------------------------------------------------
+// private classes
+// --------------------------------------------------------------------------
class wxSocketState : public wxObject
{
public:
- bool notify_state;
- GSocketEventFlags evt_notify_state;
- wxSocketBase::wxSockFlags socket_flags;
- wxSocketBase::wxSockCbk c_callback;
- char *c_callback_data;
+ wxSocketFlags m_flags;
+ wxSocketEventFlags m_eventmask;
+ bool m_notify;
+ void *m_clientData;
public:
wxSocketState() : wxObject() {}
+
+ DECLARE_NO_COPY_CLASS(wxSocketState)
};
-// --------------------------------------------------------------
-// wxSocketBase ctor and dtor
-// --------------------------------------------------------------
-
-wxSocketBase::wxSocketBase(wxSocketBase::wxSockFlags _flags,
- wxSocketBase::wxSockType _type) :
- wxEvtHandler(),
- m_socket(NULL), m_flags(_flags), m_type(_type),
- m_neededreq(0),
- m_lcount(0), m_timeout(600),
- m_unread(NULL), m_unrd_size(0), m_unrd_cur(0),
- m_cbk(NULL), m_cdata(NULL),
- m_connected(FALSE), m_establishing(FALSE),
- m_notify_state(FALSE), m_id(-1),
- m_defering(NO_DEFER), m_error(FALSE),
- m_states()
+// ==========================================================================
+// 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::IsInitialized()
{
+ return m_countInit > 0;
}
-wxSocketBase::wxSocketBase() :
- wxEvtHandler(),
- m_socket(NULL), m_flags(WAITALL | SPEED), m_type(SOCK_UNINIT),
- m_neededreq(0),
- m_lcount(0), m_timeout(600),
- m_unread(NULL), m_unrd_size(0), m_unrd_cur(0),
- m_cbk(NULL), m_cdata(NULL),
- m_connected(FALSE), m_establishing(FALSE),
- m_notify_state(FALSE), m_id(-1),
- m_defering(NO_DEFER), m_error(FALSE),
- m_states()
+bool wxSocketBase::Initialize()
{
+ if ( !m_countInit++ )
+ {
+ /*
+ 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(),
+ wxT("Call wxSocketBase::Initialize() from the main thread first!"));
+
+ wxAppTraits *traits = wxAppConsole::GetInstance() ?
+ wxAppConsole::GetInstance()->GetTraits() : NULL;
+ GSocketGUIFunctionsTable *functions =
+ traits ? traits->GetSocketGUIFunctionsTable() : NULL;
+ GSocket_SetGUIFunctions(functions);
+
+ if ( !GSocket_Init() )
+ {
+ m_countInit--;
+
+ return false;
+ }
+ }
+
+ return true;
}
-wxSocketBase::~wxSocketBase()
+void wxSocketBase::Shutdown()
{
- if (m_unread)
- free(m_unread);
+ // we should be initialized
+ wxASSERT_MSG( m_countInit, _T("extra call to Shutdown()") );
+ if ( --m_countInit == 0 )
+ {
+ GSocket_Cleanup();
+ }
+}
- // Shutdown and close the socket
- Close();
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
- // Destroy the GSocket object
- if (m_socket)
- GSocket_destroy(m_socket);
+void wxSocketBase::Init()
+{
+ 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();
+ }
}
-bool wxSocketBase::Close()
+wxSocketBase::wxSocketBase()
{
- if (m_socket)
- {
- // Disable callbacks
- GSocket_UnsetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
- GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG);
+ Init();
+}
- // Shutdown the connection
- GSocket_Shutdown(m_socket);
- m_connected = FALSE;
- m_establishing = FALSE;
- }
+wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
+{
+ Init();
- return TRUE;
+ m_flags = flags;
+ m_type = type;
}
-// --------------------------------------------------------------
-// wxSocketBase basic IO operations
-// --------------------------------------------------------------
-
-// GRG: I have made some changes to wxSocket internal event
-// system; now, all events (INPUT, OUTPUT, CONNECTION, LOST)
-// are always internally monitored; but users will only be
-// notified of these events they are interested in. So we
-// no longer have to change the event mask with SetNotify()
-// in internal functions like DeferRead, DeferWrite, and
-// the like. This solves a lot of problems.
-
-// GRG: I added m_error handling to IO operations. Now,
-// wxSocketBase::Error() correctly indicates if the last
-// operation from {Read, Write, ReadMsg, WriteMsg, Peek,
-// Unread, Discard} failed. Note that now, every function
-// that updates m_lcount, also updates m_error. While I
-// was at it, also fixed an UGLY bug in ReadMsg.
-
-class _wxSocketInternalTimer: public wxTimer
+wxSocketBase::~wxSocketBase()
{
-public:
- int *m_state;
- unsigned long m_new_val;
+ // 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);
- void Notify()
- {
- *m_state = m_new_val; // Change the value
- }
-};
+ // Shutdown and close the socket
+ if (!m_beingDeleted)
+ Close();
-int wxSocketBase::DeferRead(char *buffer, wxUint32 nbytes)
+ // Destroy the GSocket object
+ if (m_socket)
+ delete m_socket;
+
+ // Free the pushback buffer
+ if (m_unread)
+ free(m_unread);
+}
+
+bool wxSocketBase::Destroy()
{
- // Timer for timeout
- _wxSocketInternalTimer timer;
+ // 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;
- wxASSERT(m_defering == NO_DEFER);
+ // Shutdown and close the socket
+ Close();
- // Set the defering mode to READ.
- m_defering = DEFER_READ;
+ // Supress events from now on
+ Notify(false);
- // Set the current buffer.
- m_defer_buffer = buffer;
- m_defer_nbytes = nbytes;
- m_defer_timer = &timer;
+ // 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;
+ }
- timer.m_state = (int *)&m_defer_buffer;
- timer.m_new_val = 0;
+ return true;
+}
- timer.Start(m_timeout * 1000, FALSE);
+// --------------------------------------------------------------------------
+// Basic IO calls
+// --------------------------------------------------------------------------
- // If the socket is readable, call DoDefer for the first time
- if (GSocket_Select(m_socket, GSOCK_INPUT_FLAG))
- DoDefer();
+// 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?
- // Wait for buffer completion.
- while (m_defer_buffer != NULL)
- wxYield();
+bool wxSocketBase::Close()
+{
+ // Interrupt pending waits
+ InterruptWait();
- timer.Stop();
+ if (m_socket)
+ {
+ // Disable callbacks
+ m_socket->UnsetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG);
- // Disable defering mode.
- m_defering = NO_DEFER;
- m_defer_timer = NULL;
+ // Shutdown the connection
+ m_socket->Shutdown();
+ }
- // Return the number of bytes read from the socket.
- return nbytes-m_defer_nbytes;
+ m_connected = false;
+ m_establishing = false;
+ return true;
}
-wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
{
- int ret = 1;
+ // Mask read events
+ m_reading = true;
+
+ m_lcount = _Read(buffer, nbytes);
- m_error = FALSE;
+ // 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);
- // we try this even if the connection has already been closed.
- m_lcount = GetPushback(buffer, nbytes, FALSE);
- nbytes -= m_lcount;
- buffer += m_lcount;
+ // Allow read events from now on
+ m_reading = false;
- if (!m_connected || !m_socket)
- {
- // if no data retrieved AND not connected, it is an error.
- if (!m_lcount)
- m_error = TRUE;
+ return *this;
+}
- return *this;
- }
+wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
+{
+ int total;
- // If we have got the whole needed buffer, return immediately
- if (!nbytes)
- return *this;
+ // 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)
- // NOWAIT
- // SPEED | WAITALL
- // SPEED
- // WAITALL
- // NONE
+ // wxSOCKET_NOWAIT
+ // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
+ // wxSOCKET_BLOCK
+ // wxSOCKET_NONE
//
- if (m_flags & NOWAIT) // NOWAIT
+ int ret;
+ if (m_flags & wxSOCKET_NOWAIT)
{
- GSocket_SetNonBlocking(m_socket, TRUE);
- ret = GSocket_Read(m_socket, buffer, nbytes);
- GSocket_SetNonBlocking(m_socket, FALSE);
+ m_socket->SetNonBlocking(1);
+ ret = m_socket->Read((char *)buffer, nbytes);
+ m_socket->SetNonBlocking(0);
if (ret > 0)
- m_lcount += ret;
+ total += ret;
}
- else if (m_flags & SPEED & WAITALL) // SPEED, WAITALL
+ else
{
- while (ret > 0 && nbytes > 0)
+ bool more = true;
+
+ while (more)
{
- ret = GSocket_Read(m_socket, buffer, nbytes);
- m_lcount += ret;
- buffer += ret;
- nbytes -= ret;
- }
- // In case the last call was an error ...
- if (ret < 0)
- m_lcount ++;
- }
- else if (m_flags & SPEED) // SPEED, !WAITALL
- {
- ret = GSocket_Read(m_socket, buffer, nbytes);
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() )
+ break;
- if (ret > 0)
- m_lcount += ret;
- }
- else // NONE or WAITALL
- {
- ret = DeferRead(buffer, nbytes);
+ ret = m_socket->Read((char *)buffer, nbytes);
- if (ret > 0)
- m_lcount += ret;
- }
+ if (ret > 0)
+ {
+ total += ret;
+ nbytes -= ret;
+ buffer = (char *)buffer + ret;
+ }
- // If we have read some data, then it is not an error, even
- // when in WAITALL mode, the last low-level IO call might
- // have failed.
- if (!m_lcount)
- m_error = TRUE;
+ // 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::ReadMsg(char* buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
{
-#define MAX_BUFSIZE (10 * 1024)
-
+ wxUint32 len, len2, sig, total;
+ bool error;
int old_flags;
- unsigned long len, len2, sig;
struct
{
- char sig[4];
- char len[4];
+ unsigned char sig[4];
+ unsigned char len[4];
} msg;
- // sig should be an explicit 32-bit unsigned integer; I've seen
- // compilers in which wxUint32 was actually a 16-bit unsigned integer
+ // Mask read events
+ m_reading = true;
+ total = 0;
+ error = true;
old_flags = m_flags;
- SetFlags(old_flags | WAITALL);
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
- Read((char *)&msg, sizeof(msg));
- if (m_lcount != sizeof(msg))
- {
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
- }
+ if (_Read(&msg, sizeof(msg)) != sizeof(msg))
+ goto exit;
- sig = msg.sig[0] & 0xff;
- sig |= (wxUint32)(msg.sig[1] & 0xff) << 8;
- sig |= (wxUint32)(msg.sig[2] & 0xff) << 16;
- sig |= (wxUint32)(msg.sig[3] & 0xff) << 24;
+ 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)
{
- wxLogDebug(_T("Warning: invalid signature returned to ReadMsg\n"));
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
+ goto exit;
}
- len = msg.len[0] & 0xff;
- len |= (wxUint32)(msg.len[1] & 0xff) << 8;
- len |= (wxUint32)(msg.len[2] & 0xff) << 16;
- len |= (wxUint32)(msg.len[3] & 0xff) << 24;
+ len = (wxUint32)msg.len[0];
+ len |= (wxUint32)(msg.len[1] << 8);
+ len |= (wxUint32)(msg.len[2] << 16);
+ len |= (wxUint32)(msg.len[3] << 24);
if (len > nbytes)
{
else
len2 = 0;
- // The "len &&" in the following statements is necessary so
- // that we don't attempt to read (and possibly hang the system)
- // if the message was zero bytes long
- if (len && Read(buffer, len).LastCount() != len)
+ // Don't attemp to read if the msg was zero bytes long.
+ if (len)
{
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
+ total = _Read(buffer, len);
+
+ if (total != len)
+ goto exit;
}
if (len2)
{
- char *discard_buffer = new char[MAX_BUFSIZE];
+ 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_BUFSIZE)? MAX_BUFSIZE : len2);
- discard_len = Read(discard_buffer, discard_len).LastCount();
- len2 -= discard_len;
+ 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)
- {
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
- }
- }
- if (Read((char *)&msg, sizeof(msg)).LastCount() != sizeof(msg))
- {
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
+ goto exit;
}
+ if (_Read(&msg, sizeof(msg)) != sizeof(msg))
+ goto exit;
- sig = msg.sig[0] & 0xff;
- sig |= (wxUint32)(msg.sig[1] & 0xff) << 8;
- sig |= (wxUint32)(msg.sig[2] & 0xff) << 16;
- sig |= (wxUint32)(msg.sig[3] & 0xff) << 24;
+ 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)
{
- m_error = TRUE;
- wxLogDebug(_T("Warning: invalid signature returned to ReadMsg\n"));
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
+ goto exit;
}
- SetFlags(old_flags);
- return *this;
-
-#undef MAX_BUFSIZE
-}
+ // everything was OK
+ error = false;
-wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes)
-{
- Read(buffer, nbytes);
- CreatePushbackAfter(buffer, nbytes);
+exit:
+ m_error = error;
+ m_lcount = total;
+ m_reading = false;
+ SetFlags(old_flags);
return *this;
}
-int wxSocketBase::DeferWrite(const char *buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
- // Timer for timeout
- _wxSocketInternalTimer timer;
-
- wxASSERT(m_defering == NO_DEFER);
+ // Mask read events
+ m_reading = true;
- m_defering = DEFER_WRITE;
+ m_lcount = _Read(buffer, nbytes);
+ Pushback(buffer, m_lcount);
- // Set the current buffer
- m_defer_buffer = (char *)buffer;
- m_defer_nbytes = nbytes;
- m_defer_timer = &timer;
+ // 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);
- // Start timer
- timer.m_state = (int *)&m_defer_buffer;
- timer.m_new_val = 0;
+ // Allow read events again
+ m_reading = false;
- timer.Start(m_timeout * 1000, FALSE);
+ return *this;
+}
- // If the socket is writable, call DoDefer for the first time
- if (GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG))
- DoDefer();
+wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
+{
+ // Mask write events
+ m_writing = true;
- // Wait for buffer completion.
- while (m_defer_buffer != NULL)
- wxYield();
+ m_lcount = _Write(buffer, nbytes);
- // Stop timer
- m_defer_timer = NULL;
- timer.Stop();
+ // 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_defering = NO_DEFER;
+ // Allow write events again
+ m_writing = false;
- return nbytes-m_defer_nbytes;
+ return *this;
}
-wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes)
+wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
{
- int ret = 1;
-
- m_lcount = 0;
- m_error = FALSE;
+ wxUint32 total = 0;
- if (!m_connected || !m_socket)
- {
- m_error = TRUE;
- return *this;
- }
+ // If the socket is invalid or parameters are ill, return immediately
+ if (!m_socket || !buffer || !nbytes)
+ return 0;
// Possible combinations (they are checked in this order)
- // NOWAIT
- // SPEED | WAITALL
- // SPEED
- // WAITALL
- // NONE
+ // wxSOCKET_NOWAIT
+ // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
+ // wxSOCKET_BLOCK
+ // wxSOCKET_NONE
//
- if (m_flags & NOWAIT) // NOWAIT
+ int ret;
+ if (m_flags & wxSOCKET_NOWAIT)
{
- GSocket_SetNonBlocking(m_socket, TRUE);
- ret = GSocket_Write(m_socket, buffer, nbytes);
- GSocket_SetNonBlocking(m_socket, FALSE);
+ m_socket->SetNonBlocking(1);
+ ret = m_socket->Write((const char *)buffer, nbytes);
+ m_socket->SetNonBlocking(0);
if (ret > 0)
- m_lcount += ret;
+ total = ret;
}
- else if (m_flags & SPEED & WAITALL) // SPEED, WAITALL
+ else
{
- while (ret > 0 && nbytes > 0)
+ bool more = true;
+
+ while (more)
{
- ret = GSocket_Write(m_socket, buffer, nbytes);
- m_lcount += ret;
- buffer += ret;
- nbytes -= ret;
- }
- // In case the last call was an error ...
- if (ret < 0)
- m_lcount ++;
- }
- else if (m_flags & SPEED) // SPEED, !WAITALL
- {
- ret = GSocket_Write(m_socket, buffer, nbytes);
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
+ break;
- if (ret > 0)
- m_lcount += ret;
- }
- else // NONE or WAITALL
- {
- ret = DeferWrite(buffer, nbytes);
+ ret = m_socket->Write((const char *)buffer, nbytes);
- if (ret > 0)
- m_lcount += ret;
- }
+ if (ret > 0)
+ {
+ total += ret;
+ nbytes -= ret;
+ buffer = (const char *)buffer + ret;
+ }
- // If we have written some data, then it is not an error,
- // even when in WAITALL mode, the last low-level IO call
- // might have failed.
- if (!m_lcount)
- m_error = TRUE;
+ // 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));
+ }
+ }
- return *this;
+ return total;
}
-wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
{
- int old_flags;
- struct {
- char sig[4];
- char len[4];
+ wxUint32 total;
+ bool error;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
} msg;
- // warning about 'cast truncates constant value'
-#ifdef __VISUALC__
- #pragma warning(disable: 4310)
-#endif // __VISUALC__
+ // Mask write events
+ m_writing = true;
- msg.sig[0] = (char) 0xad;
- msg.sig[1] = (char) 0xde;
- msg.sig[2] = (char) 0xed;
- msg.sig[3] = (char) 0xfe;
+ error = true;
+ total = 0;
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
- msg.len[0] = (char) nbytes & 0xff;
- msg.len[1] = (char) (nbytes >> 8) & 0xff;
- msg.len[2] = (char) (nbytes >> 16) & 0xff;
- msg.len[3] = (char) (nbytes >> 24) & 0xff;
+ msg.sig[0] = (unsigned char) 0xad;
+ msg.sig[1] = (unsigned char) 0xde;
+ msg.sig[2] = (unsigned char) 0xed;
+ msg.sig[3] = (unsigned char) 0xfe;
- old_flags = m_flags;
- SetFlags(old_flags | WAITALL);
+ 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 (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg))
- {
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
- }
- if (Write(buffer, nbytes).LastCount() < nbytes)
- {
- SetFlags(old_flags);
- m_error = TRUE;
- return *this;
- }
+ if (_Write(&msg, sizeof(msg)) < sizeof(msg))
+ goto exit;
- msg.sig[0] = (char) 0xed;
- msg.sig[1] = (char) 0xfe;
- msg.sig[2] = (char) 0xad;
- msg.sig[3] = (char) 0xde;
- msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = (char) 0;
+ total = _Write(buffer, nbytes);
- if (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg))
- m_error = TRUE;
+ if (total < nbytes)
+ goto exit;
- SetFlags(old_flags);
- return *this;
-
-#ifdef __VISUALC__
- #pragma warning(default: 4310)
-#endif // __VISUALC__
-}
+ 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;
-wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes)
-{
- m_error = FALSE;
- m_lcount = 0;
+ if ((_Write(&msg, sizeof(msg))) < sizeof(msg))
+ goto exit;
- if (nbytes != 0)
- {
- CreatePushbackAfter(buffer, nbytes);
- m_lcount = nbytes;
- }
- return *this;
-}
+ // everything was OK
+ error = false;
-bool wxSocketBase::IsData() const
-{
- if (!m_socket)
- return FALSE;
+exit:
+ m_error = error;
+ m_lcount = total;
+ m_writing = false;
- return (GSocket_Select(m_socket, GSOCK_INPUT_FLAG));
+ return *this;
}
-// GRG: DoDefer() no longer needs to know which event occured,
-// because this was only used to catch LOST events and set
-// m_defer_buffer = NULL; this is done in OnRequest() now.
-
-void wxSocketBase::DoDefer()
+wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
{
- int ret;
-
- if (!m_defer_buffer)
- return;
-
- switch (m_defering)
- {
- case DEFER_READ:
- ret = GSocket_Read(m_socket, m_defer_buffer, m_defer_nbytes);
- break;
- case DEFER_WRITE:
- ret = GSocket_Write(m_socket, m_defer_buffer, m_defer_nbytes);
- break;
- default:
- ret = -1;
- break;
- }
+ if (nbytes != 0)
+ Pushback(buffer, nbytes);
- if (ret >= 0)
- m_defer_nbytes -= ret;
+ m_error = false;
+ m_lcount = nbytes;
- // If we are waiting for all bytes to be acquired, keep the defering
- // mode enabled.
- if ((m_flags & WAITALL) == 0 || m_defer_nbytes == 0 || ret < 0)
- {
- m_defer_buffer = NULL;
- }
- else
- {
- m_defer_buffer += ret;
- m_defer_timer->Start(m_timeout * 1000, FALSE);
- }
+ return *this;
}
-void wxSocketBase::Discard()
+wxSocketBase& wxSocketBase::Discard()
{
-#define MAX_BUFSIZE (10*1024)
-
- char *my_data = new char[MAX_BUFSIZE];
- wxUint32 recv_size = MAX_BUFSIZE;
+ char *buffer = new char[MAX_DISCARD_SIZE];
+ wxUint32 ret;
wxUint32 total = 0;
- SaveState();
- SetFlags(NOWAIT); // GRG: SPEED was not needed here!
+ // Mask read events
+ m_reading = true;
+
+ SetFlags(wxSOCKET_NOWAIT);
- while (recv_size == MAX_BUFSIZE)
+ do
{
- recv_size = Read(my_data, MAX_BUFSIZE).LastCount();
- total += recv_size;
+ ret = _Read(buffer, MAX_DISCARD_SIZE);
+ total += ret;
}
+ while (ret == MAX_DISCARD_SIZE);
- RestoreState();
- delete [] my_data;
-
+ delete[] buffer;
m_lcount = total;
- m_error = FALSE;
-
-#undef MAX_BUFSIZE
-}
-
-// --------------------------------------------------------------
-// wxSocketBase get local or peer addresses
-// --------------------------------------------------------------
-
-bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
-{
- GAddress *peer;
-
- if (!m_socket)
- return FALSE;
-
- peer = GSocket_GetPeer(m_socket);
- addr_man.SetAddress(peer);
- GAddress_destroy(peer);
-
- return TRUE;
-}
-
-bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
-{
- GAddress *local;
-
- if (!m_socket)
- return FALSE;
-
- local = GSocket_GetLocal(m_socket);
- addr_man.SetAddress(local);
- GAddress_destroy(local);
-
- return TRUE;
-}
-
-// --------------------------------------------------------------
-// wxSocketBase save and restore socket state
-// --------------------------------------------------------------
-
-void wxSocketBase::SaveState()
-{
- wxSocketState *state;
-
- state = new wxSocketState();
-
- 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_states.Append(state);
-}
-
-void wxSocketBase::RestoreState()
-{
- wxNode *node;
- wxSocketState *state;
-
- node = m_states.Last();
- if (!node)
- return;
-
- state = (wxSocketState *)node->Data();
+ 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;
}
+// --------------------------------------------------------------------------
+// Wait functions
+// --------------------------------------------------------------------------
-// --------------------------------------------------------------
-// wxSocketBase Wait functions
-// --------------------------------------------------------------
-
-// GRG: I have completely rewritten this family of functions
-// so that they don't depend on event notifications; instead,
-// they poll the socket, using GSocket_Select(), to check for
-// the specified combination of event flags, until an event
-// occurs or until the timeout ellapses. The polling loop
-// calls wxYield(), so this won't block the GUI.
+// 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)
+bool wxSocketBase::_Wait(long seconds,
+ long milliseconds,
+ wxSocketEventFlags flags)
{
GSocketEventFlags result;
- _wxSocketInternalTimer timer;
- long timeout;
- int state = -1;
+ long timeout; // in ms
+
+ // Set this to true to interrupt ongoing waits
+ m_interrupt = false;
// Check for valid socket
if (!m_socket)
- return FALSE;
-
- // If it is not a server, it must be connected or establishing connection
- if ((m_type != SOCK_SERVER) && (!m_connected && !m_establishing))
- return FALSE;
+ return false;
- // Check for valid timeout value
+ // Check for valid timeout value.
if (seconds != -1)
timeout = seconds * 1000 + milliseconds;
else
timeout = m_timeout * 1000;
- // Activate timer
- timer.m_state = &state;
- timer.m_new_val = 0;
- timer.Start(timeout, TRUE);
+ bool has_event_loop = wxTheApp->GetTraits() ? (wxTheApp->GetTraits()->GetSocketGUIFunctionsTable() ? true : false) : false;
- // Active polling (without using events)
+ // Wait in an active polling loop.
//
- // NOTE: this duplicates some of the code in OnRequest (lost
- // connection and connection establishment handling) but this
- // doesn't hurt. It has to be here because the event might
- // be a bit delayed, and it has to be in OnRequest as well
- // because maybe the WaitXXX functions are not being used.
+ // 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.
//
- while (state == -1)
+ // 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)
{
- result = GSocket_Select(m_socket, flags | GSOCK_LOST_FLAG);
+ // 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);
+ }
- // Connection lost
- if (result & GSOCK_LOST_FLAG)
- {
- timer.Stop();
- m_defer_buffer = NULL;
- Close();
- return TRUE;
- }
+ while (!done)
+ {
+ result = m_socket->Select(flags | GSOCK_LOST_FLAG);
// Incoming connection (server) or connection established (client)
if (result & GSOCK_CONNECTION_FLAG)
{
- timer.Stop();
- m_connected = TRUE;
- m_establishing = FALSE;
- return TRUE;
+ m_connected = true;
+ m_establishing = false;
+ valid_result = true;
+ break;
}
- // If we are in the middle of a deferred R/W, ignore these.
+ // Data available or output buffer ready
if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG))
{
- if (m_defer_buffer == NULL)
+ valid_result = true;
+ break;
+ }
+
+ // Connection lost
+ if (result & GSOCK_LOST_FLAG)
+ {
+ m_connected = false;
+ m_establishing = false;
+ valid_result = ((flags & GSOCK_LOST_FLAG) != 0);
+ break;
+ }
+
+ // Wait more?
+ long time_left = wxMilliClockToLong(time_limit - wxGetLocalTimeMillis());
+ if ((!timeout) || (time_left <= 0) || (m_interrupt))
+ done = true;
+ else
+ {
+ if (has_event_loop)
{
- timer.Stop();
- return TRUE;
+ 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);
}
}
-
- wxYield();
}
- timer.Stop();
- return FALSE;
+ // Set timeout back to original value (we overwrote it for polling)
+ if (!has_event_loop)
+ m_socket->SetTimeout(m_timeout*1000);
+
+ return valid_result;
}
bool wxSocketBase::Wait(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG |
- GSOCK_OUTPUT_FLAG |
- GSOCK_CONNECTION_FLAG |
- GSOCK_LOST_FLAG);
+ 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, GSOCK_INPUT_FLAG);
+ // 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, GSOCK_OUTPUT_FLAG);
+ return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG);
}
bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG);
+ return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG);
}
-void wxSocketBase::SetTimeout(long seconds)
+// --------------------------------------------------------------------------
+// Miscellaneous
+// --------------------------------------------------------------------------
+
+//
+// Get local or peer address
+//
+
+bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
{
- m_timeout = seconds;
+ GAddress *peer;
- if (m_socket)
- GSocket_SetTimeout(m_socket, m_timeout);
-}
+ if (!m_socket)
+ return false;
-// --------------------------------------------------------------
-// wxSocketBase flags
-// --------------------------------------------------------------
+ peer = m_socket->GetPeer();
-void wxSocketBase::SetFlags(wxSockFlags _flags)
-{
- m_flags = _flags;
+ // copying a null address would just trigger an assert anyway
+
+ if (!peer)
+ return false;
+
+ addr_man.SetAddress(peer);
+ GAddress_destroy(peer);
+
+ return true;
}
-
-wxSocketBase::wxSockFlags wxSocketBase::GetFlags() const
+
+bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
{
- return m_flags;
+ GAddress *local;
+
+ if (!m_socket)
+ return false;
+
+ local = m_socket->GetLocal();
+ addr_man.SetAddress(local);
+ GAddress_destroy(local);
+
+ return true;
}
-// --------------------------------------------------------------
-// wxSocketBase callback management
-// --------------------------------------------------------------
+//
+// Save and restore socket state
+//
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
+void wxSocketBase::SaveState()
{
- wxSockCbk old_cbk = cbk_;
+ wxSocketState *state;
+
+ state = new wxSocketState();
- m_cbk = cbk_;
- return old_cbk;
+ state->m_flags = m_flags;
+ state->m_notify = m_notify;
+ state->m_eventmask = m_eventmask;
+ state->m_clientData = m_clientData;
+
+ m_states.Append(state);
}
-char *wxSocketBase::CallbackData(char *data)
+void wxSocketBase::RestoreState()
{
- char *old_data = m_cdata;
+ wxList::compatibility_iterator node;
+ wxSocketState *state;
- m_cdata = data;
- return old_data;
-}
+ node = m_states.GetLast();
+ if (!node)
+ return;
-// --------------------------------------------------------------
-// wxSocketBase automatic notifier
-// --------------------------------------------------------------
+ state = (wxSocketState *)node->GetData();
-static void LINKAGEMODE wx_socket_callback(GSocket *socket, GSocketEvent event, char *cdata)
-{
- wxSocketBase *sckobj = (wxSocketBase *)cdata;
+ m_flags = state->m_flags;
+ m_notify = state->m_notify;
+ m_eventmask = state->m_eventmask;
+ m_clientData = state->m_clientData;
- sckobj->OnRequest((wxSocketNotify)event);
+ m_states.Erase(node);
+ delete state;
}
-wxSocketEventFlags wxSocketBase::EventToNotify(wxSocketNotify evt)
+//
+// Timeout and flags
+//
+
+void wxSocketBase::SetTimeout(long seconds)
{
- switch (evt)
- {
- case GSOCK_INPUT: return GSOCK_INPUT_FLAG;
- case GSOCK_OUTPUT: return GSOCK_OUTPUT_FLAG;
- case GSOCK_CONNECTION: return GSOCK_CONNECTION_FLAG;
- case GSOCK_LOST: return GSOCK_LOST_FLAG;
- }
- return 0;
+ m_timeout = seconds;
+
+ if (m_socket)
+ m_socket->SetTimeout(m_timeout * 1000);
}
-void wxSocketBase::SetNotify(wxSocketEventFlags flags)
+void wxSocketBase::SetFlags(wxSocketFlags flags)
{
- m_neededreq = flags;
+ m_flags = flags;
}
-void wxSocketBase::Notify(bool notify)
+
+// --------------------------------------------------------------------------
+// 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)
{
- m_notify_state = notify;
+ wxSocketBase *sckobj = (wxSocketBase *)cdata;
+
+ sckobj->OnRequest((wxSocketNotify) notification);
}
-void wxSocketBase::OnRequest(wxSocketNotify req_evt)
+void wxSocketBase::OnRequest(wxSocketNotify notification)
{
- wxSocketEvent event(m_id);
- wxSocketEventFlags flag = EventToNotify(req_evt);
-
- // NOTE: this duplicates some of the code in _Wait (lost
- // connection and connection establishment handling) but
- // this doesn't hurt. It has to be here because maybe the
- // WaitXXX are not being used, and it has to be in _Wait
- // as well because the event might be a bit delayed.
- //
- switch(req_evt)
+ // 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;
- case wxSOCKET_LOST:
- m_defer_buffer = NULL;
- Close();
+ 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_defer_buffer)
- {
- // GRG: DoDefer() no longer needs to know which
- // event occured, because this was only used to
- // catch LOST events and set m_defer_buffer to
- // NULL, and this is done in OnRequest() now.
- DoDefer();
- // Do not notify to user
+ if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG))
return;
- }
+ break;
+
+ case wxSOCKET_LOST:
+ m_connected = false;
+ m_establishing = false;
+ break;
+
+ default:
break;
}
- if (((m_neededreq & flag) == flag) && m_notify_state)
+ // Schedule the event
+
+ wxSocketEventFlags flag = 0;
+ wxUnusedVar(flag);
+ switch (notification)
{
- event.m_socket = this;
- event.m_skevt = req_evt;
- ProcessEvent(event);
- OldOnNotify(req_evt);
+ 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_cbk)
- m_cbk(*this, req_evt, m_cdata);
+ 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);
+ }
}
}
-void wxSocketBase::OldOnNotify(wxSocketNotify evt)
+void wxSocketBase::Notify(bool notify)
{
+ m_notify = notify;
}
-// --------------------------------------------------------------
-// wxSocketBase set event handler
-// --------------------------------------------------------------
-
-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, wxUint32 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, wxUint32 size)
+// --------------------------------------------------------------------------
+// Pushback buffer
+// --------------------------------------------------------------------------
+
+void wxSocketBase::Pushback(const void *buffer, wxUint32 size)
{
+ if (!size) return;
+
if (m_unread == NULL)
- m_unread = (char *)malloc(size);
- else {
- char *tmp;
+ m_unread = malloc(size);
+ else
+ {
+ void *tmp;
- tmp = (char *)malloc(m_unrd_size + size);
- memcpy(tmp+size, 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;
memcpy(m_unread, buffer, size);
}
-wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek)
+wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek)
{
if (!m_unrd_size)
return 0;
if (size > (m_unrd_size-m_unrd_cur))
size = m_unrd_size-m_unrd_cur;
- memcpy(buffer, (m_unread+m_unrd_cur), size);
- if (!peek) {
+ memcpy(buffer, (char *)m_unread + m_unrd_cur, size);
+
+ if (!peek)
+ {
m_unrd_cur += size;
- if (m_unrd_size == m_unrd_cur) {
+ if (m_unrd_size == m_unrd_cur)
+ {
free(m_unread);
m_unread = NULL;
m_unrd_size = 0;
return size;
}
-// --------------------------------------------------------------
+
+// ==========================================================================
// wxSocketServer
-// --------------------------------------------------------------
+// ==========================================================================
-// --------------------------------------------------------------
-// wxSocketServer ctor and dtor
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Ctor
+// --------------------------------------------------------------------------
-wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
- wxSockFlags flags) :
- wxSocketBase(flags, SOCK_SERVER)
+wxSocketServer::wxSocketServer(const wxSockAddress& addr_man,
+ wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_SERVER)
{
- // Create the socket
- m_socket = GSocket_new();
+ wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") );
- if (!m_socket)
- return;
+ m_socket = GSocket_new();
- // Setup the socket as server
- GSocket_SetLocal(m_socket, addr_man.GetAddress());
- if (GSocket_SetServer(m_socket) != GSOCK_NOERROR)
- {
- GSocket_destroy(m_socket);
- m_socket = NULL;
- return;
- }
+ if (!m_socket)
+ {
+ wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") );
+ return;
+ }
- GSocket_SetTimeout(m_socket, m_timeout);
- GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
- GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
- wx_socket_callback, (char *)this);
+ // Setup the socket as server
+ m_socket->SetLocal(addr_man.GetAddress());
+
+ if (GetFlags() & wxSOCKET_REUSEADDR) {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST) {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND) {
+ m_socket->DontDoBind();
+ }
+
+ if (m_socket->SetServer() != GSOCK_NOERROR)
+ {
+ delete m_socket;
+ m_socket = NULL;
+
+ wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") );
+ 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);
}
-// --------------------------------------------------------------
-// wxSocketServer Accept
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Accept
+// --------------------------------------------------------------------------
bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
GSocket *child_socket;
if (!m_socket)
- return FALSE;
+ return false;
- // GRG: If wait == FALSE, then the call should be nonblocking.
+ // If wait == false, then the call should be nonblocking.
// When we are finished, we put the socket to blocking mode
// again.
if (!wait)
- GSocket_SetNonBlocking(m_socket, TRUE);
+ m_socket->SetNonBlocking(1);
- child_socket = GSocket_WaitConnection(m_socket);
+ child_socket = m_socket->WaitConnection();
if (!wait)
- GSocket_SetNonBlocking(m_socket, FALSE);
+ m_socket->SetNonBlocking(0);
- // GRG: this was not being handled!
- if (child_socket == NULL)
- return FALSE;
+ if (!child_socket)
+ return false;
- sock.m_type = SOCK_INTERNAL;
+ sock.m_type = wxSOCKET_BASE;
sock.m_socket = child_socket;
- sock.m_connected = TRUE;
+ sock.m_connected = true;
- GSocket_SetTimeout(sock.m_socket, sock.m_timeout);
- GSocket_SetCallback(sock.m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ 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;
+ return true;
}
wxSocketBase *wxSocketServer::Accept(bool wait)
{
wxSocketBase* sock = new wxSocketBase();
- sock->SetFlags((wxSockFlags)m_flags);
+ sock->SetFlags(m_flags);
if (!AcceptWith(*sock, wait))
- return NULL;
+ {
+ sock->Destroy();
+ sock = NULL;
+ }
return sock;
}
bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
+ return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
}
-// --------------------------------------------------------------
+bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
+{
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+
+ if (m_socket->GetSockOpt(level, optname, optval, optlen)
+ != GSOCK_NOERROR)
+ {
+ return false;
+ }
+ return true;
+}
+
+bool wxSocketBase::SetOption(int level, int optname, const void *optval,
+ int optlen)
+{
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+
+ if (m_socket->SetSockOpt(level, optname, optval, optlen)
+ != GSOCK_NOERROR)
+ {
+ return false;
+ }
+ return true;
+}
+
+bool wxSocketBase::SetLocal(wxIPV4address& local)
+{
+ GAddress* la = local.GetAddress();
+
+ // If the address is valid, save it for use when we call Connect
+ if (la && la->m_addr)
+ {
+ m_localAddress = local;
+
+ return true;
+ }
+
+ return false;
+}
+
+// ==========================================================================
// wxSocketClient
-// --------------------------------------------------------------
+// ==========================================================================
-// --------------------------------------------------------------
-// wxSocketClient ctor and dtor
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
-wxSocketClient::wxSocketClient(wxSockFlags _flags) :
- wxSocketBase(_flags, SOCK_CLIENT)
+wxSocketClient::wxSocketClient(wxSocketFlags flags)
+ : wxSocketBase(flags, wxSOCKET_CLIENT)
{
}
{
}
-// --------------------------------------------------------------
-// wxSocketClient Connect functions
-// --------------------------------------------------------------
-bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait)
+// --------------------------------------------------------------------------
+// Connect
+// --------------------------------------------------------------------------
+
+bool wxSocketClient::DoConnect(wxSockAddress& addr_man, wxSockAddress* local, bool wait)
{
GSocketError err;
- if (IsConnected())
- Close();
-
- // This should never happen.
if (m_socket)
- GSocket_destroy(m_socket);
+ {
+ // Shutdown and destroy the socket
+ Close();
+ delete m_socket;
+ }
- // Initialize all socket stuff ...
m_socket = GSocket_new();
- m_connected = FALSE;
- m_establishing = FALSE;
+ m_connected = false;
+ m_establishing = false;
if (!m_socket)
- return FALSE;
+ return false;
- GSocket_SetTimeout(m_socket, m_timeout);
+ 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);
- // GRG: If wait == FALSE, then the call should be nonblocking.
+ // If wait == false, then the call should be nonblocking.
// When we are finished, we put the socket to blocking mode
// again.
if (!wait)
- GSocket_SetNonBlocking(m_socket, TRUE);
+ m_socket->SetNonBlocking(1);
- GSocket_SetPeer(m_socket, addr_man.GetAddress());
- err = GSocket_Connect(m_socket, GSOCK_STREAMED);
- GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
- GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
- wx_socket_callback, (char *)this);
+ // Reuse makes sense for clients too, if we are trying to rebind to the same port
+ if (GetFlags() & wxSOCKET_REUSEADDR)
+ {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST)
+ {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND)
+ {
+ m_socket->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_socket->SetLocal(la);
+ }
+
+#if defined(__WXMSW__) || defined(__WXGTK__)
+ m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
+#endif
+
+ m_socket->SetPeer(addr_man.GetAddress());
+ err = m_socket->Connect(GSOCK_STREAMED);
if (!wait)
- GSocket_SetNonBlocking(m_socket, FALSE);
+ m_socket->SetNonBlocking(0);
if (err != GSOCK_NOERROR)
{
if (err == GSOCK_WOULDBLOCK)
- m_establishing = TRUE;
+ m_establishing = true;
- return FALSE;
+ return false;
}
- m_connected = TRUE;
- return TRUE;
+ m_connected = true;
+ return true;
+}
+
+bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait)
+{
+ return (DoConnect(addr_man, NULL, wait));
+}
+
+bool wxSocketClient::Connect(wxSockAddress& addr_man, wxSockAddress& local, bool wait)
+{
+ return (DoConnect(addr_man, &local, wait));
}
bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds)
{
- if (m_connected) // Already connected
- return TRUE;
+ if (m_connected) // Already connected
+ return true;
- if (!m_establishing || !m_socket) // No connection in progress
- return FALSE;
+ if (!m_establishing || !m_socket) // No connection in progress
+ return false;
- return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
+ return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG |
+ GSOCK_LOST_FLAG);
}
-// --------------------------------------------------------------
-// wxSocketEvent
-// --------------------------------------------------------------
+// ==========================================================================
+// wxDatagramSocket
+// ==========================================================================
-wxSocketEvent::wxSocketEvent(int id)
- : wxEvent(id)
+/* NOTE: experimental stuff - might change */
+
+wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
+ wxSocketFlags flags )
+ : wxSocketBase( flags, wxSOCKET_DATAGRAM )
{
- wxEventType type = (wxEventType)wxEVT_SOCKET;
+ // Create the socket
+ m_socket = GSocket_new();
- SetEventType(type);
+ if (!m_socket)
+ {
+ wxFAIL_MSG( _T("datagram socket not new'd") );
+ return;
+ }
+ // 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 wxSocketEvent::CopyObject(wxObject& obj_d) const
+wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr,
+ void* buf,
+ wxUint32 nBytes )
{
- wxSocketEvent *event = (wxSocketEvent *)&obj_d;
+ Read(buf, nBytes);
+ GetPeer(addr);
+ return (*this);
+}
- wxEvent::CopyObject(obj_d);
+wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr,
+ const void* buf,
+ wxUint32 nBytes )
+{
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
- event->m_skevt = m_skevt;
- event->m_socket = m_socket;
+ m_socket->SetPeer(addr.GetAddress());
+ Write(buf, nBytes);
+ return (*this);
}
-// --------------------------------------------------------------------------
+// ==========================================================================
// wxSocketModule
-// --------------------------------------------------------------------------
-class WXDLLEXPORT wxSocketModule: public wxModule {
- DECLARE_DYNAMIC_CLASS(wxSocketModule)
- public:
- bool OnInit() {
- return GSocket_Init();
- }
- void OnExit() {
- GSocket_Cleanup();
- }
+// ==========================================================================
+
+class wxSocketModule : public wxModule
+{
+public:
+ virtual bool OnInit()
+ {
+ // wxSocketBase will call GSocket_Init() itself when/if needed
+ return true;
+ }
+
+ virtual void OnExit()
+ {
+ if ( wxSocketBase::IsInitialized() )
+ wxSocketBase::Shutdown();
+ }
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxSocketModule)
};
IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
projects / wxWidgets.git / blobdiff