// License: see wxWindows license
/////////////////////////////////////////////////////////////////////////////
+// ==========================================================================
+// Declarations
+// ==========================================================================
+
#ifdef __GNUG__
#pragma implementation "socket.h"
#endif
#if wxUSE_SOCKETS
-// ==========================================================================
-// Headers and constants
-// ==========================================================================
-
#include "wx/app.h"
#include "wx/defs.h"
#include "wx/object.h"
#include "wx/module.h"
#include "wx/log.h"
#include "wx/intl.h"
+#include "wx/event.h"
#if wxUSE_GUI
- #include "wx/event.h"
- #include "wx/gdicmn.h" // for wxPendingDelete
+ #include "wx/gdicmn.h" // for wxPendingDelete
#endif // wxUSE_GUI
#include "wx/sckaddr.h"
#include "wx/socket.h"
+// --------------------------------------------------------------------------
+// macros and constants
+// --------------------------------------------------------------------------
// discard buffer
#define MAX_DISCARD_SIZE (10 * 1024)
// what to do within waits
-#define PROCESS_EVENTS() wxYield()
-
-// use wxPostEvent or not
-#define USE_DELAYED_EVENTS 1
+#if wxUSE_GUI
+ #define PROCESS_EVENTS() wxYield()
+#else
+ #define PROCESS_EVENTS()
+#endif
// --------------------------------------------------------------------------
-// ClassInfos
+// wxWin macros
// --------------------------------------------------------------------------
IMPLEMENT_CLASS(wxSocketBase, wxObject)
IMPLEMENT_CLASS(wxDatagramSocket, wxSocketBase)
IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent, wxEvent)
+// --------------------------------------------------------------------------
+// private classes
+// --------------------------------------------------------------------------
+
class wxSocketState : public wxObject
{
public:
- bool m_notify_state;
- wxSocketEventFlags m_neededreq;
wxSocketFlags m_flags;
+ wxSocketEventFlags m_eventmask;
+ bool m_notify;
+ void *m_clientData;
+#if WXWIN_COMPATIBILITY
wxSocketBase::wxSockCbk m_cbk;
char *m_cdata;
+#endif // WXWIN_COMPATIBILITY
public:
wxSocketState() : wxObject() {}
};
-
// ==========================================================================
// wxSocketBase
// ==========================================================================
m_unrd_cur = 0;
// events
- m_handler = NULL;
m_id = -1;
- m_notify_state = FALSE;
- m_neededreq = 0;
+ m_handler = NULL;
+ m_clientData = NULL;
+ m_notify = FALSE;
+ m_eventmask = 0;
+#if WXWIN_COMPATIBILITY
m_cbk = NULL;
m_cdata = NULL;
+#endif // WXWIN_COMPATIBILITY
}
-wxSocketBase::wxSocketBase() { Init(); }
+wxSocketBase::wxSocketBase()
+{
+ Init();
+}
wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
{
// Shutdown and close the socket
Close();
+ // Supress events from now on
+ Notify(FALSE);
+
#if wxUSE_GUI
- if ( wxPendingDelete.Member(this) )
- wxPendingDelete.Append(this);
+ if ( !wxPendingDelete.Member(this) )
+ wxPendingDelete.Append(this);
#else
delete this;
#endif
return TRUE;
}
-
// --------------------------------------------------------------------------
-// Basic IO operations
+// Basic IO calls
// --------------------------------------------------------------------------
// The following IO operations update m_error and m_lcount:
bool wxSocketBase::Close()
{
// Interrupt pending waits
- InterruptAllWaits();
+ InterruptWait();
if (m_socket)
{
return TRUE;
}
-wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
{
// Mask read events
m_reading = TRUE;
return *this;
}
-wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes)
+wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
{
int total;
int ret = 1;
// Try the pushback buffer first
total = GetPushback(buffer, nbytes, FALSE);
nbytes -= total;
- buffer += total;
-
- // If the socket is invalid or we got all the data, return now
- if (!m_socket || !nbytes)
+ buffer = (char *)buffer + total;
+
+ // Return now in one of the following cases:
+ // - the socket is invalid,
+ // - we got all the data,
+ // - we got *some* data and we are not using wxSOCKET_WAITALL.
+ if ( !m_socket ||
+ !nbytes ||
+ ((total != 0) && !(m_flags & wxSOCKET_WAITALL)) )
return total;
// Possible combinations (they are checked in this order)
// wxSOCKET_NOWAIT
- // wxSOCKET_WAITALL | wxSOCKET_BLOCK
- // wxSOCKET_WAITALL
+ // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
// wxSOCKET_BLOCK
// wxSOCKET_NONE
//
if (m_flags & wxSOCKET_NOWAIT)
{
- GSocket_SetNonBlocking(m_socket, TRUE);
- ret = GSocket_Read(m_socket, buffer, nbytes);
- GSocket_SetNonBlocking(m_socket, FALSE);
+ GSocket_SetNonBlocking(m_socket, 1);
+ ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
+ GSocket_SetNonBlocking(m_socket, 0);
if (ret > 0)
total += ret;
}
- else if (m_flags & wxSOCKET_WAITALL)
+ else
{
- while (ret > 0 && nbytes > 0)
+ bool more = TRUE;
+
+ while (more)
{
- if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead())
- break;
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() )
+ break;
- ret = GSocket_Read(m_socket, buffer, nbytes);
+ ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
if (ret > 0)
{
total += ret;
- buffer += ret;
nbytes -= ret;
+ buffer = (char *)buffer + ret;
}
- }
- }
- else
- {
- if ((m_flags & wxSOCKET_BLOCK) || WaitForRead())
- {
- ret = GSocket_Read(m_socket, buffer, nbytes);
- if (ret > 0)
- total += 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 total;
}
-wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
{
wxUint32 len, len2, sig, total;
bool error;
old_flags = m_flags;
SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
- if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg))
+ if (_Read(&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( _("wxSocket: invalid signature in ReadMsg."));
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
goto exit;
}
if (len2 != 0)
goto exit;
}
- if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg))
+ if (_Read(&msg, sizeof(msg)) != sizeof(msg))
goto exit;
sig = (wxUint32)msg.sig[0];
if (sig != 0xdeadfeed)
{
- wxLogWarning( _("wxSocket: invalid signature in ReadMsg."));
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
goto exit;
}
return *this;
}
-wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
// Mask read events
m_reading = TRUE;
return *this;
}
-wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
{
// Mask write events
m_writing = TRUE;
return *this;
}
-wxUint32 wxSocketBase::_Write(const char *buffer, wxUint32 nbytes)
+wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
{
wxUint32 total = 0;
int ret = 1;
- // If the socket is invalid, return immediately
- if (!m_socket)
+ // 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)
// wxSOCKET_NOWAIT
- // wxSOCKET_WAITALL | wxSOCKET_BLOCK
- // wxSOCKET_WAITALL
+ // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
// wxSOCKET_BLOCK
// wxSOCKET_NONE
//
if (m_flags & wxSOCKET_NOWAIT)
{
- GSocket_SetNonBlocking(m_socket, TRUE);
- ret = GSocket_Write(m_socket, buffer, nbytes);
- GSocket_SetNonBlocking(m_socket, FALSE);
+ GSocket_SetNonBlocking(m_socket, 1);
+ ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);
+ GSocket_SetNonBlocking(m_socket, 0);
if (ret > 0)
total = ret;
}
- else if (m_flags & wxSOCKET_WAITALL)
+ else
{
- while (ret > 0 && nbytes > 0)
+ bool more = TRUE;
+
+ while (more)
{
- if (!(m_flags & wxSOCKET_BLOCK) && !WaitForWrite())
- break;
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
+ break;
- ret = GSocket_Write(m_socket, buffer, nbytes);
+ ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);
if (ret > 0)
{
total += ret;
- buffer += ret;
nbytes -= ret;
+ buffer = (const char *)buffer + ret;
}
- }
- }
- else
- {
- if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite())
- {
- ret = GSocket_Write(m_socket, buffer, nbytes);
- if (ret > 0)
- total = 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));
}
}
return total;
}
-wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
{
wxUint32 total;
bool error;
int old_flags;
- struct {
+ struct
+ {
unsigned char sig[4];
unsigned char len[4];
} msg;
msg.len[2] = (unsigned char) ((nbytes >> 16) & 0xff);
msg.len[3] = (unsigned char) ((nbytes >> 24) & 0xff);
- if (_Write((char *)&msg, sizeof(msg)) < sizeof(msg))
+ if (_Write(&msg, sizeof(msg)) < sizeof(msg))
goto exit;
total = _Write(buffer, nbytes);
msg.sig[3] = (unsigned char) 0xde;
msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = (char) 0;
- if ((_Write((char *)&msg, sizeof(msg))) < sizeof(msg))
+ if ((_Write(&msg, sizeof(msg))) < sizeof(msg))
goto exit;
// everything was OK
return *this;
}
-wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes)
+wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
{
if (nbytes != 0)
Pushback(buffer, nbytes);
// timeout elapses. The polling loop calls PROCESS_EVENTS(), so
// this won't block the GUI.
-bool wxSocketBase::_Wait(long seconds, long milliseconds,
+bool wxSocketBase::_Wait(long seconds,
+ long milliseconds,
wxSocketEventFlags flags)
{
GSocketEventFlags result;
else
timeout = m_timeout * 1000;
- // 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 Wait 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.
//
// Do this at least once (important if timeout == 0, when
// we are just polling). Also, if just polling, do not yield.
{
m_connected = FALSE;
m_establishing = FALSE;
- return (flags & GSOCK_LOST_FLAG);
+ return (flags & GSOCK_LOST_FLAG) != 0;
}
// Wait more?
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;
+ state->m_flags = m_flags;
+ state->m_notify = m_notify;
+ state->m_eventmask = m_eventmask;
+ state->m_clientData = m_clientData;
+#if WXWIN_COMPATIBILITY
+ state->m_cbk = m_cbk;
+ state->m_cdata = m_cdata;
+#endif // WXWIN_COMPATIBILITY
m_states.Append(state);
}
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);
+ m_flags = state->m_flags;
+ m_notify = state->m_notify;
+ m_eventmask = state->m_eventmask;
+ m_clientData = state->m_clientData;
+#if WXWIN_COMPATIBILITY
+ m_cbk = state->m_cbk;
+ m_cdata = state->m_cdata;
+#endif // WXWIN_COMPATIBILITY
delete node;
delete state;
m_flags = flags;
}
+
// --------------------------------------------------------------------------
// Callbacks (now obsolete - use events instead)
// --------------------------------------------------------------------------
+#if WXWIN_COMPATIBILITY
+
wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
{
wxSockCbk old_cbk = cbk_;
return old_data;
}
+#endif // WXWIN_COMPATIBILITY
+
// --------------------------------------------------------------------------
-// Event system
+// Event handling
// --------------------------------------------------------------------------
-// All events (INPUT, OUTPUT, CONNECTION, LOST) are now always
-// internally watched; but users will only be notified of those
-// events they are interested in.
+// 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.
static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
- GSocketEvent event,
+ GSocketEvent notification,
char *cdata)
{
wxSocketBase *sckobj = (wxSocketBase *)cdata;
- sckobj->OnRequest((wxSocketNotify)event);
-}
-
-void wxSocketBase::SetNotify(wxSocketEventFlags flags)
-{
- m_neededreq = flags;
-}
-
-void wxSocketBase::Notify(bool notify)
-{
- m_notify_state = notify;
+ sckobj->OnRequest((wxSocketNotify) notification);
}
-void wxSocketBase::OnRequest(wxSocketNotify req_evt)
+void wxSocketBase::OnRequest(wxSocketNotify notification)
{
- wxSocketEventFlags flag = -1;
-
- switch (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;
- }
-
- // 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.
+ // 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(req_evt)
+ switch(notification)
{
case wxSOCKET_CONNECTION:
m_establishing = FALSE;
break;
}
- if (((m_neededreq & flag) == flag) && m_notify_state)
+ // Schedule the event
+
+ wxSocketEventFlags flag = 0;
+ 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_socket = this;
- event.m_event = req_evt;
+ event.m_event = notification;
+ event.m_clientData = m_clientData;
+ event.SetEventObject(this);
-#if USE_DELAYED_EVENTS
- wxPostEvent(m_handler, event);
-#else
- m_handler->ProcessEvent(event);
-#endif
+ m_handler->AddPendingEvent(event);
}
+#if WXWIN_COMPATIBILITY
if (m_cbk)
- m_cbk(*this, req_evt, m_cdata);
+ m_cbk(*this, notification, m_cdata);
+#endif // WXWIN_COMPATIBILITY
}
}
+void wxSocketBase::Notify(bool notify)
+{
+ m_notify = notify;
+}
+
+void wxSocketBase::SetNotify(wxSocketEventFlags flags)
+{
+ m_eventmask = flags;
+}
+
void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
{
m_handler = &handler;
// Pushback buffer
// --------------------------------------------------------------------------
-void wxSocketBase::Pushback(const char *buffer, wxUint32 size)
+void wxSocketBase::Pushback(const void *buffer, wxUint32 size)
{
if (!size) return;
if (m_unread == NULL)
- m_unread = (char *)malloc(size);
+ m_unread = malloc(size);
else
{
- char *tmp;
+ 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);
+ memcpy(buffer, (char *)m_unread + m_unrd_cur, size);
if (!peek)
{
return size;
}
+
// ==========================================================================
-// wxSocketServer
+// wxSocketServer
// ==========================================================================
// --------------------------------------------------------------------------
// again.
if (!wait)
- GSocket_SetNonBlocking(m_socket, TRUE);
+ GSocket_SetNonBlocking(m_socket, 1);
child_socket = GSocket_WaitConnection(m_socket);
if (!wait)
- GSocket_SetNonBlocking(m_socket, FALSE);
+ GSocket_SetNonBlocking(m_socket, 0);
if (!child_socket)
return FALSE;
// again.
if (!wait)
- GSocket_SetNonBlocking(m_socket, TRUE);
+ GSocket_SetNonBlocking(m_socket, 1);
GSocket_SetPeer(m_socket, addr_man.GetAddress());
err = GSocket_Connect(m_socket, GSOCK_STREAMED);
if (!wait)
- GSocket_SetNonBlocking(m_socket, FALSE);
+ GSocket_SetNonBlocking(m_socket, 0);
if (err != GSOCK_NOERROR)
{
}
wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr,
- char* buf,
+ void* buf,
wxUint32 nBytes )
{
Read(buf, nBytes);
}
wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr,
- const char* buf,
+ const void* buf,
wxUint32 nBytes )
{
GSocket_SetPeer(m_socket, addr.GetAddress());
wxEvent::CopyObject(object_dest);
- event->m_event = m_event;
- event->m_socket = m_socket;
+ event->m_event = m_event;
+ event->m_clientData = m_clientData;
}
-
// ==========================================================================
// wxSocketModule
// ==========================================================================
-class WXDLLEXPORT wxSocketModule: public wxModule
+class WXDLLEXPORT wxSocketModule : public wxModule
{
DECLARE_DYNAMIC_CLASS(wxSocketModule)
public:
- bool OnInit() { return GSocket_Init(); }
+ bool OnInit() { return GSocket_Init() != 0; }
void OnExit() { GSocket_Cleanup(); }
};
projects / wxWidgets.git / blobdiff