X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/af2fd9613a810695f63db0246df4fc2aff6026f2..058939fc084207e06d34a2c82f4c62a103516dd8:/src/common/socket.cpp diff --git a/src/common/socket.cpp b/src/common/socket.cpp index a5cf4047a7..98ce67a4b9 100644 --- a/src/common/socket.cpp +++ b/src/common/socket.cpp @@ -3,9 +3,8 @@ // 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 ///////////////////////////////////////////////////////////////////////////// @@ -23,9 +22,11 @@ #if wxUSE_SOCKETS -///////////////////////////////////////////////////////////////////////////// -// wxWindows headers -///////////////////////////////////////////////////////////////////////////// +// ========================================================================== +// Headers and constants +// ========================================================================== + +#include "wx/app.h" #include "wx/defs.h" #include "wx/object.h" #include "wx/string.h" @@ -33,70 +34,77 @@ #include "wx/utils.h" #include "wx/module.h" #include "wx/log.h" +#include "wx/intl.h" +#include "wx/gdicmn.h" // for wxPendingDelete -#include -#include -#include - -///////////////////////////////////////////////////////////////////////////// -// wxSocket headers -///////////////////////////////////////////////////////////////////////////// #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 { 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 ctor and dtor -// -------------------------------------------------------------- -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(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_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_notify_state(FALSE), m_id(-1), - m_defering(NO_DEFER), m_error(FALSE), - m_states() + 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) { } 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_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_notify_state(FALSE), m_id(-1), - m_defering(NO_DEFER), m_error(FALSE), - m_states() + 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) { } @@ -113,8 +121,37 @@ wxSocketBase::~wxSocketBase() 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 + InterruptAllWaits(); + if (m_socket) { // Disable callbacks @@ -123,202 +160,130 @@ bool wxSocketBase::Close() // 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 -// -------------------------------------------------------------- - -// 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 -{ -public: - int *m_state; - unsigned long m_new_val; - - void Notify() - { - *m_state = m_new_val; // Change the value - } -}; - -int wxSocketBase::DeferRead(char *buffer, wxUint32 nbytes) +wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) { - // Timer for timeout - _wxSocketInternalTimer timer; - - wxASSERT(m_defering == NO_DEFER); - - // Set the defering mode to READ. - m_defering = DEFER_READ; - - // Set the current buffer. - m_defer_buffer = buffer; - m_defer_nbytes = nbytes; - m_defer_timer = &timer; - - timer.m_state = (int *)&m_defer_buffer; - timer.m_new_val = 0; - - timer.Start(m_timeout * 1000, FALSE); + // Mask read events + m_reading = TRUE; - // If the socket is readable, call DoDefer for the first time - if (GSocket_Select(m_socket, GSOCK_INPUT_FLAG)) - DoDefer(); + m_lcount = _Read(buffer, nbytes); - // Wait for buffer completion. - while (m_defer_buffer != NULL) - wxYield(); - - timer.Stop(); + // 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); - // Disable defering mode. - m_defering = NO_DEFER; - m_defer_timer = NULL; + // Allow read events from now on + m_reading = FALSE; - // Return the number of bytes read from the socket. - return nbytes-m_defer_nbytes; + return *this; } -wxSocketBase& wxSocketBase::Read(char* buffer, wxUint32 nbytes) +wxUint32 wxSocketBase::_Read(char* buffer, wxUint32 nbytes) { + int total; int ret = 1; - m_error = FALSE; - - // we try this even if the connection has already been closed. - m_lcount = GetPushback(buffer, nbytes, FALSE); - nbytes -= m_lcount; - buffer += m_lcount; + // Try the pushback buffer first + total = GetPushback(buffer, nbytes, FALSE); + nbytes -= total; + buffer += total; - if (!m_connected || !m_socket) - { - // if no data retrieved AND not connected, it is an error. - if (!m_lcount) - m_error = TRUE; - - return *this; - } - - // If we have got the whole needed buffer, return immediately - if (!nbytes) - return *this; + // 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) - // NOWAIT - // SPEED | WAITALL - // SPEED - // WAITALL - // NONE + // wxSOCKET_NOWAIT + // wxSOCKET_WAITALL | wxSOCKET_BLOCK + // wxSOCKET_WAITALL + // wxSOCKET_BLOCK + // wxSOCKET_NONE // - if (m_flags & NOWAIT) // NOWAIT + if (m_flags & wxSOCKET_NOWAIT) { GSocket_SetNonBlocking(m_socket, TRUE); ret = GSocket_Read(m_socket, buffer, nbytes); GSocket_SetNonBlocking(m_socket, FALSE); if (ret > 0) - m_lcount += ret; + total += ret; } - else if (m_flags & SPEED & WAITALL) // SPEED, WAITALL + else if (m_flags & wxSOCKET_WAITALL) { while (ret > 0 && nbytes > 0) { + if (!(m_flags & wxSOCKET_BLOCK) && !WaitForRead()) + break; + 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 (ret > 0) - m_lcount += ret; + if (ret > 0) + { + total += ret; + buffer += ret; + nbytes -= ret; + } + } } - else // NONE or WAITALL + else { - ret = DeferRead(buffer, nbytes); + if ((m_flags & wxSOCKET_BLOCK) || WaitForRead()) + { + ret = GSocket_Read(m_socket, buffer, nbytes); - if (ret > 0) - m_lcount += ret; + if (ret > 0) + total += 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; - - return *this; + return total; } wxSocketBase& wxSocketBase::ReadMsg(char* 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((char *)&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) { @@ -328,414 +293,288 @@ wxSocketBase& wxSocketBase::ReadMsg(char* buffer, wxUint32 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((char *)&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(char* 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 char *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 char *buffer, wxUint32 nbytes) { + wxUint32 total = 0; int ret = 1; - m_lcount = 0; - m_error = FALSE; - - if (!m_connected || !m_socket) - { - m_error = TRUE; - return *this; - } + // If the socket is invalid, return immediately + if (!m_socket) + return 0; // Possible combinations (they are checked in this order) - // NOWAIT - // SPEED | WAITALL - // SPEED - // WAITALL - // NONE + // wxSOCKET_NOWAIT + // wxSOCKET_WAITALL | wxSOCKET_BLOCK + // wxSOCKET_WAITALL + // wxSOCKET_BLOCK + // wxSOCKET_NONE // - if (m_flags & NOWAIT) // NOWAIT + 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) - m_lcount += ret; + total = ret; } - else if (m_flags & SPEED & WAITALL) // SPEED, WAITALL + 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); - 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 (ret > 0) - m_lcount += ret; + if (ret > 0) + { + total += ret; + buffer += ret; + nbytes -= ret; + } + } } - else // NONE or WAITALL + else { - ret = DeferWrite(buffer, nbytes); + if ((m_flags & wxSOCKET_BLOCK) || WaitForWrite()) + { + ret = GSocket_Write(m_socket, buffer, nbytes); - if (ret > 0) - m_lcount += ret; + if (ret > 0) + total = 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; - - return *this; + return total; } 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; + // Mask write events + m_writing = TRUE; + error = TRUE; + total = 0; old_flags = m_flags; - SetFlags(old_flags | WAITALL); + SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL); - 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; - } + 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.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; + 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)) - m_error = TRUE; + if (_Write((char *)&msg, sizeof(msg)) < sizeof(msg)) + goto exit; - SetFlags(old_flags); - return *this; + total = _Write(buffer, nbytes); -#ifdef __VISUALC__ - #pragma warning(default: 4310) -#endif // __VISUALC__ -} + if (total < nbytes) + goto exit; -wxSocketBase& wxSocketBase::Unread(const char *buffer, wxUint32 nbytes) -{ - m_error = FALSE; - m_lcount = 0; + msg.sig[0] = (unsigned char) 0xed; + msg.sig[1] = (unsigned char) 0xfe; + msg.sig[2] = (unsigned char) 0xad; + msg.sig[3] = (unsigned char) 0xde; + msg.len[0] = msg.len[1] = msg.len[2] = msg.len[3] = (char) 0; - if (nbytes != 0) - { - CreatePushbackAfter(buffer, nbytes); - m_lcount = nbytes; - } - return *this; -} + if ((_Write((char *)&msg, sizeof(msg))) < sizeof(msg)) + goto exit; -bool wxSocketBase::IsData() const -{ - if (!m_socket) - return FALSE; + // everything was OK + error = FALSE; - return (GSocket_Select(m_socket, GSOCK_INPUT_FLAG)); -} +exit: + m_error = error; + m_lcount = total; + m_writing = FALSE; -// 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. + return *this; +} -void wxSocketBase::DoDefer() +wxSocketBase& wxSocketBase::Unread(const char *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; + int old_flags; + 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; - while (recv_size == MAX_BUFSIZE) + old_flags = m_flags; + SetFlags(wxSOCKET_NOWAIT); + + 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 -// -------------------------------------------------------------- + m_error = FALSE; -bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const -{ - GAddress *peer; + // Allow read events again + m_reading = FALSE; - 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; + return *this; } -// -------------------------------------------------------------- -// 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; +// -------------------------------------------------------------------------- +// 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->socket_flags); - m_neededreq = state->evt_notify_state; - m_cbk = state->c_callback; - m_cdata = state->c_callback_data; - Notify(state->notify_state); - - delete node; - delete state; -} - - -// -------------------------------------------------------------- -// wxSocketBase Wait functions -// -------------------------------------------------------------- +public: + int *m_state; + unsigned long m_new_val; -// 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. + void Notify() + { + *m_state = (int)m_new_val; // Change the value + } +}; -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; + // 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; - // Check for valid timeout value if (seconds != -1) timeout = seconds * 1000 + milliseconds; @@ -743,31 +582,29 @@ bool wxSocketBase::_Wait(long seconds, long milliseconds, wxSocketEventFlags fla timeout = m_timeout * 1000; // Activate timer - timer.m_state = &state; - timer.m_new_val = 0; - timer.Start(timeout, TRUE); + if (timeout) + { + timer.m_state = &state; + timer.m_new_val = 0; + timer.Start((int)timeout, TRUE); + } // 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); - // Connection lost - if (result & GSOCK_LOST_FLAG) - { - timer.Stop(); - m_defer_buffer = NULL; - Close(); - return TRUE; - } - // Incoming connection (server) or connection established (client) if (result & GSOCK_CONNECTION_FLAG) { @@ -777,17 +614,27 @@ bool wxSocketBase::_Wait(long seconds, long milliseconds, wxSocketEventFlags fla return TRUE; } - // 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) - { - timer.Stop(); - return TRUE; - } + timer.Stop(); + return TRUE; } - wxYield(); + // 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(); @@ -804,7 +651,17 @@ bool wxSocketBase::Wait(long seconds, long milliseconds) 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 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) @@ -817,31 +674,102 @@ bool wxSocketBase::WaitForLost(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; if (m_socket) - GSocket_SetTimeout(m_socket, m_timeout); + GSocket_SetTimeout(m_socket, m_timeout * 1000); } -// -------------------------------------------------------------- -// wxSocketBase flags -// -------------------------------------------------------------- - void wxSocketBase::SetFlags(wxSockFlags _flags) { m_flags = _flags; } - -wxSocketBase::wxSockFlags wxSocketBase::GetFlags() const -{ - return m_flags; -} -// -------------------------------------------------------------- -// wxSocketBase callback management -// -------------------------------------------------------------- +// -------------------------------------------------------------------------- +// Callbacks (now obsolete - use events instead) +// -------------------------------------------------------------------------- wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_) { @@ -859,11 +787,17 @@ char *wxSocketBase::CallbackData(char *data) 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 *socket, GSocketEvent event, char *cdata) +static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket), + GSocketEvent event, + char *cdata) { wxSocketBase *sckobj = (wxSocketBase *)cdata; @@ -897,34 +831,38 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt) 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. - // + // 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; - case wxSOCKET_LOST: - m_defer_buffer = NULL; - Close(); - 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_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 || !GSocket_Select(m_socket, GSOCK_OUTPUT_FLAG)) return; - } + break; + + case wxSOCKET_LOST: + m_connected = FALSE; + m_establishing = FALSE; + break; + + default: break; } @@ -932,52 +870,44 @@ void wxSocketBase::OnRequest(wxSocketNotify req_evt) { event.m_socket = this; event.m_skevt = req_evt; - ProcessEvent(event); - OldOnNotify(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); } } -void wxSocketBase::OldOnNotify(wxSocketNotify evt) +void wxSocketBase::OldOnNotify(wxSocketNotify WXUNUSED(evt)) { } -// -------------------------------------------------------------- -// wxSocketBase set event handler -// -------------------------------------------------------------- - 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, wxUint32 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); + if (!size) return; - curr_pos = m_unread + m_unrd_size; - - memcpy(curr_pos, buffer, size); - m_unrd_size += size; -} - -void wxSocketBase::CreatePushbackBefore(const char *buffer, wxUint32 size) -{ if (m_unread == NULL) m_unread = (char *)malloc(size); - else { + else + { char *tmp; tmp = (char *)malloc(m_unrd_size + size); @@ -999,11 +929,14 @@ wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek) 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; @@ -1014,17 +947,17 @@ wxUint32 wxSocketBase::GetPushback(char *buffer, wxUint32 size, bool peek) 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(); @@ -1041,16 +974,16 @@ wxSocketServer::wxSocketServer(wxSockAddress& addr_man, return; } - GSocket_SetTimeout(m_socket, m_timeout); + 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 wait) { @@ -1059,7 +992,7 @@ 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. @@ -1071,15 +1004,14 @@ bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait) 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; sock.m_socket = child_socket; sock.m_connected = TRUE; - GSocket_SetTimeout(sock.m_socket, sock.m_timeout); + 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); @@ -1104,38 +1036,39 @@ bool wxSocketServer::WaitForAccept(long seconds, long milliseconds) 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; @@ -1143,9 +1076,12 @@ bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) if (!m_socket) return FALSE; - GSocket_SetTimeout(m_socket, m_timeout); + 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); - // 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. @@ -1154,9 +1090,6 @@ bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait) 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); if (!wait) GSocket_SetNonBlocking(m_socket, FALSE); @@ -1184,12 +1117,66 @@ bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds) return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG); } -// -------------------------------------------------------------- +// ========================================================================== +// wxDatagramSocket +// ========================================================================== + +/* NOTE: experimental stuff - might change */ + +wxDatagramSocket::wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags ) + : wxSocketBase( flags, SOCK_DATAGRAM ) +{ + // 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 ) + { + GSocket_destroy(m_socket); + m_socket = NULL; + return; + } + + // 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; @@ -1206,18 +1193,17 @@ void wxSocketEvent::CopyObject(wxObject& obj_d) const event->m_socket = m_socket; } -// -------------------------------------------------------------------------- +// ========================================================================== // wxSocketModule -// -------------------------------------------------------------------------- -class WXDLLEXPORT wxSocketModule: public wxModule { +// ========================================================================== + +class WXDLLEXPORT wxSocketModule: public wxModule +{ DECLARE_DYNAMIC_CLASS(wxSocketModule) - public: - bool OnInit() { - return GSocket_Init(); - } - void OnExit() { - GSocket_Cleanup(); - } + +public: + bool OnInit() { return GSocket_Init(); } + void OnExit() { GSocket_Cleanup(); } }; IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)