// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
// Created: April 1997
// Copyright: (C) 1999-1997, Guilhem Lavaux
-// (C) 2000-1999, Guillermo Rodriguez Garcia
+// (C) 1999-2000, Guillermo Rodriguez Garcia
+// (C) 2008 Vadim Zeitlin
// RCS_ID: $Id$
// License: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/thread.h"
#include "wx/evtloop.h"
+#include "wx/private/fd.h"
+#include "wx/private/socket.h"
+
// DLL options compatibility check:
#include "wx/build.h"
WX_CHECK_BUILD_OPTIONS("wxNet")
DECLARE_NO_COPY_CLASS(wxSocketState)
};
+// Conditionally make the socket non-blocking for the lifetime of this object.
+class wxSocketUnblocker
+{
+public:
+ wxSocketUnblocker(wxSocketImpl *socket, bool unblock = true)
+ : m_impl(socket),
+ m_unblock(unblock)
+ {
+ if ( m_unblock )
+ m_impl->SetNonBlocking(true);
+ }
+
+ ~wxSocketUnblocker()
+ {
+ if ( m_unblock )
+ m_impl->SetNonBlocking(false);
+ }
+
+private:
+ wxSocketImpl * const m_impl;
+ bool m_unblock;
+
+ DECLARE_NO_COPY_CLASS(wxSocketUnblocker)
+};
+
// ============================================================================
-// GSocketManager
+// wxSocketManager
// ============================================================================
-GSocketManager *GSocketManager::ms_manager = NULL;
+wxSocketManager *wxSocketManager::ms_manager = NULL;
/* static */
-void GSocketManager::Set(GSocketManager *manager)
+void wxSocketManager::Set(wxSocketManager *manager)
{
wxASSERT_MSG( !ms_manager, "too late to set manager now" );
}
/* static */
-void GSocketManager::Init()
+void wxSocketManager::Init()
{
wxASSERT_MSG( !ms_manager, "shouldn't be initialized twice" );
ms_manager = app->GetTraits()->GetSocketManager();
}
+// ==========================================================================
+// wxSocketImpl
+// ==========================================================================
+
+wxSocketImpl::wxSocketImpl(wxSocketBase& wxsocket)
+ : m_wxsocket(&wxsocket)
+{
+ m_fd = INVALID_SOCKET;
+ m_detected = 0;
+ m_local = NULL;
+ m_peer = NULL;
+ m_error = wxSOCKET_NOERROR;
+ m_server = false;
+ m_stream = true;
+ m_non_blocking = false;
+
+ SetTimeout(wxsocket.GetTimeout() * 1000);
+
+ m_establishing = false;
+ m_reusable = false;
+ m_broadcast = false;
+ m_dobind = true;
+ m_initialRecvBufferSize = -1;
+ m_initialSendBufferSize = -1;
+}
+
+wxSocketImpl::~wxSocketImpl()
+{
+ if (m_fd != INVALID_SOCKET)
+ Shutdown();
+
+ if (m_local)
+ GAddress_destroy(m_local);
+
+ if (m_peer)
+ GAddress_destroy(m_peer);
+}
+
+bool wxSocketImpl::PreCreateCheck(GAddress *addr)
+{
+ if ( m_fd != INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return false;
+ }
+
+ if ( !addr || !addr->m_addr )
+ {
+ m_error = wxSOCKET_INVADDR;
+ return false;
+ }
+
+ return true;
+}
+
+void wxSocketImpl::PostCreation()
+{
+ // FreeBSD variants can't use MSG_NOSIGNAL, and instead use a socket option
+#ifdef SO_NOSIGPIPE
+ EnableSocketOption(SO_NOSIGPIPE);
+#endif
+
+ if ( m_reusable )
+ EnableSocketOption(SO_REUSEADDR);
+
+ if ( m_broadcast )
+ {
+ wxASSERT_MSG( !m_stream, "broadcasting is for datagram sockets only" );
+
+ EnableSocketOption(SO_BROADCAST);
+ }
+
+ if ( m_initialRecvBufferSize >= 0 )
+ SetSocketOption(SO_RCVBUF, m_initialRecvBufferSize);
+ if ( m_initialSendBufferSize >= 0 )
+ SetSocketOption(SO_SNDBUF, m_initialSendBufferSize);
+
+ // FIXME: shouldn't we check for m_non_blocking here? as it is now, all our
+ // sockets are non-blocking
+ UnblockAndRegisterWithEventLoop();
+}
+
+wxSocketError wxSocketImpl::UpdateLocalAddress()
+{
+ WX_SOCKLEN_T lenAddr;
+ if ( getsockname(m_fd, m_local->m_addr, &lenAddr) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+
+ m_local->m_len = lenAddr;
+
+ return wxSOCKET_NOERROR;
+}
+
+wxSocketError wxSocketImpl::CreateServer()
+{
+ if ( !PreCreateCheck(m_local) )
+ return m_error;
+
+ m_server = true;
+ m_stream = true;
+
+ // do create the socket
+ m_fd = socket(m_local->m_realfamily, SOCK_STREAM, 0);
+
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
+
+ PostCreation();
+
+ // and then bind to and listen on it
+ //
+ // FIXME: should we test for m_dobind here?
+ if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ m_error = wxSOCKET_IOERR;
+
+ if ( IsOk() )
+ {
+ if ( listen(m_fd, 5) != 0 )
+ m_error = wxSOCKET_IOERR;
+ }
+
+ if ( !IsOk() )
+ {
+ Close();
+ return m_error;
+ }
+
+ // finally retrieve the address we effectively bound to
+ return UpdateLocalAddress();
+}
+
+wxSocketError wxSocketImpl::CreateClient()
+{
+ if ( !PreCreateCheck(m_peer) )
+ return m_error;
+
+ m_fd = socket(m_peer->m_realfamily, SOCK_STREAM, 0);
+
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
+
+ PostCreation();
+
+ // If a local address has been set, then bind to it before calling connect
+ if ( m_local && m_local->m_addr )
+ {
+ if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+ }
+
+ // Connect to the peer and handle the EWOULDBLOCK return value in
+ // platform-specific code
+ return DoHandleConnect(connect(m_fd, m_peer->m_addr, m_peer->m_len));
+}
+
+
+wxSocketError wxSocketImpl::CreateUDP()
+{
+ if ( !PreCreateCheck(m_local) )
+ return m_error;
+
+ m_stream = false;
+ m_server = false;
+
+ m_fd = socket(m_local->m_realfamily, SOCK_DGRAM, 0);
+
+ if ( m_fd == INVALID_SOCKET )
+ {
+ m_error = wxSOCKET_IOERR;
+ return wxSOCKET_IOERR;
+ }
+
+ PostCreation();
+
+ if ( m_dobind )
+ {
+ if ( bind(m_fd, m_local->m_addr, m_local->m_len) != 0 )
+ {
+ Close();
+ m_error = wxSOCKET_IOERR;
+ return m_error;
+ }
+
+ return UpdateLocalAddress();
+ }
+
+ return wxSOCKET_NOERROR;
+}
+
+
+void wxSocketImpl::Close()
+{
+ if ( m_fd != INVALID_SOCKET )
+ {
+ DoClose();
+ m_fd = INVALID_SOCKET;
+ }
+}
+
+/*
+ * Disallow further read/write operations on this socket, close
+ * the fd and disable all callbacks.
+ */
+void wxSocketImpl::Shutdown()
+{
+ if ( m_fd != INVALID_SOCKET )
+ {
+ shutdown(m_fd, 1 /* SD_SEND */);
+ Close();
+ }
+
+ m_detected = wxSOCKET_LOST_FLAG;
+}
+
+/*
+ * Sets the timeout for blocking calls. Time is expressed in
+ * milliseconds.
+ */
+void wxSocketImpl::SetTimeout(unsigned long millis)
+{
+ m_timeout.tv_sec = (millis / 1000);
+ m_timeout.tv_usec = (millis % 1000) * 1000;
+}
+
+void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event)
+{
+ m_wxsocket->OnRequest(event);
+}
+
+/* Address handling */
+
+/*
+ * Set or get the local or peer address for this socket. The 'set'
+ * functions return wxSOCKET_NOERROR on success, an error code otherwise.
+ * The 'get' functions return a pointer to a GAddress object on success,
+ * or NULL otherwise, in which case they set the error code of the
+ * corresponding socket.
+ *
+ * Error codes:
+ * wxSOCKET_INVSOCK - the socket is not valid.
+ * wxSOCKET_INVADDR - the address is not valid.
+ */
+wxSocketError wxSocketImpl::SetLocal(GAddress *address)
+{
+ /* the socket must be initialized, or it must be a server */
+ if (m_fd != INVALID_SOCKET && !m_server)
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return wxSOCKET_INVSOCK;
+ }
+
+ /* check address */
+ if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
+
+ if (m_local)
+ GAddress_destroy(m_local);
+
+ m_local = GAddress_copy(address);
+
+ return wxSOCKET_NOERROR;
+}
+
+wxSocketError wxSocketImpl::SetPeer(GAddress *address)
+{
+ /* check address */
+ if (address == NULL || address->m_family == wxSOCKET_NOFAMILY)
+ {
+ m_error = wxSOCKET_INVADDR;
+ return wxSOCKET_INVADDR;
+ }
+
+ if (m_peer)
+ GAddress_destroy(m_peer);
+
+ m_peer = GAddress_copy(address);
+
+ return wxSOCKET_NOERROR;
+}
+
+GAddress *wxSocketImpl::GetLocal()
+{
+ GAddress *address;
+ wxSockAddr addr;
+ WX_SOCKLEN_T size = sizeof(addr);
+ wxSocketError err;
+
+ /* try to get it from the m_local var first */
+ if (m_local)
+ return GAddress_copy(m_local);
+
+ /* else, if the socket is initialized, try getsockname */
+ if (m_fd == INVALID_SOCKET)
+ {
+ m_error = wxSOCKET_INVSOCK;
+ return NULL;
+ }
+
+ if (getsockname(m_fd, (sockaddr*)&addr, &size) == SOCKET_ERROR)
+ {
+ m_error = wxSOCKET_IOERR;
+ return NULL;
+ }
+
+ /* got a valid address from getsockname, create a GAddress object */
+ if ((address = GAddress_new()) == NULL)
+ {
+ m_error = wxSOCKET_MEMERR;
+ return NULL;
+ }
+
+ if ((err = _GAddress_translate_from(address, (sockaddr*)&addr, size)) != wxSOCKET_NOERROR)
+ {
+ GAddress_destroy(address);
+ m_error = err;
+ return NULL;
+ }
+
+ return address;
+}
+
+GAddress *wxSocketImpl::GetPeer()
+{
+ /* try to get it from the m_peer var */
+ if (m_peer)
+ return GAddress_copy(m_peer);
+
+ return NULL;
+}
+
// ==========================================================================
// wxSocketBase
// ==========================================================================
{
if ( !m_countInit++ )
{
- if ( !GSocket_Init() )
+ wxSocketManager * const manager = wxSocketManager::Get();
+ if ( !manager || !manager->OnInit() )
{
m_countInit--;
wxASSERT_MSG( m_countInit > 0, _T("extra call to Shutdown()") );
if ( --m_countInit == 0 )
{
- GSocket_Cleanup();
+ wxSocketManager * const manager = wxSocketManager::Get();
+ wxCHECK_RET( manager, "should have a socket manager" );
+
+ manager->OnExit();
}
}
void wxSocketBase::Init()
{
- m_socket = NULL;
+ m_impl = NULL;
m_type = wxSOCKET_UNINIT;
// state
{
Init();
- m_flags = flags;
- m_type = type;
+ SetFlags(flags);
+
+ m_type = type;
}
wxSocketBase::~wxSocketBase()
if (!m_beingDeleted)
Close();
- // Destroy the GSocket object
- if (m_socket)
- delete m_socket;
+ // Destroy the implementation object
+ delete m_impl;
// Free the pushback buffer
if (m_unread)
return true;
}
+// ----------------------------------------------------------------------------
+// simply accessors
+// ----------------------------------------------------------------------------
+
+wxSocketError wxSocketBase::LastError() const
+{
+ return m_impl->GetError();
+}
+
// --------------------------------------------------------------------------
// Basic IO calls
// --------------------------------------------------------------------------
// 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();
- }
+ if (m_impl)
+ m_impl->Shutdown();
m_connected = false;
m_establishing = false;
// 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)
return *this;
}
-wxUint32 wxSocketBase::_Read(void* buffer_, wxUint32 nbytes)
+wxUint32 wxSocketBase::DoRead(void* buffer_, wxUint32 nbytes)
{
- char *buffer = (char *)buffer_;
-
- int total;
+ // We use pointer arithmetic here which doesn't work with void pointers.
+ char *buffer = static_cast<char *>(buffer_);
- // Try the pushback buffer first
- total = GetPushback(buffer, nbytes, false);
+ // 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 = (char *)buffer + total;
+ buffer += total;
- // Return now in one of the following cases:
- // - the socket is invalid,
- // - we got all the data
- if ( !m_socket ||
- !nbytes )
+ // If it's indeed closed or if read everything, there is nothing more to do.
+ if ( !m_impl || !nbytes )
return total;
- // Possible combinations (they are checked in this order)
- // wxSOCKET_NOWAIT
- // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
- // wxSOCKET_BLOCK
- // wxSOCKET_NONE
- //
- int ret;
- if (m_flags & wxSOCKET_NOWAIT)
- {
- m_socket->SetNonBlocking(1);
- ret = m_socket->Read(buffer, nbytes);
- m_socket->SetNonBlocking(0);
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
+
+ // 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_impl);
+ int ret = m_impl->Read(buffer, nbytes);
if ( ret < 0 )
return 0;
{
for ( ;; )
{
- // dispatch events unless disabled
+ // 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;
- ret = m_socket->Read(buffer, nbytes);
+ const int ret = m_impl->Read(buffer, nbytes);
if ( ret == 0 )
{
// for connection-oriented (e.g. TCP) sockets we can only read
total += ret;
- // if wxSOCKET_WAITALL is not set, we can leave now as we did read
- // something
+ // 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 check if read the maximal requested amount of data
+ // Otherwise continue reading until we do read everything.
nbytes -= ret;
if ( !nbytes )
break;
- // we didn't, so continue reading
- buffer = (char *)buffer + ret;
+ buffer += ret;
}
}
old_flags = m_flags;
SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
- if (_Read(&msg, sizeof(msg)) != sizeof(msg))
+ if (DoRead(&msg, sizeof(msg)) != sizeof(msg))
goto exit;
sig = (wxUint32)msg.sig[0];
// Don't attempt to read if the msg was zero bytes long.
if (len)
{
- total = _Read(buffer, len);
+ total = DoRead(buffer, len);
if (total != len)
goto exit;
do
{
discard_len = ((len2 > MAX_DISCARD_SIZE)? MAX_DISCARD_SIZE : len2);
- discard_len = _Read(discard_buffer, (wxUint32)discard_len);
+ discard_len = DoRead(discard_buffer, (wxUint32)discard_len);
len2 -= (wxUint32)discard_len;
}
while ((discard_len > 0) && len2);
if (len2 != 0)
goto exit;
}
- if (_Read(&msg, sizeof(msg)) != sizeof(msg))
+ if (DoRead(&msg, sizeof(msg)) != sizeof(msg))
goto exit;
sig = (wxUint32)msg.sig[0];
// Mask read events
m_reading = true;
- m_lcount = _Read(buffer, nbytes);
+ m_lcount = DoRead(buffer, nbytes);
Pushback(buffer, m_lcount);
// If in wxSOCKET_WAITALL mode, all bytes should have been read.
// 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)
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)
{
- const char *buffer = (const char *)buffer_;
-
- wxUint32 total = 0;
+ const char *buffer = static_cast<const char *>(buffer_);
- // If the socket is invalid or parameters are ill, return immediately
- if (!m_socket || !buffer || !nbytes)
+ // Return if there is nothing to read or the socket is (already?) closed.
+ if ( !m_impl || !nbytes )
return 0;
- // Possible combinations (they are checked in this order)
- // wxSOCKET_NOWAIT
- // wxSOCKET_WAITALL (with or without wxSOCKET_BLOCK)
- // wxSOCKET_BLOCK
- // wxSOCKET_NONE
- //
- int ret;
- if (m_flags & wxSOCKET_NOWAIT)
- {
- m_socket->SetNonBlocking(1);
- ret = m_socket->Write(buffer, nbytes);
- m_socket->SetNonBlocking(0);
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
- if (ret > 0)
- total = ret;
+ wxUint32 total = 0;
+ if ( m_flags & wxSOCKET_NOWAIT )
+ {
+ wxSocketUnblocker unblock(m_impl);
+ const int ret = m_impl->Write(buffer, nbytes);
+ if ( ret > 0 )
+ total += ret;
}
else // blocking socket
{
if ( !(m_flags & wxSOCKET_BLOCK) && !WaitForWrite() )
break;
- ret = m_socket->Write(buffer, nbytes);
-
- // see comments for similar logic for ret handling in _Read()
+ const int ret = m_impl->Write(buffer, nbytes);
if ( ret == 0 )
{
m_closed = true;
}
if ( ret < 0 )
- {
return 0;
- }
total += ret;
if ( !(m_flags & wxSOCKET_WAITALL) )
if ( !nbytes )
break;
- buffer = (const char *)buffer + ret;
+ buffer += ret;
}
}
msg.len[2] = (unsigned char) ((nbytes >> 16) & 0xff);
msg.len[3] = (unsigned char) ((nbytes >> 24) & 0xff);
- if (_Write(&msg, sizeof(msg)) < sizeof(msg))
+ if (DoWrite(&msg, sizeof(msg)) < sizeof(msg))
goto exit;
- total = _Write(buffer, nbytes);
+ total = DoWrite(buffer, nbytes);
if (total < nbytes)
goto exit;
msg.len[2] =
msg.len[3] = (char) 0;
- if ((_Write(&msg, sizeof(msg))) < sizeof(msg))
+ if ((DoWrite(&msg, sizeof(msg))) < sizeof(msg))
goto exit;
// everything was OK
do
{
- ret = _Read(buffer, MAX_DISCARD_SIZE);
+ ret = DoRead(buffer, MAX_DISCARD_SIZE);
total += ret;
}
while (ret == MAX_DISCARD_SIZE);
// Wait functions
// --------------------------------------------------------------------------
-// All Wait functions poll the socket using GSocket_Select() to
+/*
+ * Polls the socket to determine its status. This function will
+ * check for the events specified in the 'flags' parameter, and
+ * it will return a mask indicating which operations can be
+ * performed. This function won't block, regardless of the
+ * mode (blocking | nonblocking) of the socket.
+ */
+wxSocketEventFlags wxSocketImpl::Select(wxSocketEventFlags flags)
+{
+ assert(this);
+
+ wxSocketEventFlags result = 0;
+ fd_set readfds;
+ fd_set writefds;
+ fd_set exceptfds;
+ struct timeval tv;
+
+ if (m_fd == -1)
+ return (wxSOCKET_LOST_FLAG & flags);
+
+ /* Do not use a static struct, Linux can garble it */
+ tv.tv_sec = 0;
+ tv.tv_usec = 0;
+
+ wxFD_ZERO(&readfds);
+ wxFD_ZERO(&writefds);
+ wxFD_ZERO(&exceptfds);
+ wxFD_SET(m_fd, &readfds);
+ if (flags & wxSOCKET_OUTPUT_FLAG || flags & wxSOCKET_CONNECTION_FLAG)
+ wxFD_SET(m_fd, &writefds);
+ wxFD_SET(m_fd, &exceptfds);
+
+ /* Check 'sticky' CONNECTION flag first */
+ result |= wxSOCKET_CONNECTION_FLAG & m_detected;
+
+ /* If we have already detected a LOST event, then don't try
+ * to do any further processing.
+ */
+ if ((m_detected & wxSOCKET_LOST_FLAG) != 0)
+ {
+ m_establishing = false;
+ return (wxSOCKET_LOST_FLAG & flags);
+ }
+
+ /* Try select now */
+ if (select(m_fd + 1, &readfds, &writefds, &exceptfds, &tv) < 0)
+ {
+ /* What to do here? */
+ return (result & flags);
+ }
+
+ /* Check for exceptions and errors */
+ if (wxFD_ISSET(m_fd, &exceptfds))
+ {
+ m_establishing = false;
+ m_detected = wxSOCKET_LOST_FLAG;
+
+ /* LOST event: Abort any further processing */
+ return (wxSOCKET_LOST_FLAG & flags);
+ }
+
+ /* Check for readability */
+ if (wxFD_ISSET(m_fd, &readfds))
+ {
+ result |= wxSOCKET_INPUT_FLAG;
+
+ if (m_server && m_stream)
+ {
+ /* This is a TCP server socket that detected a connection.
+ While the INPUT_FLAG is also set, it doesn't matter on
+ this kind of sockets, as we can only Accept() from them. */
+ m_detected |= wxSOCKET_CONNECTION_FLAG;
+ }
+ }
+
+ /* Check for writability */
+ if (wxFD_ISSET(m_fd, &writefds))
+ {
+ if (m_establishing && !m_server)
+ {
+ int error;
+ SOCKOPTLEN_T len = sizeof(error);
+ m_establishing = false;
+ getsockopt(m_fd, SOL_SOCKET, SO_ERROR, (char*)&error, &len);
+
+ if (error)
+ {
+ m_detected = wxSOCKET_LOST_FLAG;
+
+ /* LOST event: Abort any further processing */
+ return (wxSOCKET_LOST_FLAG & flags);
+ }
+ else
+ {
+ m_detected |= wxSOCKET_CONNECTION_FLAG;
+ }
+ }
+ else
+ {
+ result |= wxSOCKET_OUTPUT_FLAG;
+ }
+ }
+
+ return (result | m_detected) & flags;
+}
+
+// All Wait functions poll the socket using 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 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; // in ms
+ wxCHECK_MSG( m_impl, false, "can't wait on invalid socket" );
- // Set this to true to interrupt ongoing waits
+ // This can be set to true from Interrupt() to exit this function a.s.a.p.
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;
-
- // Get the active event loop
- wxEventLoopBase * const eventLoop = wxEventLoop::GetActive();
-
-#ifdef __WXMSW__
- wxASSERT_MSG( !wxIsMainThread() || eventLoop,
- "Sockets won't work without a running event loop" );
-#endif // __WXMSW__
- // Wait in an active polling loop.
+ // Use either the provided timeout or the default timeout value associated
+ // with this socket.
//
- // 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.
-
- const wxMilliClock_t time_limit = wxGetLocalTimeMillis() + timeout;
- bool done = false;
- bool valid_result = false;
-
- if (!eventLoop)
+ // 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() )
{
- // This is used to avoid a busy loop on wxBase - having a select
- // timeout of 50 ms per iteration should be enough.
- if (timeout > 50)
- m_socket->SetTimeout(50);
- else
- m_socket->SetTimeout(timeout);
+ eventLoop = wxEventLoop::GetActive();
}
-
- while (!done)
+ else // in worker thread
{
- result = m_socket->Select(flags | GSOCK_LOST_FLAG);
+ // We never dispatch messages from threads other than the main one.
+ eventLoop = NULL;
+ }
- // Incoming connection (server) or connection established (client)
- if (result & GSOCK_CONNECTION_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 ( ;; )
+ {
+ // We always stop waiting when the connection is lost as it doesn't
+ // make sense to continue further, even if wxSOCKET_LOST_FLAG is not
+ // specified in flags to wait for.
+ const wxSocketEventFlags
+ result = m_impl->Select(flags | wxSOCKET_LOST_FLAG);
+
+ // Incoming connection (server) or connection established (client)?
+ if ( result & wxSOCKET_CONNECTION_FLAG )
{
m_connected = true;
m_establishing = false;
- valid_result = true;
+ gotEvent = true;
break;
}
- // Data available or output buffer ready
- if ((result & GSOCK_INPUT_FLAG) || (result & GSOCK_OUTPUT_FLAG))
+ // Data available or output buffer ready?
+ if ( (result & wxSOCKET_INPUT_FLAG) || (result & wxSOCKET_OUTPUT_FLAG) )
{
- valid_result = true;
+ gotEvent = true;
break;
}
// Connection lost
- if (result & GSOCK_LOST_FLAG)
+ if ( result & wxSOCKET_LOST_FLAG )
{
m_connected = false;
m_establishing = false;
- valid_result = ((flags & GSOCK_LOST_FLAG) != 0);
+ if ( flags & wxSOCKET_LOST_FLAG )
+ gotEvent = true;
break;
}
+ if ( m_interrupt )
+ break;
+
// Wait more?
- long time_left = wxMilliClockToLong(time_limit - wxGetLocalTimeMillis());
- if ((!timeout) || (time_left <= 0) || (m_interrupt))
- done = true;
- else
+ const wxMilliClock_t timeNow = wxGetLocalTimeMillis();
+ if ( timeNow >= timeEnd )
+ break;
+
+ if ( eventLoop )
{
- if (eventLoop)
- {
- // from the main thread itself we have to run the event loop to
- // let the events (including the GUI events and the low-level
- // (not wxWidgets) events from GSocket) be processed but from
- // another thread it is enough to just call wxThread::Yield()
- // which will give away the rest of our time slice: the
- // explanation is that the events will be processed by the main
- // thread anyhow, but we don't want to eat the CPU time
- // uselessly while sitting in the loop waiting for the data
- if ( wxIsMainThread() )
- {
- if ( eventLoop->Pending() )
- eventLoop->Dispatch();
- }
+ // This function is only called if wxSOCKET_BLOCK flag was not used
+ // and so we should dispatch the events if there is an event loop
+ // capable of doing it.
+ if ( eventLoop->Pending() )
+ eventLoop->Dispatch();
+ }
#if wxUSE_THREADS
- else
- wxThread::Yield();
-#endif // wxUSE_THREADS
- }
- else
- {
- // If there's less than 50 ms left, just call select with that timeout.
- if (time_left < 50)
- m_socket->SetTimeout(time_left);
- }
+ 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
}
- // Set timeout back to original value (we overwrote it for polling)
- if (!eventLoop)
- m_socket->SetTimeout(m_timeout*1000);
-
- return valid_result;
+ 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,
+ wxSOCKET_INPUT_FLAG |
+ wxSOCKET_OUTPUT_FLAG |
+ wxSOCKET_CONNECTION_FLAG |
+ wxSOCKET_LOST_FLAG
+ );
}
bool wxSocketBase::WaitForRead(long seconds, long milliseconds)
{
- // Check pushback buffer before entering _Wait
- if (m_unread)
+ // Check pushback buffer before entering DoWait
+ if ( m_unread )
return true;
- // Note that GSOCK_INPUT_LOST has to be explicitly passed to
- // _Wait 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 _Wait(seconds, milliseconds, GSOCK_INPUT_FLAG | GSOCK_LOST_FLAG);
+ // Note that wxSOCKET_INPUT_LOST has to be explicitly passed to DoWait
+ // because of the semantics of WaitForRead: a return value of true means
+ // that a Read call will return immediately, not that there is
+ // actually data to read.
+ return DoWait(seconds, milliseconds, wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
}
bool wxSocketBase::WaitForWrite(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_OUTPUT_FLAG);
+ return DoWait(seconds, milliseconds, wxSOCKET_OUTPUT_FLAG | wxSOCKET_LOST_FLAG);
}
bool wxSocketBase::WaitForLost(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_LOST_FLAG);
+ return DoWait(seconds, milliseconds, wxSOCKET_LOST_FLAG);
}
// --------------------------------------------------------------------------
{
GAddress *peer;
- if (!m_socket)
+ if (!m_impl)
return false;
- peer = m_socket->GetPeer();
+ peer = m_impl->GetPeer();
// copying a null address would just trigger an assert anyway
{
GAddress *local;
- if (!m_socket)
+ if (!m_impl)
return false;
- local = m_socket->GetLocal();
+ local = m_impl->GetLocal();
addr_man.SetAddress(local);
GAddress_destroy(local);
{
m_timeout = seconds;
- if (m_socket)
- m_socket->SetTimeout(m_timeout * 1000);
+ if (m_impl)
+ m_impl->SetTimeout(m_timeout * 1000);
}
void wxSocketBase::SetFlags(wxSocketFlags 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;
}
// Event handling
// --------------------------------------------------------------------------
-// A note on how events are processed, which is probably the most
-// difficult thing to get working right while keeping the same API
-// and functionality for all platforms.
-//
-// When GSocket detects an event, it calls wx_socket_callback, which in
-// turn just calls wxSocketBase::OnRequest in the corresponding wxSocket
-// object. OnRequest does some housekeeping, and if the event is to be
-// propagated to the user, it creates a new wxSocketEvent object and
-// posts it. The event is not processed immediately, but delayed with
-// AddPendingEvent instead. This is necessary in order to decouple the
-// event processing from wx_socket_callback; otherwise, subsequent IO
-// calls made from the user event handler would fail, as gtk callbacks
-// are not reentrant.
-//
-// Note that, unlike events, user callbacks (now deprecated) are _not_
-// decoupled from wx_socket_callback and thus they suffer from a variety
-// of problems. Avoid them where possible and use events instead.
-
-extern "C"
-void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
- GSocketEvent notification,
- char *cdata)
-{
- wxSocketBase *sckobj = (wxSocketBase *)cdata;
-
- 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:
// which are no longer valid.
case wxSOCKET_INPUT:
- if (m_reading || !m_socket->Select(GSOCK_INPUT_FLAG))
+ if (m_reading || !m_impl->Select(wxSOCKET_INPUT_FLAG))
return;
break;
case wxSOCKET_OUTPUT:
- if (m_writing || !m_socket->Select(GSOCK_OUTPUT_FLAG))
+ if (m_writing || !m_impl->Select(wxSOCKET_OUTPUT_FLAG))
return;
break;
m_connected = false;
m_establishing = false;
break;
+
+ case wxSOCKET_MAX_EVENT:
+ wxFAIL_MSG( "unexpected notification" );
+ return;
}
// Schedule the event
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;
+ case wxSOCKET_INPUT: flag = wxSOCKET_INPUT_FLAG; break;
+ case wxSOCKET_OUTPUT: flag = wxSOCKET_OUTPUT_FLAG; break;
+ case wxSOCKET_CONNECTION: flag = wxSOCKET_CONNECTION_FLAG; break;
+ case wxSOCKET_LOST: flag = wxSOCKET_LOST_FLAG; break;
default:
wxLogWarning(_("wxSocket: unknown event!."));
return;
void wxSocketBase::Notify(bool notify)
{
m_notify = notify;
- if (m_socket)
- m_socket->Notify(notify);
+ if (m_impl)
+ m_impl->Notify(notify);
}
void wxSocketBase::SetNotify(wxSocketEventFlags flags)
wxUint32 wxSocketBase::GetPushback(void *buffer, wxUint32 size, bool peek)
{
+ wxCHECK_MSG( buffer, 0, "NULL buffer" );
+
if (!m_unrd_size)
return 0;
{
wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") );
- m_socket = GSocket_new();
+ m_impl = wxSocketImpl::Create(*this);
- if (!m_socket)
+ if (!m_impl)
{
- wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") );
+ wxLogTrace( wxTRACE_Socket, _T("*** Failed to create m_impl") );
return;
}
// Setup the socket as server
- m_socket->Notify(m_notify);
- m_socket->SetLocal(addr_man.GetAddress());
+ m_impl->Notify(m_notify);
+ m_impl->SetLocal(addr_man.GetAddress());
if (GetFlags() & wxSOCKET_REUSEADDR) {
- m_socket->SetReusable();
+ m_impl->SetReusable();
}
if (GetFlags() & wxSOCKET_BROADCAST) {
- m_socket->SetBroadcast();
+ m_impl->SetBroadcast();
}
if (GetFlags() & wxSOCKET_NOBIND) {
- m_socket->DontDoBind();
+ m_impl->DontDoBind();
}
- if (m_socket->SetServer() != GSOCK_NOERROR)
+ if (m_impl->CreateServer() != wxSOCKET_NOERROR)
{
- delete m_socket;
- m_socket = NULL;
+ delete m_impl;
+ m_impl = NULL;
- wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") );
+ wxLogTrace( wxTRACE_Socket, _T("*** CreateServer() 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 );
+ wxLogTrace( wxTRACE_Socket, _T("wxSocketServer on fd %d"), m_impl->m_fd );
}
// --------------------------------------------------------------------------
bool wxSocketServer::AcceptWith(wxSocketBase& sock, bool wait)
{
- GSocket *child_socket;
-
- if (!m_socket)
+ if (!m_impl)
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_impl, !wait);
+ sock.m_impl = m_impl->WaitConnection(sock);
- if (!wait)
- m_socket->SetNonBlocking(1);
-
- child_socket = m_socket->WaitConnection();
-
- if (!wait)
- m_socket->SetNonBlocking(0);
-
- if (!child_socket)
+ if ( !sock.m_impl )
return false;
sock.m_type = wxSOCKET_BASE;
- sock.m_socket = child_socket;
sock.m_connected = true;
- 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);
-
return true;
}
bool wxSocketServer::WaitForAccept(long seconds, long milliseconds)
{
- return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG);
+ return DoWait(seconds, milliseconds, wxSOCKET_CONNECTION_FLAG);
}
bool wxSocketBase::GetOption(int level, int optname, void *optval, int *optlen)
{
- wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+ wxASSERT_MSG( m_impl, _T("Socket not initialised") );
- if (m_socket->GetSockOpt(level, optname, optval, optlen)
- != GSOCK_NOERROR)
- {
+ SOCKOPTLEN_T lenreal;
+ if ( getsockopt(m_impl->m_fd, level, optname,
+ static_cast<char *>(optval), &lenreal) != 0 )
return false;
- }
+
+ *optlen = lenreal;
+
return true;
}
-bool wxSocketBase::SetOption(int level, int optname, const void *optval,
- int optlen)
+bool
+wxSocketBase::SetOption(int level, int optname, const void *optval, int optlen)
{
- wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+ wxASSERT_MSG( m_impl, _T("Socket not initialised") );
- if (m_socket->SetSockOpt(level, optname, optval, optlen)
- != GSOCK_NOERROR)
- {
- return false;
- }
- return true;
+ return setsockopt(m_impl->m_fd, level, optname,
+ static_cast<const char *>(optval), optlen) == 0;
}
bool wxSocketBase::SetLocal(const wxIPV4address& local)
const wxSockAddress* local,
bool wait)
{
- GSocketError err;
-
- if (m_socket)
+ if (m_impl)
{
// Shutdown and destroy the socket
Close();
- delete m_socket;
+ delete m_impl;
}
- m_socket = GSocket_new();
+ m_impl = wxSocketImpl::Create(*this);
m_connected = false;
m_establishing = false;
- if (!m_socket)
+ if (!m_impl)
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.
-
- if (!wait)
- m_socket->SetNonBlocking(1);
+ wxSocketUnblocker unblock(m_impl, !wait);
// Reuse makes sense for clients too, if we are trying to rebind to the same port
if (GetFlags() & wxSOCKET_REUSEADDR)
{
- m_socket->SetReusable();
+ m_impl->SetReusable();
}
if (GetFlags() & wxSOCKET_BROADCAST)
{
- m_socket->SetBroadcast();
+ m_impl->SetBroadcast();
}
if (GetFlags() & wxSOCKET_NOBIND)
{
- m_socket->DontDoBind();
+ m_impl->DontDoBind();
}
// If no local address was passed and one has been set, use the one that was Set
GAddress* la = local->GetAddress();
if (la && la->m_addr)
- m_socket->SetLocal(la);
+ m_impl->SetLocal(la);
}
-#if defined(__WXMSW__) || defined(__WXGTK__)
- m_socket->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
-#endif
-
- m_socket->SetPeer(addr_man.GetAddress());
- err = m_socket->Connect(GSOCK_STREAMED);
+ m_impl->SetInitialSocketBuffers(m_initialRecvBufferSize, m_initialSendBufferSize);
- //this will register for callbacks - must be called after m_socket->m_fd was initialized
- m_socket->Notify(m_notify);
+ m_impl->SetPeer(addr_man.GetAddress());
+ const wxSocketError err = m_impl->CreateClient();
- if (!wait)
- m_socket->SetNonBlocking(0);
+ //this will register for callbacks - must be called after m_impl->m_fd was initialized
+ m_impl->Notify(m_notify);
- if (err != GSOCK_NOERROR)
+ if (err != wxSOCKET_NOERROR)
{
- if (err == GSOCK_WOULDBLOCK)
+ if (err == wxSOCKET_WOULDBLOCK)
m_establishing = true;
return false;
bool wxSocketClient::WaitOnConnect(long seconds, long milliseconds)
{
- if (m_connected) // Already connected
+ 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_impl, false,
+ "No connection establishment attempt in progress" );
- return _Wait(seconds, milliseconds, GSOCK_CONNECTION_FLAG |
- GSOCK_LOST_FLAG);
+ // we must specify wxSOCKET_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,
+ wxSOCKET_CONNECTION_FLAG | wxSOCKET_LOST_FLAG);
}
// ==========================================================================
// wxDatagramSocket
// ==========================================================================
-/* NOTE: experimental stuff - might change */
-
wxDatagramSocket::wxDatagramSocket( const wxSockAddress& addr,
wxSocketFlags flags )
: wxSocketBase( flags, wxSOCKET_DATAGRAM )
{
// Create the socket
- m_socket = GSocket_new();
+ m_impl = wxSocketImpl::Create(*this);
- if (!m_socket)
- {
- wxFAIL_MSG( _T("datagram socket not new'd") );
+ if (!m_impl)
return;
- }
- m_socket->Notify(m_notify);
+
+ m_impl->Notify(m_notify);
// Setup the socket as non connection oriented
- m_socket->SetLocal(addr.GetAddress());
+ m_impl->SetLocal(addr.GetAddress());
if (flags & wxSOCKET_REUSEADDR)
{
- m_socket->SetReusable();
+ m_impl->SetReusable();
}
if (GetFlags() & wxSOCKET_BROADCAST)
{
- m_socket->SetBroadcast();
+ m_impl->SetBroadcast();
}
if (GetFlags() & wxSOCKET_NOBIND)
{
- m_socket->DontDoBind();
+ m_impl->DontDoBind();
}
- if ( m_socket->SetNonOriented() != GSOCK_NOERROR )
+
+ if ( m_impl->CreateUDP() != wxSOCKET_NOERROR )
{
- delete m_socket;
- m_socket = NULL;
+ delete m_impl;
+ m_impl = 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,
const void* buf,
wxUint32 nBytes )
{
- wxASSERT_MSG( m_socket, _T("Socket not initialised") );
+ wxASSERT_MSG( m_impl, _T("Socket not initialised") );
- m_socket->SetPeer(addr.GetAddress());
+ m_impl->SetPeer(addr.GetAddress());
Write(buf, nBytes);
return (*this);
}
public:
virtual bool OnInit()
{
- // wxSocketBase will call GSocket_Init() itself when/if needed
+ // wxSocketBase will call Initialize() itself only if sockets are
+ // really used, don't do it from here
return true;
}
projects / wxWidgets.git / blobdiff