#if wxUSE_SOCKETS
-/////////////////////////////////////////////////////////////////////////////
-// wxWindows headers
-/////////////////////////////////////////////////////////////////////////////
+// ==========================================================================
+// Headers and constants
+// ==========================================================================
#include "wx/app.h"
#include "wx/defs.h"
#include "wx/module.h"
#include "wx/log.h"
#include "wx/intl.h"
-
-/////////////////////////////////////////////////////////////////////////////
-// wxSocket headers
-/////////////////////////////////////////////////////////////////////////////
+#include "wx/gdicmn.h" // for wxPendingDelete
#include "wx/sckaddr.h"
#include "wx/socket.h"
+
// discard buffer
#define MAX_DISCARD_SIZE (10 * 1024)
#define PROCESS_EVENTS() wxYield()
// use wxPostEvent or not
-#define EXPERIMENTAL_USE_POST 1
+#define USE_DELAYED_EVENTS 1
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
// ClassInfos
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
IMPLEMENT_CLASS(wxSocketBase, wxObject)
IMPLEMENT_CLASS(wxSocketServer, wxSocketBase)
{
public:
bool m_notify_state;
- GSocketEventFlags m_neededreq;
+ wxSocketEventFlags m_neededreq;
wxSockFlags m_flags;
wxSocketBase::wxSockCbk m_cbk;
char *m_cdata;
wxSocketState() : wxObject() {}
};
-// --------------------------------------------------------------
-// wxSocketBase ctor and dtor
-// --------------------------------------------------------------
+
+// ==========================================================================
+// wxSocketBase
+// ==========================================================================
+
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
wxSocketBase::wxSocketBase(wxSockFlags _flags, wxSockType _type) :
wxEvtHandler(),
GSocket_destroy(m_socket);
}
+/*
+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;
+ Close();
+
+ if ( !wxPendingDelete.Member(this) )
+ wxPendingDelete.Append(this);
+
+ return TRUE;
+}
+*/
+
+// --------------------------------------------------------------------------
+// Basic IO operations
+// --------------------------------------------------------------------------
+
+// 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()
{
// Interrupt pending waits
// Shutdown the connection
GSocket_Shutdown(m_socket);
- m_connected = FALSE;
- m_establishing = FALSE;
}
+ m_connected = FALSE;
+ m_establishing = FALSE;
return TRUE;
}
-// --------------------------------------------------------------
-// wxSocketBase basic IO operations
-// --------------------------------------------------------------
-
-// All IO operations {Read, Write, ReadMsg, WriteMsg, Peek,
-// Unread, Discard} update m_error and m_lcount.
-//
-// TODO: Should Connect, Accept and AcceptWith update m_error?
-
-class _wxSocketInternalTimer: public wxTimer
-{
-public:
- int *m_state;
- unsigned long m_new_val;
-
- void Notify()
- {
- *m_state = (int)m_new_val; // Change the value
- }
-};
-
wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes)
{
// Mask read events
int total;
int ret = 1;
- // we try this even if the connection has already been closed.
+ // Try the pushback buffer first
total = GetPushback(buffer, nbytes, FALSE);
nbytes -= total;
buffer += total;
- // If the socket is not connected, or we have got the whole
- // needed buffer, return immedately
- if (!m_socket || !m_connected || !nbytes)
+ // If the socket is invalid or we got all the data, return now
+ if (!m_socket || !nbytes)
return total;
// Possible combinations (they are checked in this order)
if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg))
goto exit;
- sig = (wxUint32)msg.sig[0];
+ 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( _("TCP: invalid signature returned to ReadMsg."));
+ wxLogWarning( _("wxSocket: invalid signature in ReadMsg."));
goto exit;
}
len |= (wxUint32)(msg.len[2] << 16);
len |= (wxUint32)(msg.len[3] << 24);
- //wxLogMessage("Readmsg: %d %d %d %d -> len == %d",
- // msg.len[0], msg.len[1], msg.len[2], msg.len[3], len);
-
if (len > nbytes)
{
len2 = len - nbytes;
else
len2 = 0;
- // This check is necessary so that we don't attemp to read if
- // the msg was zero bytes long.
+ // Don't attemp to read if the msg was zero bytes long.
if (len)
{
total = _Read(buffer, len);
if (sig != 0xdeadfeed)
{
- //wxLogMessage(wxT("Warning: invalid signature returned to ReadMsg"));
+ wxLogWarning( _("wxSocket: invalid signature in ReadMsg."));
goto exit;
}
wxUint32 total = 0;
int ret = 1;
- if (!m_connected || !m_socket)
+ // If the socket is invalid, return immediately
+ if (!m_socket)
return 0;
// Possible combinations (they are checked in this order)
old_flags = m_flags;
SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
- // warning about 'cast truncates constant value'
-#ifdef __VISUALC__
-# pragma warning(disable: 4310)
-#endif // __VISUALC__
-
msg.sig[0] = (unsigned char) 0xad;
msg.sig[1] = (unsigned char) 0xde;
msg.sig[2] = (unsigned char) 0xed;
msg.sig[3] = (unsigned char) 0xfe;
- msg.len[0] = (unsigned char) nbytes & 0xff;
- msg.len[1] = (unsigned char) (nbytes >> 8) & 0xff;
- msg.len[2] = (unsigned char) (nbytes >> 16) & 0xff;
- msg.len[3] = (unsigned char) (nbytes >> 24) & 0xff;
-
- //wxLogMessage("Writemsg: %d %d %d %d -> %d",
- // nbytes & 0xff,
- // (nbytes >> 8) & 0xff,
- // (nbytes >> 16) & 0xff,
- // (nbytes >> 24) & 0xff,
- // nbytes
- // );
+ 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)) < sizeof(msg))
goto exit;
m_writing = FALSE;
return *this;
-
-#ifdef __VISUALC__
-# pragma warning(default: 4310)
-#endif // __VISUALC__
}
wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes)
wxSocketBase& wxSocketBase::Discard()
{
int old_flags;
- char *my_data = new char[MAX_DISCARD_SIZE];
- wxUint32 recv_size = MAX_DISCARD_SIZE;
+ char *buffer = new char[MAX_DISCARD_SIZE];
+ wxUint32 ret;
wxUint32 total = 0;
// Mask read events
old_flags = m_flags;
SetFlags(wxSOCKET_NOWAIT);
- while (recv_size == MAX_DISCARD_SIZE)
+ do
{
- recv_size = _Read(my_data, MAX_DISCARD_SIZE);
- total += recv_size;
+ ret = _Read(buffer, MAX_DISCARD_SIZE);
+ total += ret;
}
+ while (ret == MAX_DISCARD_SIZE);
- delete [] my_data;
+ delete[] buffer;
m_lcount = total;
- m_error = FALSE;
+ m_error = FALSE;
// Allow read events again
m_reading = FALSE;
return *this;
}
-// --------------------------------------------------------------
-// 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->m_notify_state = m_notify_state;
- state->m_neededreq = m_neededreq;
- state->m_flags = m_flags;
- state->m_cbk = m_cbk;
- state->m_cdata = m_cdata;
+// --------------------------------------------------------------------------
+// Wait functions
+// --------------------------------------------------------------------------
- m_states.Append(state);
-}
+// 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.
-void wxSocketBase::RestoreState()
+class _wxSocketInternalTimer: public wxTimer
{
- wxNode *node;
- wxSocketState *state;
-
- node = m_states.Last();
- if (!node)
- return;
-
- state = (wxSocketState *)node->Data();
-
- SetFlags(state->m_flags);
- m_cbk = state->m_cbk;
- m_cdata = state->m_cdata;
- m_neededreq = state->m_neededreq;
- Notify(state->m_notify_state);
-
- delete node;
- delete state;
-}
-
+public:
+ int *m_state;
+ unsigned long m_new_val;
-// --------------------------------------------------------------
-// wxSocketBase Wait functions
-// --------------------------------------------------------------
+ void Notify()
+ {
+ *m_state = (int)m_new_val; // Change the value
+ }
+};
-// These WaitXXX unctions do not depend on the event system any
-// longer; 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 PROCESS_EVENTS(), so this won't block the GUI.
-//
-// XXX: Should it honour the wxSOCKET_BLOCK flag ?
-//
-bool wxSocketBase::_Wait(long seconds,
- long milliseconds,
+bool wxSocketBase::_Wait(long seconds, long milliseconds,
wxSocketEventFlags flags)
{
GSocketEventFlags result;
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;
-
// Check for valid timeout value
if (seconds != -1)
timeout = seconds * 1000 + milliseconds;
// Active polling (without using events)
//
// 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.
+ // 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 Wait functions are not being
+ // used.
//
// Do this at least once (important if timeout == 0, when
// we are just polling). Also, if just polling, do not yield.
- //
+
while (state == -1)
{
result = GSocket_Select(m_socket, flags | GSOCK_LOST_FLAG);
- // The order in which we check events is important; in particular,
- // GSOCKET_LOST events should be checked last (there might be still
- // data to read in the incoming queue even after the peer has closed
- // the connection).
-
// Incoming connection (server) or connection established (client)
if (result & GSOCK_CONNECTION_FLAG)
{
return TRUE;
}
- // Input and output
+ // Data available or output buffer ready
if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG))
{
timer.Stop();
if (result & GSOCK_LOST_FLAG)
{
timer.Stop();
- Close();
- return TRUE;
+ m_connected = FALSE;
+ m_establishing = FALSE;
+ return (flags & GSOCK_LOST_FLAG);
}
// Wait more?
bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
{
- // Check pushback buffer
+ // Check pushback buffer before entering _Wait
if (m_unread)
return TRUE;
- return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG);
+ // Note that GSOCK_INPUT_LOST has to be explicitly passed to
+ // _Wait becuase 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_LOST_FLAG);
}
+// --------------------------------------------------------------------------
+// Miscellaneous
+// --------------------------------------------------------------------------
+
+//
+// Get local or peer address
+//
+
+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;
+}
+
+//
+// Save and restore socket state
+//
+
+void wxSocketBase::SaveState()
+{
+ wxSocketState *state;
+
+ state = new wxSocketState();
+
+ state->m_notify_state = m_notify_state;
+ state->m_neededreq = m_neededreq;
+ state->m_flags = m_flags;
+ state->m_cbk = m_cbk;
+ state->m_cdata = m_cdata;
+
+ m_states.Append(state);
+}
+
+void wxSocketBase::RestoreState()
+{
+ wxNode *node;
+ wxSocketState *state;
+
+ node = m_states.Last();
+ if (!node)
+ return;
+
+ state = (wxSocketState *)node->Data();
+
+ SetFlags(state->m_flags);
+ m_cbk = state->m_cbk;
+ m_cdata = state->m_cdata;
+ m_neededreq = state->m_neededreq;
+ Notify(state->m_notify_state);
+
+ delete node;
+ delete state;
+}
+
+//
+// Timeout and flags
+//
+
void wxSocketBase::SetTimeout(long seconds)
{
m_timeout = seconds;
GSocket_SetTimeout(m_socket, m_timeout * 1000);
}
-// --------------------------------------------------------------
-// wxSocketBase flags
-// --------------------------------------------------------------
-
void wxSocketBase::SetFlags(wxSockFlags _flags)
{
m_flags = _flags;
}
-// --------------------------------------------------------------
-// wxSocketBase callback management
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Callbacks (now obsolete - use events instead)
+// --------------------------------------------------------------------------
wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
{
return old_data;
}
-// --------------------------------------------------------------
-// wxSocketBase automatic notifier
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Event system
+// --------------------------------------------------------------------------
// All events (INPUT, OUTPUT, CONNECTION, LOST) are now always
// internally watched; but users will only be notified of those
// events they are interested in.
static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
- GSocketEvent event, char *cdata)
+ GSocketEvent event,
+ char *cdata)
{
wxSocketBase *sckobj = (wxSocketBase *)cdata;
wxSocketEvent event(m_id);
wxSocketEventFlags flag = EventToNotify(req_evt);
- // dbg("Entering OnRequest (evt %d)\n", req_evt);
+ // This duplicates some code in _Wait, but this doesn't
+ // hurt. It has to be here because we don't know whether
+ // the Wait functions will be used, and it has to be in
+ // _Wait as well because the event might be a bit delayed.
- switch (req_evt)
+ switch(req_evt)
{
- // This duplicates some code in _Wait(), but this doesn't hurt.
- // It has to be here because we don't know whether the Wait()
- // functions will be used, and it has to be in _Wait as well
- // because the event might be a bit delayed.
- //
- // The order in which we check events is important; in particular,
- // GSOCKET_LOST events should be checked last (there might be still
- // data to read in the incoming queue even after the peer has
- // closed the connection).
-
- case wxSOCKET_CONNECTION :
+ 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 || !GSocket_Select(m_socket, GSOCK_INPUT_FLAG))
return;
- else
- break;
+ break;
case wxSOCKET_OUTPUT:
if (m_writing || !GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG))
return;
- else
- break;
+ break;
case wxSOCKET_LOST:
- Close();
+ m_connected = FALSE;
+ m_establishing = FALSE;
+ break;
+
+ default:
break;
}
if (((m_neededreq & flag) == flag) && m_notify_state)
{
- // dbg("Evt %d delivered\n", req_evt);
event.m_socket = this;
event.m_skevt = req_evt;
if (m_evt_handler)
-#if EXPERIMENTAL_USE_POST
+#if USE_DELAYED_EVENTS
wxPostEvent(m_evt_handler, event);
#else
ProcessEvent(event);
OldOnNotify(req_evt);
if (m_cbk)
m_cbk(*this, req_evt, m_cdata);
-
}
-
- // dbg("Exiting OnRequest (evt %d)\n", req_evt);
}
void wxSocketBase::OldOnNotify(wxSocketNotify WXUNUSED(evt))
{
}
-// --------------------------------------------------------------
-// wxSocketBase set event handler
-// --------------------------------------------------------------
-
void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id)
{
m_evt_handler = &h_evt;
SetNextHandler(&h_evt);
}
-// --------------------------------------------------------------
-// wxSocketBase pushback
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Pushback buffer
+// --------------------------------------------------------------------------
void wxSocketBase::Pushback(const char *buffer, wxUint32 size)
{
return size;
}
-// --------------------------------------------------------------
+// ==========================================================================
// wxSocketServer
-// --------------------------------------------------------------
+// ==========================================================================
-// --------------------------------------------------------------
-// wxSocketServer ctor and dtor
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Ctor
+// --------------------------------------------------------------------------
wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
- wxSockFlags flags) :
- wxSocketBase(flags, SOCK_SERVER)
+ wxSockFlags flags)
+ : wxSocketBase(flags, SOCK_SERVER)
{
// Create the socket
m_socket = GSocket_new();
}
-// --------------------------------------------------------------
-// wxSocketServer Accept
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Accept
+// --------------------------------------------------------------------------
bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
if (!m_socket)
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, FALSE);
- // GRG: this was not being handled!
- if (child_socket == NULL)
+ if (!child_socket)
return FALSE;
sock.m_type = SOCK_INTERNAL;
return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
}
-// --------------------------------------------------------------
+// ==========================================================================
// wxSocketClient
-// --------------------------------------------------------------
+// ==========================================================================
-// --------------------------------------------------------------
-// wxSocketClient ctor and dtor
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Ctor and dtor
+// --------------------------------------------------------------------------
-wxSocketClient::wxSocketClient(wxSockFlags _flags) :
- wxSocketBase(_flags, SOCK_CLIENT)
+wxSocketClient::wxSocketClient(wxSockFlags _flags)
+ : wxSocketBase(_flags, SOCK_CLIENT)
{
}
+// XXX: What is this for ?
wxSocketClient::~wxSocketClient()
{
}
-// --------------------------------------------------------------
-// wxSocketClient Connect functions
-// --------------------------------------------------------------
+// --------------------------------------------------------------------------
+// Connect
+// --------------------------------------------------------------------------
bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait)
{
GSocketError err;
- if (IsConnected())
- Close();
-
- // This should never happen.
if (m_socket)
+ {
+ // Shutdown and destroy the socket
+ Close();
GSocket_destroy(m_socket);
+ }
- // Initialize all socket stuff ...
m_socket = GSocket_new();
m_connected = FALSE;
m_establishing = FALSE;
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.
return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
}
-// --------------------------------------------------------------
+// ==========================================================================
// wxDatagramSocket
-// --------------------------------------------------------------
+// ==========================================================================
/* NOTE: experimental stuff - might change */
return (*this);
}
-// --------------------------------------------------------------
+// ==========================================================================
// wxSocketEvent
-// --------------------------------------------------------------
+// ==========================================================================
+
+// XXX: Should be moved to event.cpp ?
wxSocketEvent::wxSocketEvent(int id)
- : wxEvent(id)
+ : wxEvent(id)
{
wxEventType type = (wxEventType)wxEVT_SOCKET;
event->m_socket = m_socket;
}
-// --------------------------------------------------------------------------
+// ==========================================================================
// wxSocketModule
-// --------------------------------------------------------------------------
+// ==========================================================================
class WXDLLEXPORT wxSocketModule: public wxModule
{
DECLARE_DYNAMIC_CLASS(wxSocketModule)
+
public:
- bool OnInit()
- {
- return GSocket_Init();
- }
- void OnExit()
- {
- GSocket_Cleanup();
- }
+ bool OnInit() { return GSocket_Init(); }
+ void OnExit() { GSocket_Cleanup(); }
};
IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)