X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dbd300df5c4abfd161e3cc233e87a0a71f544cbe..058939fc084207e06d34a2c82f4c62a103516dd8:/src/common/socket.cpp?ds=sidebyside diff --git a/src/common/socket.cpp b/src/common/socket.cpp index 08af3c1959..98ce67a4b9 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -1,13 +1,14 @@ -//////////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// // Name: socket.cpp // Purpose: Socket handler classes -// Authors: Guilhem Lavaux +// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia // Created: April 1997 -// Updated: July 1999 -// Copyright: (C) 1999, 1998, 1997, Guilhem Lavaux +// Copyright: (C) 1999-1997, Guilhem Lavaux +// (C) 2000-1999, Guillermo Rodriguez Garcia // RCS_ID: $Id$ // License: see wxWindows license -//////////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// + #ifdef __GNUG__ #pragma implementation "socket.h" #endif @@ -21,414 +22,665 @@ #if wxUSE_SOCKETS -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// -#include -#include -#include -#include -#include -#include +// ========================================================================== +// Headers and constants +// ========================================================================== -#include -#include -#include +#include "wx/app.h" +#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 "wx/intl.h" +#include "wx/gdicmn.h" // for wxPendingDelete -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// -#include -#include -#include +#include "wx/sckaddr.h" +#include "wx/socket.h" + + +// 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 -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- // 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 -class wxSocketState : public wxObject { +class wxSocketState : public wxObject +{ public: - bool notify_state; - GSocketEventFlags evt_notify_state; - wxSocketBase::wxSockFlags socket_flags; - wxSocketBase::wxSockCbk c_callback; - char *c_callback_data; + bool m_notify_state; + wxSocketEventFlags m_neededreq; + wxSockFlags m_flags; + wxSocketBase::wxSockCbk m_cbk; + char *m_cdata; public: wxSocketState() : wxObject() {} }; -// -------------------------------------------------------------- -// --------- wxSocketBase CONSTRUCTOR --------------------------- -// -------------------------------------------------------------- -wxSocketBase::wxSocketBase(wxSocketBase::wxSockFlags _flags, - wxSocketBase::wxSockType _type) : + +// ========================================================================== +// wxSocketBase +// ========================================================================== + +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- + +wxSocketBase::wxSocketBase(wxSockFlags _flags, wxSockType _type) : wxEvtHandler(), - m_socket(NULL), m_flags(_flags), m_type(_type), - m_neededreq(GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG), - m_lcount(0), m_timeout(3600), + m_socket(NULL), m_evt_handler(NULL), m_id(-1), + m_flags(_flags), m_type(_type), + m_neededreq(0), m_notify_state(FALSE), + m_connected(FALSE), m_establishing(FALSE), + m_reading(FALSE), m_writing(FALSE), + m_error(FALSE), m_lcount(0), m_timeout(600), m_states(), m_unread(NULL), m_unrd_size(0), m_unrd_cur(0), - m_cbk(NULL), m_cdata(NULL), - m_connected(FALSE), m_notify_state(FALSE), m_id(-1), - m_defering(NO_DEFER), - m_states() + m_cbk(NULL), m_cdata(NULL) { } wxSocketBase::wxSocketBase() : wxEvtHandler(), - m_socket(NULL), m_flags(SPEED | WAITALL), m_type(SOCK_UNINIT), - m_neededreq(GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG), - m_lcount(0), m_timeout(3600), + m_socket(NULL), m_evt_handler(NULL), m_id(-1), + m_flags(NONE), m_type(SOCK_UNINIT), + m_neededreq(0), m_notify_state(FALSE), + m_connected(FALSE), m_establishing(FALSE), + m_reading(FALSE), m_writing(FALSE), + m_error(FALSE), m_lcount(0), m_timeout(600), m_states(), m_unread(NULL), m_unrd_size(0), m_unrd_cur(0), - m_cbk(NULL), m_cdata(NULL), - m_connected(FALSE), m_notify_state(FALSE), m_id(-1), - m_defering(NO_DEFER), - m_states() + m_cbk(NULL), m_cdata(NULL) { } -// -------------------------------------------------------------- -// wxSocketBase destructor -// -------------------------------------------------------------- - wxSocketBase::~wxSocketBase() { if (m_unread) free(m_unread); - // At last, close the file descriptor. + // Shutdown and close the socket Close(); + // Destroy the GSocket object if (m_socket) GSocket_destroy(m_socket); } -bool wxSocketBase::Close() +/* +bool wxSocketBase::Destroy() { - if (m_socket) - { - if (m_notify_state == TRUE) - Notify(FALSE); + // Delayed destruction: the socket will be deleted during the next + // idle loop iteration. This ensures that all pending events have + // been processed. - // Shutdown the connection. - GSocket_Shutdown(m_socket); - m_connected = FALSE; - } + m_beingDeleted = TRUE; + Close(); + + if ( !wxPendingDelete.Member(this) ) + wxPendingDelete.Append(this); return TRUE; } +*/ -// -------------------------------------------------------------- -// wxSocketBase base IO function -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Basic IO operations +// -------------------------------------------------------------------------- -int wxSocketBase::DeferRead(char *buffer, size_t nbytes) +// 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() { - GSocketEventFlags old_event_flags; - bool old_notify_state; + // Interrupt pending waits + InterruptAllWaits(); - wxASSERT(m_defering == NO_DEFER); + if (m_socket) + { + // Disable callbacks + GSocket_UnsetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG); - m_defering = DEFER_READ; + // Shutdown the connection + GSocket_Shutdown(m_socket); + } - old_event_flags = NeededReq(); - old_notify_state = m_notify_state; - - SetNotify(GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG); - Notify(TRUE); + m_connected = FALSE; + m_establishing = FALSE; + return TRUE; +} - m_defer_buffer = buffer; - m_defer_nbytes = nbytes; - while (m_defer_buffer != NULL) - wxYield(); +wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) +{ + // Mask read events + m_reading = TRUE; - Notify(old_notify_state); - SetNotify(old_event_flags); + m_lcount = _Read(buffer, nbytes); - m_defering = NO_DEFER; + // 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); - return nbytes-m_defer_nbytes; + // Allow read events from now on + m_reading = FALSE; + + return *this; } -wxSocketBase& wxSocketBase::Read(char* buffer, size_t nbytes) +wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes) { + int total; int ret = 1; - m_lcount = GetPushback(buffer, nbytes, FALSE); - nbytes -= m_lcount; - buffer += m_lcount; - - if (!m_connected) - return *this; + // 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) + return total; + + // Possible combinations (they are checked in this order) + // wxSOCKET_NOWAIT + // wxSOCKET_WAITALL | wxSOCKET_BLOCK + // wxSOCKET_WAITALL + // 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); - // If we have got the whole needed buffer or if we don't want to - // wait then it returns immediately. - if (!nbytes || (m_lcount && !(m_flags & WAITALL)) ) { - return *this; + if (ret > 0) + total += ret; } + else if (m_flags & wxSOCKET_WAITALL) + { + while (ret > 0 && nbytes > 0) + { + if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead()) + break; - if ((m_flags & SPEED) != 0) { + ret = GSocket_Read(m_socket, buffer, nbytes); - if ((m_flags & WAITALL) != 0) { - while (ret > 0 && nbytes > 0) { - ret = GSocket_Read(m_socket, buffer, nbytes); - m_lcount += ret; + if (ret > 0) + { + total += ret; buffer += ret; nbytes -= ret; } - // In case the last call was an error ... - if (ret < 0) - m_lcount ++; - } else { + } + } + else + { + if ((m_flags & wxSOCKET_BLOCK) || WaitForRead()) + { ret = GSocket_Read(m_socket, buffer, nbytes); + if (ret > 0) - m_lcount += ret; + total += ret; } - - } else { - ret = DeferRead(buffer, nbytes); - - if (ret > 0) - m_lcount += ret; } - return *this; + return total; } -wxSocketBase& wxSocketBase::ReadMsg(char* buffer, size_t nbytes) +wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 nbytes) { - unsigned long len, len2, sig; - struct { - char sig[4]; - char len[4]; + wxUint32 len, len2, sig, total; + bool error; + int old_flags; + struct + { + unsigned char sig[4]; + unsigned char len[4]; } msg; - // sig should be an explicit 32-bit unsigned integer; I've seen - // compilers in which size_t was actually a 16-bit unsigned integer + // Mask read events + m_reading = TRUE; - Read((char *)&msg, sizeof(msg)); - if (m_lcount != sizeof(msg)) - return *this; + total = 0; + error = TRUE; + old_flags = m_flags; + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); - sig = msg.sig[0] & 0xff; - sig |= (size_t)(msg.sig[1] & 0xff) << 8; - sig |= (size_t)(msg.sig[2] & 0xff) << 16; - sig |= (size_t)(msg.sig[3] & 0xff) << 24; + if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg)) + goto exit; + + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); if (sig != 0xfeeddead) - return *this; - len = msg.len[0] & 0xff; - len |= (size_t)(msg.len[1] & 0xff) << 8; - len |= (size_t)(msg.len[2] & 0xff) << 16; - len |= (size_t)(msg.len[3] & 0xff) << 24; - - // len2 is incorrectly computed in the original; this sequence is - // the fix - if (len > nbytes) { + { + wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); + goto exit; + } + + len = (wxUint32)msg.len[0]; + len |= (wxUint32)(msg.len[1] << 8); + len |= (wxUint32)(msg.len[2] << 16); + len |= (wxUint32)(msg.len[3] << 24); + + if (len > nbytes) + { len2 = len - nbytes; len = nbytes; } else len2 = 0; - // the "len &&" in the following statement 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) - return *this; - if (len2 && (Read(NULL, len2).LastCount() != len2)) - return *this; - if (Read((char *)&msg, sizeof(msg)).LastCount() != sizeof(msg)) - return *this; - - sig = msg.sig[0] & 0xff; - sig |= (size_t)(msg.sig[1] & 0xff) << 8; - sig |= (size_t)(msg.sig[2] & 0xff) << 16; - sig |= (size_t)(msg.sig[3] & 0xff) << 24; - -// ERROR + // Don't attemp to read if the msg was zero bytes long. + if (len) + { + total = _Read(buffer, len); + + if (total != len) + goto exit; + } + if (len2) + { + char *discard_buffer = new char[MAX_DISCARD_SIZE]; + long discard_len; + + // NOTE: discarded bytes don't add to m_lcount. + do + { + discard_len = ((len2 > MAX_DISCARD_SIZE)? MAX_DISCARD_SIZE : len2); + discard_len = _Read(discard_buffer, (wxUint32)discard_len); + len2 -= (wxUint32)discard_len; + } + while ((discard_len > 0) && len2); + + delete [] discard_buffer; + + if (len2 != 0) + goto exit; + } + if (_Read((char *)&msg, sizeof(msg)) != sizeof(msg)) + goto exit; + + sig = (wxUint32)msg.sig[0]; + sig |= (wxUint32)(msg.sig[1] << 8); + sig |= (wxUint32)(msg.sig[2] << 16); + sig |= (wxUint32)(msg.sig[3] << 24); + if (sig != 0xdeadfeed) - wxLogDebug(_T("Warning: invalid signature returned to ReadMsg\n")); + { + wxLogWarning( _("wxSocket: invalid signature in ReadMsg.")); + goto exit; + } - return *this; -} + // everything was OK + error = FALSE; -wxSocketBase& wxSocketBase::Peek(char* buffer, size_t 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, size_t nbytes) +wxSocketBase& wxSocketBase::Peek(char* buffer, wxUint32 nbytes) { - GSocketEventFlags old_event_flags; - bool old_notify_state; + // Mask read events + m_reading = TRUE; - wxASSERT(m_defering == NO_DEFER); + m_lcount = _Read(buffer, nbytes); + Pushback(buffer, m_lcount); - m_defering = DEFER_WRITE; + // 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); - old_event_flags = NeededReq(); - old_notify_state = m_notify_state; + // Allow read events again + m_reading = FALSE; - SetNotify(GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG); - Notify(TRUE); + return *this; +} + +wxSocketBase& wxSocketBase::Write(const char *buffer, wxUint32 nbytes) +{ + // Mask write events + m_writing = TRUE; - m_defer_buffer = (char *)buffer; - m_defer_nbytes = nbytes; - while (m_defer_buffer != NULL) - wxYield(); + m_lcount = _Write(buffer, nbytes); - Notify(old_notify_state); - SetNotify(old_event_flags); + // 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, size_t nbytes) +wxUint32 wxSocketBase::_Write(const char *buffer, wxUint32 nbytes) { - int ret; + wxUint32 total = 0; + int ret = 1; + + // If the socket is invalid, return immediately + if (!m_socket) + return 0; - if ((m_flags & SPEED) != 0) + // Possible combinations (they are checked in this order) + // wxSOCKET_NOWAIT + // wxSOCKET_WAITALL | wxSOCKET_BLOCK + // wxSOCKET_WAITALL + // 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); + + if (ret > 0) + total = ret; + } + else if (m_flags & wxSOCKET_WAITALL) + { + while (ret > 0 && nbytes > 0) + { + if (!(m_flags & wxSOCKET_BLOCK) && !WaitForWrite()) + break; + + ret = GSocket_Write(m_socket, buffer, nbytes); + + if (ret > 0) + { + total += ret; + buffer += ret; + nbytes -= ret; + } + } + } else - ret = DeferWrite(buffer, nbytes); + { + if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite()) + { + ret = GSocket_Write(m_socket, buffer, nbytes); - if (ret != -1) - m_lcount += ret; + if (ret > 0) + total = ret; + } + } - return *this; + return total; } -wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, size_t nbytes) +wxSocketBase& wxSocketBase::WriteMsg(const char *buffer, wxUint32 nbytes) { + wxUint32 total; + bool error; + int old_flags; struct { - char sig[4]; - char len[4]; + unsigned char sig[4]; + unsigned char len[4]; } msg; - // warning about 'cast truncates constant value' -#ifdef __VISUALC__ - #pragma warning(disable: 4310) -#endif // __VISUALC__ - - msg.sig[0] = (char) 0xad; - msg.sig[1] = (char) 0xde; - msg.sig[2] = (char) 0xed; - msg.sig[3] = (char) 0xfe; - - 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; - - if (Write((char *)&msg, sizeof(msg)).LastCount() < sizeof(msg)) - return *this; - if (Write(buffer, nbytes).LastCount() < nbytes) - return *this; - - msg.sig[0] = (char) 0xed; - msg.sig[1] = (char) 0xfe; - msg.sig[2] = (char) 0xad; - msg.sig[3] = (char) 0xde; + // Mask write events + m_writing = TRUE; + + error = TRUE; + total = 0; + old_flags = m_flags; + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); + + msg.sig[0] = (unsigned char) 0xad; + msg.sig[1] = (unsigned char) 0xde; + msg.sig[2] = (unsigned char) 0xed; + msg.sig[3] = (unsigned char) 0xfe; + + msg.len[0] = (unsigned char) (nbytes & 0xff); + msg.len[1] = (unsigned char) ((nbytes >> 8) & 0xff); + msg.len[2] = (unsigned char) ((nbytes >> 16) & 0xff); + msg.len[3] = (unsigned char) ((nbytes >> 24) & 0xff); + + if (_Write((char *)&msg, sizeof(msg)) < sizeof(msg)) + goto exit; + + total = _Write(buffer, nbytes); + + if (total < nbytes) + goto exit; + + msg.sig[0] = (unsigned char) 0xed; + msg.sig[1] = (unsigned char) 0xfe; + msg.sig[2] = (unsigned char) 0xad; + msg.sig[3] = (unsigned char) 0xde; msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = (char) 0; - Write((char *)&msg, sizeof(msg)); - return *this; + if ((_Write((char *)&msg, sizeof(msg))) < sizeof(msg)) + goto exit; + + // everything was OK + error = FALSE; -#ifdef __VISUALC__ - #pragma warning(default: 4310) -#endif // __VISUALC__ +exit: + m_error = error; + m_lcount = total; + m_writing = FALSE; + + return *this; } -wxSocketBase& wxSocketBase::Unread(const char *buffer, size_t nbytes) +wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes) { - m_lcount = 0; - if (nbytes != 0) { - CreatePushbackAfter(buffer, nbytes); - m_lcount = nbytes; - } + if (nbytes != 0) + Pushback(buffer, nbytes); + + m_error = FALSE; + m_lcount = nbytes; + return *this; } -bool wxSocketBase::IsData() const +wxSocketBase& wxSocketBase::Discard() { - if (!m_socket) - return FALSE; + int old_flags; + char *buffer = new char[MAX_DISCARD_SIZE]; + wxUint32 ret; + wxUint32 total = 0; - return (GSocket_DataAvailable(m_socket)); + // Mask read events + m_reading = TRUE; + + old_flags = m_flags; + SetFlags(wxSOCKET_NOWAIT); + + do + { + ret = _Read(buffer, MAX_DISCARD_SIZE); + total += ret; + } + while (ret == MAX_DISCARD_SIZE); + + delete[] buffer; + m_lcount = total; + m_error = FALSE; + + // Allow read events again + m_reading = FALSE; + + return *this; } -void wxSocketBase::DoDefer(GSocketEvent req_evt) +// -------------------------------------------------------------------------- +// Wait functions +// -------------------------------------------------------------------------- + +// 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. + +class _wxSocketInternalTimer: public wxTimer { - int ret; +public: + int *m_state; + unsigned long m_new_val; - if (req_evt == GSOCK_LOST) { - Close(); - m_defer_buffer = NULL; - return; + void Notify() + { + *m_state = (int)m_new_val; // Change the value } - 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; +}; + +bool wxSocketBase::_Wait(long seconds, long milliseconds, + wxSocketEventFlags flags) +{ + GSocketEventFlags result; + _wxSocketInternalTimer timer; + long timeout; + int state = -1; + + // Set this to TRUE to interrupt ongoing waits + m_interrupt = FALSE; + + // Check for valid socket + if (!m_socket) + return FALSE; + + // Check for valid timeout value + if (seconds != -1) + timeout = seconds * 1000 + milliseconds; + else + timeout = m_timeout * 1000; + + // Activate timer + if (timeout) + { + timer.m_state = &state; + timer.m_new_val = 0; + timer.Start((int)timeout, TRUE); } - m_defer_nbytes -= ret; + // 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 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); + + // Incoming connection (server) or connection established (client) + if (result & GSOCK_CONNECTION_FLAG) + { + timer.Stop(); + m_connected = TRUE; + m_establishing = FALSE; + return TRUE; + } - if (ret < 0) - m_defer_nbytes++; + // Data available or output buffer ready + if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG)) + { + timer.Stop(); + return TRUE; + } + + // Connection lost + if (result & GSOCK_LOST_FLAG) + { + timer.Stop(); + m_connected = FALSE; + m_establishing = FALSE; + return (flags & GSOCK_LOST_FLAG); + } + + // Wait more? + if ((timeout == 0) || (m_interrupt)) + break; + else + PROCESS_EVENTS(); + } + + timer.Stop(); + return FALSE; +} - if ((m_flags & WAITALL) == 0 || m_defer_nbytes == 0 || ret < 0) { - m_defer_buffer = NULL; - Notify(FALSE); - } else - m_defer_buffer += ret; +bool wxSocketBase::Wait(long seconds, long milliseconds) +{ + return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | + GSOCK_OUTPUT_FLAG | + GSOCK_CONNECTION_FLAG | + GSOCK_LOST_FLAG); } -// --------------------------------------------------------------------- -// --------- wxSocketBase Discard(): deletes all byte in the input queue -// --------------------------------------------------------------------- -void wxSocketBase::Discard() +bool wxSocketBase::WaitForRead(long seconds, long milliseconds) { -#define MAX_BUFSIZE (10*1024) - char *my_data = new char[MAX_BUFSIZE]; - size_t recv_size = MAX_BUFSIZE; + // Check pushback buffer before entering _Wait + if (m_unread) + return TRUE; - SaveState(); - SetFlags(NOWAIT | SPEED); + // 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. - while (recv_size == MAX_BUFSIZE) - { - recv_size = Read(my_data, MAX_BUFSIZE).LastCount(); - } + return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | + GSOCK_LOST_FLAG); +} - RestoreState(); - delete [] my_data; +bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) +{ + return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG); +} -#undef MAX_BUFSIZE +bool wxSocketBase::WaitForLost(long seconds, long milliseconds) +{ + return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG); } -// -------------------------------------------------------------- -// wxSocketBase socket info functions -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Miscellaneous +// -------------------------------------------------------------------------- + +// +// Get local or peer address +// bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const { @@ -458,9 +710,9 @@ bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const return TRUE; } -// -------------------------------------------------------------- -// wxSocketBase wait functions -// -------------------------------------------------------------- +// +// Save and restore socket state +// void wxSocketBase::SaveState() { @@ -468,11 +720,11 @@ void wxSocketBase::SaveState() 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; + 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); } @@ -488,234 +740,174 @@ void wxSocketBase::RestoreState() state = (wxSocketState *)node->Data(); - 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); + 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; } -// -------------------------------------------------------------- -// --------- wxSocketBase callback functions -------------------- -// -------------------------------------------------------------- +// +// Timeout and flags +// -wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) +void wxSocketBase::SetTimeout(long seconds) { - wxSockCbk old_cbk = cbk_; + m_timeout = seconds; - m_cbk = cbk_; - return old_cbk; + if (m_socket) + GSocket_SetTimeout(m_socket, m_timeout * 1000); } -char *wxSocketBase::CallbackData(char *data) +void wxSocketBase::SetFlags(wxSockFlags _flags) { - char *old_data = m_cdata; - - m_cdata = data; - return old_data; + m_flags = _flags; } -// -------------------------------------------------------------- -// --------- wxSocketBase wait functions ------------------------ -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Callbacks (now obsolete - use events instead) +// -------------------------------------------------------------------------- -class _wxSocketInternalTimer: public wxTimer { - public: - int *m_state; - - void Notify() - { - *m_state = GSOCK_MAX_EVENT; // Just to say it's a timeout. - } -}; - -static void wx_socket_wait(GSocket *socket, GSocketEvent event, char *cdata) +wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) { - int *state = (int *)cdata; + wxSockCbk old_cbk = cbk_; - *state = event; + m_cbk = cbk_; + return old_cbk; } -bool wxSocketBase::_Wait(long seconds, long milliseconds, int type) +char *wxSocketBase::CallbackData(char *data) { - bool old_notify_state = m_notify_state; - int state = 0; - _wxSocketInternalTimer timer; - - if (!m_connected || !m_socket) - return FALSE; - - timer.m_state = &state; - - Notify(FALSE); - - timer.Start(seconds * 1000 + milliseconds, TRUE); - GSocket_SetFallback(m_socket, type, wx_socket_wait, (char *)&state); - - while (state == 0) - wxYield(); - - GSocket_UnsetFallback(m_socket, type); - timer.Stop(); - - Notify(old_notify_state); + char *old_data = m_cdata; - return (state != GSOCK_MAX_EVENT); + m_cdata = data; + return old_data; } -bool wxSocketBase::Wait(long seconds, long milliseconds) -{ - return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_CONNECTION_FLAG | GSOCK_LOST_FLAG); -} +// -------------------------------------------------------------------------- +// Event system +// -------------------------------------------------------------------------- -bool wxSocketBase::WaitForRead(long seconds, long milliseconds) -{ - return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG); -} +// All events (INPUT, OUTPUT, CONNECTION, LOST) are now always +// internally watched; but users will only be notified of those +// events they are interested in. -bool wxSocketBase::WaitForWrite(long seconds, long milliseconds) +static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), + GSocketEvent event, + char *cdata) { - return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG); -} + wxSocketBase *sckobj = (wxSocketBase *)cdata; -bool wxSocketBase::WaitForLost(long seconds, long milliseconds) -{ - return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG); + sckobj->OnRequest((wxSocketNotify)event); } -// -------------------------------------------------------------- -// --------- wxSocketBase callback management ------------------- -// -------------------------------------------------------------- - -GSocketEventFlags wxSocketBase::EventToNotify(GSocketEvent evt) +wxSocketEventFlags wxSocketBase::EventToNotify(wxSocketNotify evt) { - switch (evt) + 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_FLAG: - return GSOCK_LOST_FLAG; - default: - return 0; + 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; } -void wxSocketBase::SetFlags(wxSockFlags _flags) -{ - m_flags = _flags; -} - -wxSocketBase::wxSockFlags wxSocketBase::GetFlags() const +void wxSocketBase::SetNotify(wxSocketEventFlags flags) { - return m_flags; -} - -void wxSocketBase::SetNotify(GSocketEventFlags flags) -{ - /* Check if server */ - if (m_type != SOCK_SERVER) - flags &= ~GSOCK_CONNECTION_FLAG; - m_neededreq = flags; - if (m_neededreq == 0) - Notify(FALSE); - else - Notify(m_notify_state); -} - -// -------------------------------------------------------------- -// Automatic notifier -// -------------------------------------------------------------- - -static void wx_socket_fallback(GSocket *socket, GSocketEvent event, char *cdata) -{ - wxSocketBase *sckobj = (wxSocketBase *)cdata; - - sckobj->OnRequest(event); } void wxSocketBase::Notify(bool notify) { m_notify_state = notify; - if (!m_socket) - return; - - GSocket_UnsetFallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | - GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG); - if (!notify) - return; - - GSocket_SetFallback(m_socket, m_neededreq, wx_socket_fallback, (char *)this); } -void wxSocketBase::OnRequest(GSocketEvent req_evt) +void wxSocketBase::OnRequest(wxSocketNotify req_evt) { wxSocketEvent event(m_id); - GSocketEventFlags notify = EventToNotify(req_evt); + wxSocketEventFlags flag = EventToNotify(req_evt); - if (m_defering != NO_DEFER) { - DoDefer(req_evt); - return; + // 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) + { + 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; + break; + + case wxSOCKET_OUTPUT: + if (m_writing || !GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG)) + return; + break; + + case wxSOCKET_LOST: + m_connected = FALSE; + m_establishing = FALSE; + break; + + default: + break; } - if ((m_neededreq & notify) == notify) { + if (((m_neededreq & flag) == flag) && m_notify_state) + { event.m_socket = this; - event.m_skevt = req_evt; - ProcessEvent(event); + event.m_skevt = req_evt; + + if (m_evt_handler) +#if USE_DELAYED_EVENTS + wxPostEvent(m_evt_handler, event); +#else + ProcessEvent(event); +#endif + OldOnNotify(req_evt); + if (m_cbk) + m_cbk(*this, req_evt, m_cdata); } - - if (req_evt == GSOCK_LOST) - Close(); } -void wxSocketBase::OldOnNotify(GSocketEvent evt) +void wxSocketBase::OldOnNotify(wxSocketNotify WXUNUSED(evt)) { } -// -------------------------------------------------------------- -// --------- wxSocketBase functions [Callback, CallbackData] ---- -// -------------------------------------------------------------- - void wxSocketBase::SetEventHandler(wxEvtHandler& h_evt, int id) { - SetNextHandler(&h_evt); + m_evt_handler = &h_evt; m_id = id; + + SetNextHandler(&h_evt); } -// -------------------------------------------------------------- -// --------- wxSocketBase pushback library ---------------------- -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Pushback buffer +// -------------------------------------------------------------------------- -void wxSocketBase::CreatePushbackAfter(const char *buffer, size_t size) +void wxSocketBase::Pushback(const char *buffer, wxUint32 size) { - 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; + if (!size) return; - memcpy(curr_pos, buffer, size); - m_unrd_size += size; -} - -void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size) -{ if (m_unread == NULL) m_unread = (char *)malloc(size); - else { + else + { char *tmp; tmp = (char *)malloc(m_unrd_size + size); @@ -724,24 +916,27 @@ void wxSocketBase::CreatePushbackBefore(const char *buffer, size_t size) m_unread = tmp; } - + m_unrd_size += size; memcpy(m_unread, buffer, size); } -size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek) +wxUint32 wxSocketBase::GetPushback(char *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) { + 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; @@ -752,143 +947,236 @@ size_t wxSocketBase::GetPushback(char *buffer, size_t size, bool peek) return size; } -// -------------------------------------------------------------- +// ========================================================================== // wxSocketServer -// -------------------------------------------------------------- +// ========================================================================== + +// -------------------------------------------------------------------------- +// 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(); if (!m_socket) return; + // Setup the socket as server GSocket_SetLocal(m_socket, addr_man.GetAddress()); - if (GSocket_SetServer(m_socket) != GSOCK_NOERROR) { + if (GSocket_SetServer(m_socket) != GSOCK_NOERROR) + { GSocket_destroy(m_socket); m_socket = NULL; return; } - Notify(TRUE); + GSocket_SetTimeout(m_socket, m_timeout * 1000); + GSocket_SetCallback(m_socket, 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 wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) { GSocket *child_socket; + if (!m_socket) + return FALSE; + + // 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); + child_socket = GSocket_WaitConnection(m_socket); + if (!wait) + GSocket_SetNonBlocking(m_socket, FALSE); + + if (!child_socket) + return FALSE; + sock.m_type = SOCK_INTERNAL; sock.m_socket = child_socket; sock.m_connected = TRUE; + GSocket_SetTimeout(sock.m_socket, sock.m_timeout * 1000); + GSocket_SetCallback(sock.m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, + wx_socket_callback, (char *)&sock); + return TRUE; } -wxSocketBase *wxSocketServer::Accept() +wxSocketBase *wxSocketServer::Accept(bool wait) { wxSocketBase* sock = new wxSocketBase(); sock->SetFlags((wxSockFlags)m_flags); - if (!AcceptWith(*sock)) + if (!AcceptWith(*sock, wait)) return NULL; return sock; } -// -------------------------------------------------------------- +bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) +{ + return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); +} + +// ========================================================================== // wxSocketClient -// -------------------------------------------------------------- +// ========================================================================== + +// -------------------------------------------------------------------------- +// Ctor and dtor +// -------------------------------------------------------------------------- -// --------- wxSocketClient CONSTRUCTOR ------------------------- -// -------------------------------------------------------------- -wxSocketClient::wxSocketClient(wxSockFlags _flags) : - wxSocketBase(_flags, SOCK_CLIENT) +wxSocketClient::wxSocketClient(wxSockFlags _flags) + : wxSocketBase(_flags, SOCK_CLIENT) { } -// -------------------------------------------------------------- -// --------- wxSocketClient DESTRUCTOR -------------------------- -// -------------------------------------------------------------- +// XXX: What is this for ? wxSocketClient::~wxSocketClient() { } -// -------------------------------------------------------------- -// --------- wxSocketClient Connect functions ------------------- -// -------------------------------------------------------------- -bool wxSocketClient::Connect(wxSockAddress& addr_man, bool WXUNUSED(wait) ) +// -------------------------------------------------------------------------- +// Connect +// -------------------------------------------------------------------------- + +bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) { - if (IsConnected()) - Close(); + GSocketError err; - // This should never happen. if (m_socket) + { + // Shutdown and destroy the socket + Close(); GSocket_destroy(m_socket); + } - // Initializes all socket stuff ... - // -------------------------------- m_socket = GSocket_new(); + m_connected = FALSE; + m_establishing = FALSE; if (!m_socket) return FALSE; - m_connected = FALSE; + GSocket_SetTimeout(m_socket, m_timeout * 1000); + GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG | + GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG, + wx_socket_callback, (char *)this); + + // 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); - // Update the flags of m_socket. - SetFlags(m_flags); GSocket_SetPeer(m_socket, addr_man.GetAddress()); - if (GSocket_Connect(m_socket, GSOCK_STREAMED) != GSOCK_NOERROR) { + err = GSocket_Connect(m_socket, GSOCK_STREAMED); + + if (!wait) + GSocket_SetNonBlocking(m_socket, FALSE); + + if (err != GSOCK_NOERROR) + { + if (err == GSOCK_WOULDBLOCK) + m_establishing = TRUE; + return FALSE; } - // Enables bg events. - // ------------------ - Notify(TRUE); - m_connected = TRUE; return TRUE; } -bool wxSocketClient::WaitOnConnect(long seconds, long microseconds) +bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) { - int ret = _Wait(seconds, microseconds, GSOCK_CONNECTION_FLAG | GSOCK_LOST_FLAG); + if (m_connected) // Already connected + return TRUE; - if (ret) - m_connected = TRUE; + if (!m_establishing || !m_socket) // No connection in progress + return FALSE; - return m_connected; + return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); } -void wxSocketClient::OnRequest(GSocketEvent evt) +// ========================================================================== +// wxDatagramSocket +// ========================================================================== + +/* NOTE: experimental stuff - might change */ + +wxDatagramSocket::wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags ) + : wxSocketBase( flags, SOCK_DATAGRAM ) { - if (evt == GSOCK_CONNECTION) + // Create the socket + m_socket = GSocket_new(); + + if(!m_socket) + return; + + // Setup the socket as non connection oriented + GSocket_SetLocal(m_socket, addr.GetAddress()); + if( GSocket_SetNonOriented(m_socket) != GSOCK_NOERROR ) { - if (m_connected) - { - m_neededreq &= ~GSOCK_CONNECTION_FLAG; - return; - } - m_connected = TRUE; + GSocket_destroy(m_socket); + m_socket = NULL; return; } - wxSocketBase::OnRequest(evt); + + // Initialize all stuff + m_connected = FALSE; + m_establishing = FALSE; + 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 ); + } -// -------------------------------------------------------------- +wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr, + char* buf, + wxUint32 nBytes ) +{ + Read(buf, nBytes); + GetPeer(addr); + return (*this); +} + +wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr, + const char* buf, + wxUint32 nBytes ) +{ + GSocket_SetPeer(m_socket, addr.GetAddress()); + Write(buf, nBytes); + return (*this); +} + +// ========================================================================== // wxSocketEvent -// -------------------------------------------------------------- +// ========================================================================== + +// XXX: Should be moved to event.cpp ? wxSocketEvent::wxSocketEvent(int id) - : wxEvent(id) + : wxEvent(id) { wxEventType type = (wxEventType)wxEVT_SOCKET; @@ -905,5 +1193,20 @@ void wxSocketEvent::CopyObject(wxObject& obj_d) const 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(); } +}; + +IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule) + #endif // wxUSE_SOCKETS