/////////////////////////////////////////////////////////////////////////////
-// Name: socket.cpp
+// Name: src/common/socket.cpp
// Purpose: Socket handler classes
// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
// Created: April 1997
// Copyright: (C) 1999-1997, Guilhem Lavaux
// (C) 2000-1999, Guillermo Rodriguez Garcia
// RCS_ID: $Id$
-// License: see wxWindows license
+// License: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ==========================================================================
// Declarations
// ==========================================================================
-#ifdef __GNUG__
-#pragma implementation "socket.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
#if wxUSE_SOCKETS
-#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/event.h"
-
-#if wxUSE_GUI
- #include "wx/gdicmn.h" // for wxPendingDelete
-#endif // wxUSE_GUI
+#include "wx/socket.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/object.h"
+ #include "wx/string.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/event.h"
+ #include "wx/app.h"
+ #include "wx/utils.h"
+ #include "wx/timer.h"
+ #include "wx/module.h"
+#endif
+#include "wx/apptrait.h"
#include "wx/sckaddr.h"
-#include "wx/socket.h"
+#include "wx/stopwatch.h"
+#include "wx/thread.h"
+#include "wx/evtloop.h"
+
+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxNet")
// --------------------------------------------------------------------------
// macros and constants
// discard buffer
#define MAX_DISCARD_SIZE (10 * 1024)
-// what to do within waits
-#if wxUSE_GUI
- #define PROCESS_EVENTS() wxYield()
-#else
- #define PROCESS_EVENTS()
-#endif
+#define wxTRACE_Socket _T("wxSocket")
// --------------------------------------------------------------------------
// wxWin macros
class wxSocketState : public wxObject
{
public:
- 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
+ wxSocketFlags m_flags;
+ wxSocketEventFlags m_eventmask;
+ bool m_notify;
+ void *m_clientData;
public:
- wxSocketState() : wxObject() {}
+ wxSocketState() : wxObject() {}
+
+ DECLARE_NO_COPY_CLASS(wxSocketState)
};
+// Conditionally make the socket non-blocking for the lifetime of this object.
+class wxSocketUnblocker
+{
+public:
+ wxSocketUnblocker(GSocket *socket, bool unblock = true)
+ : m_socket(socket),
+ m_unblock(unblock)
+ {
+ if ( m_unblock )
+ m_socket->SetNonBlocking(true);
+ }
+
+ ~wxSocketUnblocker()
+ {
+ if ( m_unblock )
+ m_socket->SetNonBlocking(false);
+ }
+
+private:
+ GSocket * const m_socket;
+ bool m_unblock;
+
+ DECLARE_NO_COPY_CLASS(wxSocketUnblocker)
+};
+
+// ============================================================================
+// GSocketManager
+// ============================================================================
+
+GSocketManager *GSocketManager::ms_manager = NULL;
+
+/* static */
+void GSocketManager::Set(GSocketManager *manager)
+{
+ wxASSERT_MSG( !ms_manager, "too late to set manager now" );
+
+ ms_manager = manager;
+}
+
+/* static */
+void GSocketManager::Init()
+{
+ wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" );
+
+ /*
+ Details: Initialize() creates a hidden window as a sink for socket
+ events, such as 'read completed'. wxMSW has only one message loop
+ for the main thread. If Initialize is called in a secondary thread,
+ the socket window will be created for the secondary thread, but
+ since there is no message loop on this thread, it will never
+ receive events and all socket operations will time out.
+ BTW, the main thread must not be stopped using sleep or block
+ on a semaphore (a bad idea in any case) or socket operations
+ will time out.
+
+ On the Mac side, Initialize() stores a pointer to the CFRunLoop for
+ the main thread. Because secondary threads do not have run loops,
+ adding event notifications to the "Current" loop would have no
+ effect at all, events would never fire.
+ */
+ wxASSERT_MSG( wxIsMainThread(),
+ "sockets must be initialized from the main thread" );
+
+ wxAppConsole * const app = wxAppConsole::GetInstance();
+ wxCHECK_RET( app, "sockets can't be initialized without wxApp" );
+
+ ms_manager = app->GetTraits()->GetSocketManager();
+}
+
// ==========================================================================
// wxSocketBase
// ==========================================================================
+// --------------------------------------------------------------------------
+// Initialization and shutdown
+// --------------------------------------------------------------------------
+
+// FIXME-MT: all this is MT-unsafe, of course, we should protect all accesses
+// to m_countInit with a crit section
+size_t wxSocketBase::m_countInit = 0;
+
+bool wxSocketBase::IsInitialized()
+{
+ return m_countInit > 0;
+}
+
+bool wxSocketBase::Initialize()
+{
+ if ( !m_countInit++ )
+ {
+ if ( !GSocket_Init() )
+ {
+ m_countInit--;
+
+ return false;
+ }
+ }
+
+ return true;
+}
+
+void wxSocketBase::Shutdown()
+{
+ // we should be initialized
+ wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") );
+ if ( --m_countInit == 0 )
+ {
+ GSocket_Cleanup();
+ }
+}
+
// --------------------------------------------------------------------------
// Ctor and dtor
// --------------------------------------------------------------------------
void wxSocketBase::Init()
{
- m_socket = NULL;
- m_type = wxSOCKET_UNINIT;
-
- // state
- m_flags = 0;
- m_connected =
- m_establishing =
- m_reading =
- m_writing =
- m_error = FALSE;
- m_lcount = 0;
- m_timeout = 600;
- m_beingDeleted = FALSE;
-
- // pushback buffer
- m_unread = NULL;
- m_unrd_size = 0;
- m_unrd_cur = 0;
-
- // events
- m_id = -1;
- m_handler = NULL;
- m_clientData = NULL;
- m_notify = FALSE;
- m_eventmask = 0;
-#if WXWIN_COMPATIBILITY
- m_cbk = NULL;
- m_cdata = NULL;
-#endif // WXWIN_COMPATIBILITY
+ m_socket = NULL;
+ m_type = wxSOCKET_UNINIT;
+
+ // state
+ m_flags = 0;
+ m_connected =
+ m_establishing =
+ m_reading =
+ m_writing =
+ m_error =
+ m_closed = false;
+ m_lcount = 0;
+ m_timeout = 600;
+ m_beingDeleted = false;
+
+ // pushback buffer
+ m_unread = NULL;
+ m_unrd_size = 0;
+ m_unrd_cur = 0;
+
+ // events
+ m_id = wxID_ANY;
+ m_handler = NULL;
+ m_clientData = NULL;
+ m_notify = false;
+ m_eventmask = 0;
+
+ if ( !IsInitialized() )
+ {
+ // this Initialize() will be undone by wxSocketModule::OnExit(), all
+ // the other calls to it should be matched by a call to Shutdown()
+ Initialize();
+ }
}
wxSocketBase::wxSocketBase()
{
- Init();
+ Init();
}
wxSocketBase::wxSocketBase(wxSocketFlags flags, wxSocketType type)
{
- Init();
+ Init();
+
+ SetFlags(flags);
- m_flags = flags;
- m_type = type;
+ m_type = type;
}
wxSocketBase::~wxSocketBase()
{
- // Just in case the app called Destroy() *and* then deleted
- // the socket immediately: don't leave dangling pointers.
-#if wxUSE_GUI
- wxPendingDelete.DeleteObject(this);
-#endif
-
- // Shutdown and close the socket
- if (!m_beingDeleted)
- Close();
-
- // Destroy the GSocket object
- if (m_socket)
- GSocket_destroy(m_socket);
-
- // Free the pushback buffer
- if (m_unread)
- free(m_unread);
+ // Just in case the app called Destroy() *and* then deleted the socket
+ // immediately: don't leave dangling pointers.
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits )
+ traits->RemoveFromPendingDelete(this);
+
+ // Shutdown and close the socket
+ if (!m_beingDeleted)
+ Close();
+
+ // Destroy the GSocket object
+ if (m_socket)
+ delete m_socket;
+
+ // Free the pushback buffer
+ if (m_unread)
+ free(m_unread);
}
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;
-
- // Shutdown and close the socket
- Close();
-
- // Supress events from now on
- Notify(FALSE);
-
-#if wxUSE_GUI
- if ( !wxPendingDelete.Member(this) )
- wxPendingDelete.Append(this);
-#else
- delete this;
-#endif
+ // 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;
+
+ // Shutdown and close the socket
+ Close();
+
+ // Supress events from now on
+ Notify(false);
+
+ // schedule this object for deletion
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits )
+ {
+ // let the traits object decide what to do with us
+ traits->ScheduleForDestroy(this);
+ }
+ else // no app or no traits
+ {
+ // in wxBase we might have no app object at all, don't leak memory
+ delete this;
+ }
- return TRUE;
+ return true;
}
// --------------------------------------------------------------------------
bool wxSocketBase::Close()
{
- // Interrupt pending waits
- InterruptWait();
-
- if (m_socket)
- {
- // Disable callbacks
- GSocket_UnsetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
- GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG);
-
- // Shutdown the connection
- GSocket_Shutdown(m_socket);
- }
-
- m_connected = FALSE;
- m_establishing = FALSE;
- return TRUE;
+ // Interrupt pending waits
+ InterruptWait();
+
+ if (m_socket)
+ {
+ // Disable callbacks
+ m_socket->UnsetCallback(
+ GSOCK_INPUT_FLAG |
+ GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG |
+ GSOCK_CONNECTION_FLAG
+ );
+
+ // Shutdown the connection
+ m_socket->Shutdown();
+ }
+
+ m_connected = false;
+ m_establishing = false;
+ return true;
}
wxSocketBase& wxSocketBase::Read(void* buffer, wxUint32 nbytes)
{
- // Mask read events
- m_reading = TRUE;
+ // Mask read events
+ m_reading = true;
- m_lcount = _Read(buffer, nbytes);
+ m_lcount = DoRead(buffer, nbytes);
- // 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);
+ // 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);
- // Allow read events from now on
- m_reading = FALSE;
+ // Allow read events from now on
+ m_reading = false;
- return *this;
+ return *this;
}
-wxUint32 wxSocketBase::_Read(void* buffer, wxUint32 nbytes)
+wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
{
- int total;
- int ret = 1;
-
- // Try the pushback buffer first
- total = GetPushback(buffer, nbytes, FALSE);
- nbytes -= total;
- buffer = (char *)buffer + total;
-
- // Return now in one of the following cases:
- // - the socket is invalid,
- // - we got all the data,
- // - we got *some* data and we are not using wxSOCKET_WAITALL.
- if ( !m_socket ||
- !nbytes ||
- ((total != 0) && !(m_flags & wxSOCKET_WAITALL)) )
- return total;
+ // We use pointer arithmetic here which doesn't work with void pointers.
+ char *buffer = static_cast<char *>(buffer_);
+
+ // Try the push back buffer first, even before checking whether the socket
+ // is valid to allow reading previously pushed back data from an already
+ // closed socket.
+ wxUint32 total = GetPushback(buffer, nbytes, false);
+ nbytes -= total;
+ buffer += total;
+
+ // If it's indeed closed or if read everything, there is nothing more to do.
+ if ( !m_socket || !nbytes )
+ return total;
+
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
- // Possible combinations (they are checked in this order)
- // wxSOCKET_NOWAIT
- // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
- // wxSOCKET_BLOCK
- // wxSOCKET_NONE
- //
- if (m_flags & wxSOCKET_NOWAIT)
- {
- GSocket_SetNonBlocking(m_socket, 1);
- ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
- GSocket_SetNonBlocking(m_socket, 0);
-
- if (ret > 0)
- total += ret;
- }
- else
- {
- bool more = TRUE;
-
- while (more)
+
+ // wxSOCKET_NOWAIT overrides all the other flags and means that we are
+ // polling the socket and don't block at all.
+ if ( m_flags & wxSOCKET_NOWAIT )
+ {
+ wxSocketUnblocker unblock(m_socket);
+ int ret = m_socket->Read(buffer, nbytes);
+ if ( ret < 0 )
+ return 0;
+
+ total += ret;
+ }
+ else // blocking socket
{
- if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() )
- break;
-
- ret = GSocket_Read(m_socket, (char *)buffer, nbytes);
-
- if (ret > 0)
- {
- total += ret;
- nbytes -= ret;
- buffer = (char *)buffer + 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));
+ for ( ;; )
+ {
+ // Wait until socket becomes ready for reading dispatching the GUI
+ // events in the meanwhile unless wxSOCKET_BLOCK was explicitly
+ // specified to disable this.
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForRead() )
+ break;
+
+ const int ret = m_socket->Read(buffer, nbytes);
+ if ( ret == 0 )
+ {
+ // for connection-oriented (e.g. TCP) sockets we can only read
+ // 0 bytes if the other end has been closed, and for
+ // connectionless ones (UDP) this flag doesn't make sense
+ // anyhow so we can set it to true too without doing any harm
+ m_closed = true;
+ break;
+ }
+
+ if ( ret < 0 )
+ {
+ // this will be always interpreted as error by Read()
+ return 0;
+ }
+
+ total += ret;
+
+ // If wxSOCKET_WAITALL is not set, we can leave now as we did read
+ // something and we don't need to wait for all nbytes bytes to be
+ // read.
+ if ( !(m_flags & wxSOCKET_WAITALL) )
+ break;
+
+ // Otherwise continue reading until we do read everything.
+ nbytes -= ret;
+ if ( !nbytes )
+ break;
+
+ buffer += ret;
+ }
}
- }
- return total;
+ return total;
}
wxSocketBase& wxSocketBase::ReadMsg(void* buffer, wxUint32 nbytes)
{
- wxUint32 len, len2, sig, total;
- bool error;
- int old_flags;
- struct
- {
- unsigned char sig[4];
- unsigned char len[4];
- } msg;
-
- // Mask read events
- m_reading = TRUE;
-
- total = 0;
- error = TRUE;
- old_flags = m_flags;
- SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
-
- if (_Read(&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)
- {
- 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;
-
- // 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
+ wxUint32 len, len2, sig, total;
+ bool error;
+ int old_flags;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
+
+ // Mask read events
+ m_reading = true;
+
+ total = 0;
+ error = true;
+ old_flags = m_flags;
+ SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+
+ if (DoRead(&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)
{
- discard_len = ((len2 > MAX_DISCARD_SIZE)? MAX_DISCARD_SIZE : len2);
- discard_len = _Read(discard_buffer, (wxUint32)discard_len);
- len2 -= (wxUint32)discard_len;
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
+ goto exit;
}
- while ((discard_len > 0) && len2);
- delete [] discard_buffer;
+ 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;
+
+ // Don't attempt to read if the msg was zero bytes long.
+ if (len)
+ {
+ total = DoRead(buffer, len);
+
+ if (total != len)
+ goto exit;
+ }
- if (len2 != 0)
- goto exit;
- }
- if (_Read(&msg, sizeof(msg)) != sizeof(msg))
- 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 = DoRead(discard_buffer, (wxUint32)discard_len);
+ len2 -= (wxUint32)discard_len;
+ }
+ while ((discard_len > 0) && len2);
+
+ delete [] discard_buffer;
+
+ if (len2 != 0)
+ goto exit;
+ }
+ if (DoRead(&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);
+ 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)
- {
- wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
- goto exit;
- }
+ if (sig != 0xdeadfeed)
+ {
+ wxLogWarning(_("wxSocket: invalid signature in ReadMsg."));
+ goto exit;
+ }
- // everything was OK
- error = FALSE;
+ // everything was OK
+ error = false;
exit:
- m_error = error;
- m_lcount = total;
- m_reading = FALSE;
- SetFlags(old_flags);
+ m_error = error;
+ m_lcount = total;
+ m_reading = false;
+ SetFlags(old_flags);
- return *this;
+ return *this;
}
wxSocketBase& wxSocketBase::Peek(void* buffer, wxUint32 nbytes)
{
- // Mask read events
- m_reading = TRUE;
+ // Mask read events
+ m_reading = true;
- m_lcount = _Read(buffer, nbytes);
- Pushback(buffer, m_lcount);
+ m_lcount = DoRead(buffer, nbytes);
+ Pushback(buffer, m_lcount);
- // 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);
+ // 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);
- // Allow read events again
- m_reading = FALSE;
+ // Allow read events again
+ m_reading = false;
- return *this;
+ return *this;
}
wxSocketBase& wxSocketBase::Write(const void *buffer, wxUint32 nbytes)
{
- // Mask write events
- m_writing = TRUE;
+ // Mask write events
+ m_writing = true;
- m_lcount = _Write(buffer, nbytes);
+ m_lcount = DoWrite(buffer, nbytes);
- // 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);
+ // 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);
- // Allow write events again
- m_writing = FALSE;
+ // Allow write events again
+ m_writing = false;
- return *this;
+ return *this;
}
-wxUint32 wxSocketBase::_Write(const void *buffer, wxUint32 nbytes)
+// This function is a mirror image of DoRead() except that it doesn't use the
+// push back buffer, please see comments there
+wxUint32 wxSocketBase::DoWrite(const void *buffer_, wxUint32 nbytes)
{
- wxUint32 total = 0;
- int ret = 1;
-
- // 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 (with or without wxSOCKET_BLOCK)
- // wxSOCKET_BLOCK
- // wxSOCKET_NONE
- //
- if (m_flags & wxSOCKET_NOWAIT)
- {
- 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
- {
- bool more = TRUE;
-
- while (more)
+ const char *buffer = static_cast<const char *>(buffer_);
+
+ // Return if there is nothing to read or the socket is (already?) closed.
+ if ( !m_socket || !nbytes )
+ return 0;
+
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
+
+ wxUint32 total = 0;
+ if ( m_flags & wxSOCKET_NOWAIT )
+ {
+ wxSocketUnblocker unblock(m_socket);
+ const int ret = m_socket->Write(buffer, nbytes);
+ if ( ret > 0 )
+ total += ret;
+ }
+ else // blocking socket
{
- if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
- break;
-
- ret = GSocket_Write(m_socket, (const char *)buffer, nbytes);
-
- if (ret > 0)
- {
- total += ret;
- nbytes -= ret;
- buffer = (const char *)buffer + ret;
- }
-
- // Yes, this can happen even when the socket selects as writable!
- // (probably due to a buggy kernel; Linux 2.0.36 seems to do this).
- // Fake it so that we stay in the loop, but do it only for ret < 0,
- // as ret == 0 means that the socket is closed. I'm not applying
- // this hack for read calls as it seems unnecessary there.
- //
- if ((ret < 0) && (GSocket_GetError(m_socket) == GSOCK_WOULDBLOCK))
- {
- wxLogDebug(_("wxSocket: working around select() bug in Write."));
- continue;
- }
-
- // 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));
+ for ( ;; )
+ {
+ if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
+ break;
+
+ const int ret = m_socket->Write(buffer, nbytes);
+ if ( ret == 0 )
+ {
+ m_closed = true;
+ break;
+ }
+
+ if ( ret < 0 )
+ return 0;
+
+ total += ret;
+ if ( !(m_flags & wxSOCKET_WAITALL) )
+ break;
+
+ nbytes -= ret;
+ if ( !nbytes )
+ break;
+
+ buffer += ret;
+ }
}
- }
- return total;
+ return total;
}
wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
{
- wxUint32 total;
- bool error;
- int old_flags;
- struct
- {
- unsigned char sig[4];
- unsigned char len[4];
- } msg;
+ wxUint32 total;
+ bool error;
+ struct
+ {
+ unsigned char sig[4];
+ unsigned char len[4];
+ } msg;
- // Mask write events
- m_writing = TRUE;
+ // Mask write events
+ m_writing = true;
- error = TRUE;
- total = 0;
- old_flags = m_flags;
- SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
+ error = true;
+ total = 0;
+ 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.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);
+ 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(&msg, sizeof(msg)) < sizeof(msg))
- goto exit;
+ if (DoWrite(&msg, sizeof(msg)) < sizeof(msg))
+ goto exit;
- total = _Write(buffer, nbytes);
+ total = DoWrite(buffer, nbytes);
- if (total < nbytes)
- goto exit;
+ 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;
+ 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 ((_Write(&msg, sizeof(msg))) < sizeof(msg))
- goto exit;
+ if ((DoWrite(&msg, sizeof(msg))) < sizeof(msg))
+ goto exit;
- // everything was OK
- error = FALSE;
+ // everything was OK
+ error = false;
exit:
- m_error = error;
- m_lcount = total;
- m_writing = FALSE;
+ m_error = error;
+ m_lcount = total;
+ m_writing = false;
- return *this;
+ return *this;
}
wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
{
- if (nbytes != 0)
- Pushback(buffer, nbytes);
+ if (nbytes != 0)
+ Pushback(buffer, nbytes);
- m_error = FALSE;
- m_lcount = nbytes;
+ m_error = false;
+ m_lcount = nbytes;
- return *this;
+ return *this;
}
wxSocketBase& wxSocketBase::Discard()
{
- int old_flags;
- char *buffer = new char[MAX_DISCARD_SIZE];
- wxUint32 ret;
- wxUint32 total = 0;
+ char *buffer = new char[MAX_DISCARD_SIZE];
+ wxUint32 ret;
+ wxUint32 total = 0;
- // Mask read events
- m_reading = TRUE;
+ // Mask read events
+ m_reading = true;
- old_flags = m_flags;
- SetFlags(wxSOCKET_NOWAIT);
+ SetFlags(wxSOCKET_NOWAIT);
- do
- {
- ret = _Read(buffer, MAX_DISCARD_SIZE);
- total += ret;
- }
- while (ret == MAX_DISCARD_SIZE);
+ do
+ {
+ ret = DoRead(buffer, MAX_DISCARD_SIZE);
+ total += ret;
+ }
+ while (ret == MAX_DISCARD_SIZE);
- delete[] buffer;
- m_lcount = total;
- m_error = FALSE;
+ delete[] buffer;
+ m_lcount = total;
+ m_error = false;
- // Allow read events again
- m_reading = FALSE;
+ // Allow read events again
+ m_reading = false;
- return *this;
+ return *this;
}
// --------------------------------------------------------------------------
// 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
+// timeout elapses. The polling loop runs the event loop so that
// this won't block the GUI.
-bool wxSocketBase::_Wait(long seconds,
- long milliseconds,
- wxSocketEventFlags flags)
+bool
+wxSocketBase::DoWait(long seconds, long milliseconds, wxSocketEventFlags flags)
{
- GSocketEventFlags result;
- long timeout;
-
- // 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;
-
- // Wait in an active polling loop.
- //
- // 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.
-
- wxStopWatch chrono;
- bool done = FALSE;
-
- while (!done)
- {
- result = GSocket_Select(m_socket, flags | GSOCK_LOST_FLAG);
-
- // Incoming connection (server) or connection established (client)
- if (result & GSOCK_CONNECTION_FLAG)
+ wxCHECK_MSG( m_socket, false, "can't wait on invalid socket" );
+
+ // This can be set to true from Interrupt() to exit this function a.s.a.p.
+ m_interrupt = false;
+
+
+ // Use either the provided timeout or the default timeout value associated
+ // with this socket.
+ //
+ // TODO: allow waiting forever, see #9443
+ const long timeout = seconds == -1 ? m_timeout * 1000
+ : seconds * 1000 + milliseconds;
+ const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout;
+
+ // Get the active event loop which we'll use for the message dispatching
+ // when running in the main thread
+ wxEventLoopBase *eventLoop;
+ if ( wxIsMainThread() )
{
- m_connected = TRUE;
- m_establishing = FALSE;
- return TRUE;
- }
+ eventLoop = wxEventLoop::GetActive();
- // Data available or output buffer ready
- if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG))
+#ifdef __WXMSW__
+ wxASSERT_MSG( eventLoop,
+ "Sockets won't work without a running event loop" );
+#endif // __WXMSW__
+ }
+ else // in worker thread
{
- return TRUE;
+ // We never dispatch messages from threads other than the main one.
+ eventLoop = NULL;
}
- // Connection lost
- if (result & GSOCK_LOST_FLAG)
+ // Wait in an active polling loop: notice that the loop is executed at
+ // least once, even if timeout is 0 (i.e. polling).
+ bool gotEvent = false;
+ for ( ;; )
{
- m_connected = FALSE;
- m_establishing = FALSE;
- return (flags & GSOCK_LOST_FLAG) != 0;
+ // We always stop waiting when the connection is lost as it doesn't
+ // make sense to continue further, even if GSOCK_LOST_FLAG is not
+ // specified in flags to wait for.
+ const GSocketEventFlags
+ result = m_socket->Select(flags | GSOCK_LOST_FLAG);
+
+ // Incoming connection (server) or connection established (client)?
+ if ( result & GSOCK_CONNECTION_FLAG )
+ {
+ m_connected = true;
+ m_establishing = false;
+ gotEvent = true;
+ break;
+ }
+
+ // Data available or output buffer ready?
+ if ( (result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG) )
+ {
+ gotEvent = true;
+ break;
+ }
+
+ // Connection lost
+ if ( result & GSOCK_LOST_FLAG )
+ {
+ m_connected = false;
+ m_establishing = false;
+ if ( flags & GSOCK_LOST_FLAG )
+ gotEvent = true;
+ break;
+ }
+
+ if ( m_interrupt )
+ break;
+
+ // Wait more?
+ const wxMilliClock_t timeNow = wxGetLocalTimeMillis();
+ if ( timeNow >= timeEnd )
+ break;
+
+ if ( eventLoop )
+ {
+ // Dispatch the events when we run in the main thread and have an
+ // active event loop: without this sockets don't work at all under
+ // MSW as socket flags are only updated when socket messages are
+ // processed.
+ if ( eventLoop->Pending() )
+ eventLoop->Dispatch();
+ }
+#if wxUSE_THREADS
+ else // no event loop or waiting in another thread
+ {
+ // We're busy waiting but at least give up the rest of our current
+ // time slice.
+ wxThread::Yield();
+ }
+#endif // wxUSE_THREADS
}
- // Wait more?
- if ((!timeout) || (chrono.Time() > timeout) || (m_interrupt))
- done = TRUE;
- else
- PROCESS_EVENTS();
- }
-
- return FALSE;
+ return gotEvent;
}
bool wxSocketBase::Wait(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG |
- GSOCK_OUTPUT_FLAG |
- GSOCK_CONNECTION_FLAG |
- GSOCK_LOST_FLAG);
+ return DoWait(seconds, milliseconds,
+ GSOCK_INPUT_FLAG |
+ GSOCK_OUTPUT_FLAG |
+ GSOCK_CONNECTION_FLAG |
+ GSOCK_LOST_FLAG
+ );
}
bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
{
- // 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);
+ // Check pushback buffer before entering DoWait
+ if ( m_unread )
+ return true;
+
+ // Note that GSOCK_INPUT_LOST has to be explicitly passed to DoWait
+ // because of the semantics of WaitForRead: a return value of true means
+ // that a GSocket_Read call will return immediately, not that there is
+ // actually data to read.
+ return DoWait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG);
}
+
bool wxSocketBase::WaitForWrite(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG);
+ return DoWait(seconds, milliseconds, GSOCK_OUTPUT_FLAG | GSOCK_LOST_FLAG);
}
bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG);
+ return DoWait(seconds, milliseconds, GSOCK_LOST_FLAG);
}
// --------------------------------------------------------------------------
bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
{
- GAddress *peer;
+ GAddress *peer;
+
+ if (!m_socket)
+ return false;
+
+ peer = m_socket->GetPeer();
+
+ // copying a null address would just trigger an assert anyway
- if (!m_socket)
- return FALSE;
+ if (!peer)
+ return false;
- peer = GSocket_GetPeer(m_socket);
- addr_man.SetAddress(peer);
- GAddress_destroy(peer);
+ addr_man.SetAddress(peer);
+ GAddress_destroy(peer);
- return TRUE;
+ return true;
}
bool wxSocketBase::GetLocal(wxSockAddress& addr_man) const
{
- GAddress *local;
+ GAddress *local;
- if (!m_socket)
- return FALSE;
+ if (!m_socket)
+ return false;
- local = GSocket_GetLocal(m_socket);
- addr_man.SetAddress(local);
- GAddress_destroy(local);
+ local = m_socket->GetLocal();
+ addr_man.SetAddress(local);
+ GAddress_destroy(local);
- return TRUE;
+ return true;
}
//
void wxSocketBase::SaveState()
{
- wxSocketState *state;
+ wxSocketState *state;
- state = new wxSocketState();
+ state = new wxSocketState();
- 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
+ state->m_flags = m_flags;
+ state->m_notify = m_notify;
+ state->m_eventmask = m_eventmask;
+ state->m_clientData = m_clientData;
- m_states.Append(state);
+ m_states.Append(state);
}
void wxSocketBase::RestoreState()
{
- wxNode *node;
- wxSocketState *state;
-
- node = m_states.Last();
- if (!node)
- return;
-
- state = (wxSocketState *)node->Data();
-
- 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;
+ wxList::compatibility_iterator node;
+ wxSocketState *state;
+
+ node = m_states.GetLast();
+ if (!node)
+ return;
+
+ state = (wxSocketState *)node->GetData();
+
+ m_flags = state->m_flags;
+ m_notify = state->m_notify;
+ m_eventmask = state->m_eventmask;
+ m_clientData = state->m_clientData;
+
+ m_states.Erase(node);
+ delete state;
}
//
void wxSocketBase::SetTimeout(long seconds)
{
- m_timeout = seconds;
+ m_timeout = seconds;
- if (m_socket)
- GSocket_SetTimeout(m_socket, m_timeout * 1000);
+ if (m_socket)
+ m_socket->SetTimeout(m_timeout * 1000);
}
void wxSocketBase::SetFlags(wxSocketFlags flags)
{
- m_flags = flags;
+ // Do some sanity checking on the flags used: not all values can be used
+ // together.
+ wxASSERT_MSG( !(flags & wxSOCKET_NOWAIT) ||
+ !(flags & (wxSOCKET_WAITALL | wxSOCKET_BLOCK)),
+ "Using wxSOCKET_WAITALL or wxSOCKET_BLOCK with "
+ "wxSOCKET_NOWAIT doesn't make sense" );
+
+ m_flags = flags;
}
-// --------------------------------------------------------------------------
-// Callbacks (now obsolete - use events instead)
-// --------------------------------------------------------------------------
-
-#if WXWIN_COMPATIBILITY
-
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
-{
- wxSockCbk old_cbk = cbk_;
-
- m_cbk = cbk_;
- return old_cbk;
-}
-
-char *wxSocketBase::CallbackData(char *data)
-{
- char *old_data = m_cdata;
-
- m_cdata = data;
- return old_data;
-}
-
-#endif // WXWIN_COMPATIBILITY
-
// --------------------------------------------------------------------------
// Event handling
// --------------------------------------------------------------------------
// 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 notification,
- char *cdata)
+extern "C"
+void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
+ GSocketEvent notification,
+ char *cdata)
{
- wxSocketBase *sckobj = (wxSocketBase *)cdata;
+ wxSocketBase *sckobj = (wxSocketBase *)cdata;
- sckobj->OnRequest((wxSocketNotify) notification);
+ sckobj->OnRequest((wxSocketNotify) notification);
}
void wxSocketBase::OnRequest(wxSocketNotify notification)
{
- // NOTE: We duplicate some of the code in _Wait, but this doesn't
- // hurt. It has to be here because the (GSocket) event might arrive
- // a bit delayed, and it has to be in _Wait as well because we don't
- // know whether the Wait functions are being used.
-
- switch(notification)
- {
- case wxSOCKET_CONNECTION:
- m_establishing = FALSE;
- m_connected = TRUE;
- break;
-
- // 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;
- }
-
- // 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)
+ switch(notification)
{
- wxSocketEvent event(m_id);
- event.m_event = notification;
- event.m_clientData = m_clientData;
- event.SetEventObject(this);
+ 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 || !m_socket->Select(GSOCK_INPUT_FLAG))
+ return;
+ break;
+
+ case wxSOCKET_OUTPUT:
+ if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG))
+ return;
+ break;
+
+ case wxSOCKET_LOST:
+ m_connected = false;
+ m_establishing = false;
+ break;
+ }
- m_handler->AddPendingEvent(event);
+ // Schedule the event
+
+ wxSocketEventFlags flag = 0;
+ wxUnusedVar(flag);
+ 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 WXWIN_COMPATIBILITY
- if (m_cbk)
- m_cbk(*this, notification, m_cdata);
-#endif // WXWIN_COMPATIBILITY
- }
+ if (((m_eventmask & flag) == flag) && m_notify)
+ {
+ if (m_handler)
+ {
+ wxSocketEvent event(m_id);
+ event.m_event = notification;
+ event.m_clientData = m_clientData;
+ event.SetEventObject(this);
+
+ m_handler->AddPendingEvent(event);
+ }
+ }
}
void wxSocketBase::Notify(bool notify)
{
- m_notify = notify;
+ m_notify = notify;
+ if (m_socket)
+ m_socket->Notify(notify);
}
void wxSocketBase::SetNotify(wxSocketEventFlags flags)
{
- m_eventmask = flags;
+ m_eventmask = flags;
}
void wxSocketBase::SetEventHandler(wxEvtHandler& handler, int id)
{
- m_handler = &handler;
- m_id = id;
+ m_handler = &handler;
+ m_id = id;
}
// --------------------------------------------------------------------------
void wxSocketBase::Pushback(const void *buffer, wxUint32 size)
{
- if (!size) return;
+ if (!size) return;
- if (m_unread == NULL)
- m_unread = malloc(size);
- else
- {
- void *tmp;
+ if (m_unread == NULL)
+ m_unread = malloc(size);
+ else
+ {
+ void *tmp;
- tmp = malloc(m_unrd_size + size);
- memcpy((char *)tmp + size, m_unread, m_unrd_size);
- free(m_unread);
+ tmp = malloc(m_unrd_size + size);
+ memcpy((char *)tmp + size, m_unread, m_unrd_size);
+ free(m_unread);
- m_unread = tmp;
- }
+ m_unread = tmp;
+ }
- m_unrd_size += size;
+ m_unrd_size += size;
- memcpy(m_unread, buffer, size);
+ memcpy(m_unread, buffer, size);
}
wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek)
{
- if (!m_unrd_size)
- return 0;
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
+
+ if (!m_unrd_size)
+ return 0;
- if (size > (m_unrd_size-m_unrd_cur))
- size = m_unrd_size-m_unrd_cur;
+ if (size > (m_unrd_size-m_unrd_cur))
+ size = m_unrd_size-m_unrd_cur;
- memcpy(buffer, (char *)m_unread + m_unrd_cur, size);
+ memcpy(buffer, (char *)m_unread + m_unrd_cur, size);
- if (!peek)
- {
- m_unrd_cur += size;
- if (m_unrd_size == m_unrd_cur)
+ if (!peek)
{
- free(m_unread);
- m_unread = NULL;
- m_unrd_size = 0;
- m_unrd_cur = 0;
+ m_unrd_cur += size;
+ if (m_unrd_size == m_unrd_cur)
+ {
+ free(m_unread);
+ m_unread = NULL;
+ m_unrd_size = 0;
+ m_unrd_cur = 0;
+ }
}
- }
- return size;
+ return size;
}
// ==========================================================================
-// wxSocketServer
+// wxSocketServer
// ==========================================================================
// --------------------------------------------------------------------------
// Ctor
// --------------------------------------------------------------------------
-wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
+wxSocketServer::wxSocketServer(const wxSockAddress& addr_man,
wxSocketFlags flags)
: wxSocketBase(flags, wxSOCKET_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)
- {
- GSocket_destroy(m_socket);
- m_socket = NULL;
- return;
- }
-
- 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);
+ wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") );
+
+ m_socket = GSocket_new();
+ if (!m_socket)
+ {
+ wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") );
+ return;
+ }
+
+ // Setup the socket as server
+ m_socket->Notify(m_notify);
+ m_socket->SetLocal(addr_man.GetAddress());
+
+ if (GetFlags() & wxSOCKET_REUSEADDR) {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST) {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND) {
+ m_socket->DontDoBind();
+ }
+
+ if (m_socket->SetServer() != GSOCK_NOERROR)
+ {
+ delete m_socket;
+ m_socket = NULL;
+
+ wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") );
+ return;
+ }
+
+ m_socket->SetTimeout(m_timeout * 1000);
+ m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char *)this);
+
+ wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_socket->m_fd );
}
// --------------------------------------------------------------------------
bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
- GSocket *child_socket;
+ if (!m_socket)
+ return false;
- 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.
+ wxSocketUnblocker unblock(m_socket, !wait);
+ GSocket * const child_socket = m_socket->WaitConnection();
- // If wait == FALSE, then the call should be nonblocking.
- // When we are finished, we put the socket to blocking mode
- // again.
+ if (!child_socket)
+ return false;
- if (!wait)
- GSocket_SetNonBlocking(m_socket, 1);
+ sock.m_type = wxSOCKET_BASE;
+ sock.m_socket = child_socket;
+ sock.m_connected = true;
- child_socket = GSocket_WaitConnection(m_socket);
+ sock.m_socket->SetTimeout(sock.m_timeout * 1000);
+ sock.m_socket->SetCallback(GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char *)&sock);
- if (!wait)
- GSocket_SetNonBlocking(m_socket, 0);
+ return true;
+}
- if (!child_socket)
- return FALSE;
+wxSocketBase *wxSocketServer::Accept(bool wait)
+{
+ wxSocketBase* sock = new wxSocketBase();
- sock.m_type = wxSOCKET_BASE;
- sock.m_socket = child_socket;
- sock.m_connected = TRUE;
+ sock->SetFlags(m_flags);
- 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);
+ if (!AcceptWith(*sock, wait))
+ {
+ sock->Destroy();
+ sock = NULL;
+ }
- return TRUE;
+ return sock;
}
-wxSocketBase *wxSocketServer::Accept(bool wait)
+bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
- wxSocketBase* sock = new wxSocketBase();
+ return DoWait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
+}
- sock->SetFlags(m_flags);
+bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
+{
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
- if (!AcceptWith(*sock, wait))
- return NULL;
+ if (m_socket->GetSockOpt(level, optname, optval, optlen)
+ != GSOCK_NOERROR)
+ {
+ return false;
+ }
+ return true;
+}
- return sock;
+bool wxSocketBase::SetOption(int level, int optname, const void *optval,
+ int optlen)
+{
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+
+ if (m_socket->SetSockOpt(level, optname, optval, optlen)
+ != GSOCK_NOERROR)
+ {
+ return false;
+ }
+ return true;
}
-bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
+bool wxSocketBase::SetLocal(const wxIPV4address& local)
{
- return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
+ GAddress* la = local.GetAddress();
+
+ // If the address is valid, save it for use when we call Connect
+ if (la && la->m_addr)
+ {
+ m_localAddress = local;
+
+ return true;
+ }
+
+ return false;
}
// ==========================================================================
wxSocketClient::wxSocketClient(wxSocketFlags flags)
: wxSocketBase(flags, wxSOCKET_CLIENT)
{
+ m_initialRecvBufferSize =
+ m_initialSendBufferSize = -1;
}
wxSocketClient::~wxSocketClient()
// Connect
// --------------------------------------------------------------------------
-bool wxSocketClient::Connect(wxSockAddress& addr_man, bool wait)
+bool wxSocketClient::DoConnect(const wxSockAddress& addr_man,
+ const wxSockAddress* local,
+ bool wait)
{
- GSocketError err;
+ if (m_socket)
+ {
+ // Shutdown and destroy the socket
+ Close();
+ delete m_socket;
+ }
- if (m_socket)
- {
- // Shutdown and destroy the socket
- Close();
- GSocket_destroy(m_socket);
- }
+ m_socket = GSocket_new();
+ m_connected = false;
+ m_establishing = false;
+
+ if (!m_socket)
+ return false;
+
+ m_socket->SetTimeout(m_timeout * 1000);
+ m_socket->SetCallback(
+ GSOCK_INPUT_FLAG |
+ GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG |
+ GSOCK_CONNECTION_FLAG,
+ wx_socket_callback,
+ (char *)this
+ );
+
+ // If wait == false, then the call should be nonblocking. When we are
+ // finished, we put the socket to blocking mode again.
+ wxSocketUnblocker unblock(m_socket, !wait);
+
+ // Reuse makes sense for clients too, if we are trying to rebind to the same port
+ if (GetFlags() & wxSOCKET_REUSEADDR)
+ {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST)
+ {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND)
+ {
+ m_socket->DontDoBind();
+ }
- m_socket = GSocket_new();
- m_connected = FALSE;
- m_establishing = FALSE;
+ // If no local address was passed and one has been set, use the one that was Set
+ if (!local && m_localAddress.GetAddress())
+ {
+ local = &m_localAddress;
+ }
- if (!m_socket)
- return FALSE;
+ // Bind to the local IP address and port, when provided
+ if (local)
+ {
+ GAddress* la = local->GetAddress();
- 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 (la && la->m_addr)
+ m_socket->SetLocal(la);
+ }
- // If wait == FALSE, then the call should be nonblocking.
- // When we are finished, we put the socket to blocking mode
- // again.
+#if defined(__WXMSW__) || defined(__WXGTK__)
+ m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
+#endif
- if (!wait)
- GSocket_SetNonBlocking(m_socket, 1);
+ m_socket->SetPeer(addr_man.GetAddress());
+ const GSocketError err = m_socket->Connect(GSOCK_STREAMED);
- GSocket_SetPeer(m_socket, addr_man.GetAddress());
- err = GSocket_Connect(m_socket, GSOCK_STREAMED);
+ //this will register for callbacks - must be called after m_socket->m_fd was initialized
+ m_socket->Notify(m_notify);
- if (!wait)
- GSocket_SetNonBlocking(m_socket, 0);
+ if (err != GSOCK_NOERROR)
+ {
+ if (err == GSOCK_WOULDBLOCK)
+ m_establishing = true;
- if (err != GSOCK_NOERROR)
- {
- if (err == GSOCK_WOULDBLOCK)
- m_establishing = TRUE;
+ return false;
+ }
- return FALSE;
- }
+ m_connected = true;
+ return true;
+}
- m_connected = TRUE;
- return TRUE;
+bool wxSocketClient::Connect(const wxSockAddress& addr_man, bool wait)
+{
+ return DoConnect(addr_man, NULL, wait);
+}
+
+bool wxSocketClient::Connect(const wxSockAddress& addr_man,
+ const wxSockAddress& local,
+ bool wait)
+{
+ return DoConnect(addr_man, &local, wait);
}
bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds)
{
- if (m_connected) // Already connected
- return TRUE;
+ if ( m_connected )
+ {
+ // this happens if the initial attempt to connect succeeded without
+ // blocking
+ return true;
+ }
- if (!m_establishing || !m_socket) // No connection in progress
- return FALSE;
+ wxCHECK_MSG( m_establishing && m_socket, false,
+ "No connection establishment attempt in progress" );
- return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG |
- GSOCK_LOST_FLAG);
+ // we must specify GSOCK_LOST_FLAG here explicitly because we must return
+ // true if the connection establishment process is finished, whether it is
+ // over because we successfully connected or because we were not able to
+ // connect
+ return DoWait(seconds, milliseconds,
+ GSOCK_CONNECTION_FLAG | GSOCK_LOST_FLAG);
}
// ==========================================================================
/* NOTE: experimental stuff - might change */
-wxDatagramSocket::wxDatagramSocket( wxSockAddress& addr,
+wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
wxSocketFlags flags )
: wxSocketBase( flags, wxSOCKET_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 );
+ // Create the socket
+ m_socket = GSocket_new();
+
+ if (!m_socket)
+ {
+ wxFAIL_MSG( _T("datagram socket not new'd") );
+ return;
+ }
+ m_socket->Notify(m_notify);
+ // Setup the socket as non connection oriented
+ m_socket->SetLocal(addr.GetAddress());
+ if (flags & wxSOCKET_REUSEADDR)
+ {
+ m_socket->SetReusable();
+ }
+ if (GetFlags() & wxSOCKET_BROADCAST)
+ {
+ m_socket->SetBroadcast();
+ }
+ if (GetFlags() & wxSOCKET_NOBIND)
+ {
+ m_socket->DontDoBind();
+ }
+ if ( m_socket->SetNonOriented() != GSOCK_NOERROR )
+ {
+ delete m_socket;
+ m_socket = NULL;
+ return;
+ }
+ // Initialize all stuff
+ m_connected = false;
+ m_establishing = false;
+ m_socket->SetTimeout( m_timeout );
+ m_socket->SetCallback( GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+ GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+ wx_socket_callback, (char*)this );
}
wxDatagramSocket& wxDatagramSocket::RecvFrom( wxSockAddress& addr,
return (*this);
}
-wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr,
+wxDatagramSocket& wxDatagramSocket::SendTo( const wxSockAddress& addr,
const void* buf,
wxUint32 nBytes )
{
- GSocket_SetPeer(m_socket, addr.GetAddress());
+ wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+
+ m_socket->SetPeer(addr.GetAddress());
Write(buf, nBytes);
return (*this);
}
-// ==========================================================================
-// wxSocketEvent
-// ==========================================================================
-
-wxSocketEvent::wxSocketEvent(int id) : wxEvent(id)
-{
- SetEventType( (wxEventType)wxEVT_SOCKET );
-}
-
-void wxSocketEvent::CopyObject(wxObject& object_dest) const
-{
- wxSocketEvent *event = (wxSocketEvent *)&object_dest;
-
- wxEvent::CopyObject(object_dest);
-
- event->m_event = m_event;
- event->m_clientData = m_clientData;
-}
-
// ==========================================================================
// wxSocketModule
// ==========================================================================
-class WXDLLEXPORT wxSocketModule : public wxModule
+class wxSocketModule : public wxModule
{
- DECLARE_DYNAMIC_CLASS(wxSocketModule)
-
public:
- bool OnInit() { return GSocket_Init(); }
- void OnExit() { GSocket_Cleanup(); }
+ virtual bool OnInit()
+ {
+ // wxSocketBase will call GSocket_Init() itself when/if needed
+ return true;
+ }
+
+ virtual void OnExit()
+ {
+ if ( wxSocketBase::IsInitialized() )
+ wxSocketBase::Shutdown();
+ }
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxSocketModule)
};
IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
-#endif
- // wxUSE_SOCKETS
+#endif // wxUSE_SOCKETS
projects / wxWidgets.git / blobdiff