Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Streamline wxSocket code: wxSocketBase now uses wxSocketImpl (previously known

Browse Source 
as GSocket) which is a base class with various wxSocketImplXXX implementations
provided by different wxSocketManagers.

Share more code between ports (still not finished).

Refactor some code inside wxSocketImpl itself to be less redundant and fixed a
couple of minor bugs in the process.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56994 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-11-28 12:47:07 +00:00
parent 29dbfacee2
commit 51fe4b60ab
27 changed files with 1551 additions and 2029 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/wx/apptrait.h
View File

@@ -30,7 +30,7 @@ class WXDLLIMPEXP_FWD_BASE wxString;
class WXDLLIMPEXP_FWD_BASE wxTimer;
class WXDLLIMPEXP_FWD_BASE wxTimerImpl;
class GSocketManager;
class wxSocketManager;
// ----------------------------------------------------------------------------
@@ -116,9 +116,21 @@ public:
virtual void RemoveFromPendingDelete(wxObject *object) = 0;
#if wxUSE_SOCKETS
// this function is used by wxNet library to set the default socket manager
// to use: doing it like this allows us to keep all socket-related code in
// wxNet instead of having to pull it in wxBase itself as we'd have to do
// if we really implemented wxSocketManager here
//
// we don't take ownership of this pointer, it should have a lifetime
// greater than that of any socket (e.g. be a pointer to a static object)
static void SetDefaultSocketManager(wxSocketManager *manager)
{
ms_manager = manager;
}
// return socket manager: this is usually different for console and GUI
// applications (although some ports use the same implementation for both)
virtual GSocketManager *GetSocketManager() = 0;
virtual wxSocketManager *GetSocketManager() { return ms_manager; }
#endif
// create a new, port specific, instance of the event loop used by wxApp
@@ -169,6 +181,9 @@ protected:
// utility function: returns the stack frame as a plain wxString
virtual wxString GetAssertStackTrace();
#endif
private:
static wxSocketManager *ms_manager;
};
// ----------------------------------------------------------------------------

22
include/wx/msw/apptbase.h
View File

@@ -46,26 +46,6 @@ public:
virtual WXDWORD WaitForThread(WXHANDLE hThread) = 0;
// wxSocket support
// ----------------
#if wxUSE_SOCKETS
// this function is used by wxNet library to set the default socket manager
// to use: doing it like this allows us to keep all socket-related code in
// wxNet instead of having to pull it in wxBase itself as we'd have to do
// if we really implemented GSocketManager here
//
// we don't take ownership of this pointer, it should have a lifetime
// greater than that of any socket (e.g. be a pointer to a static object)
static void SetDefaultSocketManager(GSocketManager *manager)
{
ms_manager = manager;
}
virtual GSocketManager *GetSocketManager() { return ms_manager; }
#endif // wxUSE_SOCKETS
#ifndef __WXWINCE__
// console helpers
// ---------------
@@ -86,8 +66,6 @@ protected:
// implementation of WaitForThread() for the console applications which is
// also used by the GUI code if it doesn't [yet|already} dispatch events
WXDWORD DoSimpleWaitForThread(WXHANDLE hThread);
static GSocketManager *ms_manager;
};
#endif // _WX_MSW_APPTBASE_H_

92
include/wx/msw/gsockmsw.h
View File

@@ -1,12 +1,15 @@
/* -------------------------------------------------------------------------
* Project: GSocket (Generic Socket) for WX
* Name: gsockmsw.h
* Copyright: (c) Guilhem Lavaux
* Licence: wxWindows Licence
* Purpose: GSocket MSW header
* CVSID: $Id$
* -------------------------------------------------------------------------
*/
/////////////////////////////////////////////////////////////////////////////
// Name: wx/msw/gsockmsw.h
// Purpose: MSW-specific socket implementation
// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia, Vadim Zeitlin
// Created: April 1997
// Copyright: (C) 1999-1997, Guilhem Lavaux
// (C) 1999-2000, Guillermo Rodriguez Garcia
// (C) 2008 Vadim Zeitlin
// RCS_ID: $Id$
// License: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_MSW_GSOCKMSW_H_
#define _WX_MSW_GSOCKMSW_H_
@@ -20,53 +23,50 @@
#endif
#if defined(__WXWINCE__) || defined(__CYGWIN__)
#include <winsock.h>
#include <winsock.h>
#endif
/* Definition of GSocket */
class GSocket : public GSocketBase
// ----------------------------------------------------------------------------
// MSW-specific socket implementation
// ----------------------------------------------------------------------------
class wxSocketImplMSW : public wxSocketImpl
{
public:
GSocket(wxSocketBase& wxsocket)
: GSocketBase(wxsocket)
wxSocketImplMSW(wxSocketBase& wxsocket);
virtual ~wxSocketImplMSW();
virtual wxSocketImpl *WaitConnection(wxSocketBase& wxsocket);
int Read(char *buffer, int size);
int Write(const char *buffer, int size);
private:
virtual wxSocketError DoHandleConnect(int ret);
virtual void DoClose();
virtual void UnblockAndRegisterWithEventLoop()
{
m_msgnumber = 0;
// no need to make the socket non-blocking, Install_Callback() will do
// it
wxSocketManager::Get()->Install_Callback(this);
}
virtual GSocket *WaitConnection(wxSocketBase& wxsocket);
wxSocketError Input_Timeout();
wxSocketError Output_Timeout();
wxSocketError Connect_Timeout();
int Recv_Stream(char *buffer, int size);
int Recv_Dgram(char *buffer, int size);
int Send_Stream(const char *buffer, int size);
int Send_Dgram(const char *buffer, int size);
int m_msgnumber;
GSocketError SetServer();
friend class wxSocketMSWManager;
// not used under MSW
void Notify(bool) { }
bool SetReusable();
bool SetBroadcast();
bool DontDoBind();
GSocketError Connect(GSocketStream stream);
GSocketError SetNonOriented();
int Read(char *buffer, int size);
int Write(const char *buffer, int size);
void SetNonBlocking(bool non_block);
GSocketError WXDLLIMPEXP_NET GetError();
GSocketError GetSockOpt(int level, int optname,
void *optval, int *optlen);
GSocketError SetSockOpt(int level, int optname,
const void *optval, int optlen);
protected:
GSocketError Input_Timeout();
GSocketError Output_Timeout();
GSocketError Connect_Timeout();
int Recv_Stream(char *buffer, int size);
int Recv_Dgram(char *buffer, int size);
int Send_Stream(const char *buffer, int size);
int Send_Dgram(const char *buffer, int size);
/* TODO: Make these protected */
public:
int m_msgnumber;
DECLARE_NO_COPY_CLASS(wxSocketImplMSW)
};
#endif /* _WX_MSW_GSOCKMSW_H_ */

2
include/wx/os2/apptbase.h
View File

@@ -31,7 +31,7 @@ public:
// returns the select()-based socket manager for console applications which
// is also used by some ports (wxX11, wxDFB) in the GUI build (hence it is
// here and not in wxConsoleAppTraits)
virtual GSocketManager *GetSocketManager();
virtual wxSocketManager *GetSocketManager();
#endif
};

2
include/wx/os2/apptrait.h
View File

@@ -50,7 +50,7 @@ public:
virtual wxString GetDesktopEnvironment() const;
#endif
#if wxUSE_SOCKETS
virtual GSocketManager *GetSocketManager();
virtual wxSocketManager *GetSocketManager();
#endif
};

378
include/wx/private/gsocket.h
View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: wx/private/gsocket.h
// Purpose: GSocket implementation
// Purpose: wxSocketImpl nd related declarations
// Authors: Guilhem Lavaux, Vadim Zeitlin
// Created: April 1997
// RCS-ID: $Id$
@@ -9,6 +9,31 @@
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/*
Brief overview of different socket classes:
- wxSocketBase is the public class representing a socket ("Base" here
refers to the fact that wxSocketClient and wxSocketServer are derived
from it and predates the convention of using "Base" for common base
classes for platform-specific classes in wxWidgets) with implementation
common to all platforms and forwarding methods whose implementation
differs between platforms to wxSocketImpl which it contains.
- wxSocketImpl is actually just an abstract base class having only code
common to all platforms, the concrete implementation classes derive from
it and are created by wxSocketManager::CreateSocket().
- Some socket operations have different implementations in console-mode and
GUI applications. wxSocketManager class exists to abstract this in such
way that console applications (using wxBase) don't depend on wxNet. An
object of this class is made available via wxApp and GUI applications set
up a different kind of global socket manager from console ones.
TODO: it looks like wxSocketManager could be eliminated by providing
methods for registering/unregistering sockets directly in
wxEventLoop.
*/
#ifndef _WX_PRIVATE_GSOCKET_H_
#define _WX_PRIVATE_GSOCKET_H_
@@ -16,9 +41,7 @@
#if wxUSE_SOCKETS
#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */
class WXDLLIMPEXP_FWD_NET wxSocketBase;
#include "wx/socket.h"
#include <stddef.h>
@@ -43,61 +66,48 @@ class WXDLLIMPEXP_FWD_NET wxSocketBase;
#include <sys/time.h> // for timeval
#endif
// these definitions are for MSW when we don't use configure, otherwise these
// symbols are defined by configure
#ifndef WX_SOCKLEN_T
#define WX_SOCKLEN_T int
#endif
#ifndef SOCKOPTLEN_T
#define SOCKOPTLEN_T int
#endif
// define some symbols which winsock.h defines but traditional BSD headers
// don't
#ifndef SOCKET
#define SOCKET int
#endif
#ifndef INVALID_SOCKET
#define INVALID_SOCKET (-1)
#endif
#ifndef SOCKET_ERROR
#define SOCKET_ERROR (-1)
#endif
#if wxUSE_IPV6
typedef struct sockaddr_storage wxSockAddr;
#else
typedef struct sockaddr wxSockAddr;
#endif
enum GAddressType
{
GSOCK_NOFAMILY = 0,
GSOCK_INET,
GSOCK_INET6,
GSOCK_UNIX
wxSOCKET_NOFAMILY = 0,
wxSOCKET_INET,
wxSOCKET_INET6,
wxSOCKET_UNIX
};
enum GSocketStream
{
GSOCK_STREAMED,
GSOCK_UNSTREAMED
};
enum GSocketError
{
GSOCK_NOERROR = 0,
GSOCK_INVOP,
GSOCK_IOERR,
GSOCK_INVADDR,
GSOCK_INVSOCK,
GSOCK_NOHOST,
GSOCK_INVPORT,
GSOCK_WOULDBLOCK,
GSOCK_TIMEDOUT,
GSOCK_MEMERR,
GSOCK_OPTERR
};
/* See below for an explanation on how events work.
*/
enum GSocketEvent
{
GSOCK_INPUT = 0,
GSOCK_OUTPUT = 1,
GSOCK_CONNECTION = 2,
GSOCK_LOST = 3,
GSOCK_MAX_EVENT = 4
};
enum
{
GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT,
GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT,
GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION,
GSOCK_LOST_FLAG = 1 << GSOCK_LOST
};
typedef int GSocketEventFlags;
typedef int wxSocketEventFlags;
struct GAddress;
class GSocket;
typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
char *cdata);
class wxSocketImpl;
/*
Class providing hooks abstracting the differences between console and GUI
@@ -108,23 +118,23 @@ typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
its existence is that we want the same socket code work differently
depending on whether it's used from a console or a GUI program. This is
achieved by implementing the virtual methods of this class differently in
the objects returned by wxConsoleAppTraits::GetSocketFunctionsTable() and
the same method in wxGUIAppTraits.
the objects returned by wxConsoleAppTraits::GetSocketManager() and the same
method in wxGUIAppTraits.
*/
class GSocketManager
class wxSocketManager
{
public:
// set the manager to use, we don't take ownership of it
//
// this should be called before GSocket_Init(), i.e. before the first
// wxSocket object is created, otherwise the manager returned by
// wxAppTraits::GetSocketManager() will be used
static void Set(GSocketManager *manager);
// this should be called before creating the first wxSocket object,
// otherwise the manager returned by wxAppTraits::GetSocketManager() will
// be used
static void Set(wxSocketManager *manager);
// return the manager to use
//
// this initializes the manager at first use
static GSocketManager *Get()
static wxSocketManager *Get()
{
if ( !ms_manager )
Init();
@@ -135,29 +145,20 @@ public:
// called before the first wxSocket is created and should do the
// initializations needed in order to use the network
//
// return true if initialized successfully
// return true if initialized successfully; if this returns false sockets
// can't be used at all
virtual bool OnInit() = 0;
// undo the initializations of OnInit()
virtual void OnExit() = 0;
// do manager-specific socket initializations: called in the beginning of
// the socket initialization
virtual bool Init_Socket(GSocket *socket) = 0;
// called when the socket is being closed
// create a concrete socket implementation associated with the given
// wxSocket object
//
// TODO: merge this with Destroy_Socket(), currently 2 separate functions
// are needed because Init_Socket() always allocates manager-specific
// resources in GSocket and Destroy_Socket() must be called even if
// the socket has never been opened, but if the allocation were done
// on demand, then Destroy_Socket() could be called from
// GSocket::Close() and we wouldn't need Close_Socket() at all
virtual void Close_Socket(GSocket *socket) = 0;
// the returned object must be deleted by the caller
virtual wxSocketImpl *CreateSocket(wxSocketBase& wxsocket) = 0;
// undo Init_Socket(): called from GSocket dtor
virtual void Destroy_Socket(GSocket *socket) = 0;
// these functions enable or disable monitoring of the given socket for the
@@ -165,77 +166,134 @@ public:
// that both BSD and Winsock implementations actually use socket->m_server
// value to determine what exactly should be monitored so it needs to be
// set before calling these functions)
virtual void Install_Callback(GSocket *socket,
GSocketEvent event = GSOCK_MAX_EVENT) = 0;
virtual void Uninstall_Callback(GSocket *socket,
GSocketEvent event = GSOCK_MAX_EVENT) = 0;
virtual void Install_Callback(wxSocketImpl *socket,
wxSocketNotify event = wxSOCKET_MAX_EVENT) = 0;
virtual void Uninstall_Callback(wxSocketImpl *socket,
wxSocketNotify event = wxSOCKET_MAX_EVENT) = 0;
virtual ~GSocketManager() { }
virtual ~wxSocketManager() { }
private:
// get the manager to use if we don't have it yet
static void Init();
static GSocketManager *ms_manager;
static wxSocketManager *ms_manager;
};
/*
Base class providing functionality common to BSD and Winsock sockets.
Base class for all socket implementations providing functionality common to
BSD and Winsock sockets.
TODO: merge this in wxSocket itself, there is no reason to maintain the
separation between wxSocket and GSocket.
Objects of this class are not created directly but only via its static
Create() method which in turn forwards to wxSocketManager::CreateSocket().
*/
class GSocketBase
class wxSocketImpl
{
public:
// static factory function: creates the low-level socket associated with
// the given wxSocket (and inherits its attributes such as timeout)
static GSocket *Create(wxSocketBase& wxsocket);
static wxSocketImpl *Create(wxSocketBase& wxsocket);
virtual ~GSocketBase();
virtual ~wxSocketImpl();
// set various socket properties: all of those can only be called before
// creating the socket
void SetTimeout(unsigned long millisec);
GSocketError SetLocal(GAddress *address);
GSocketError SetPeer(GAddress *address);
GAddress *GetLocal();
GAddress *GetPeer();
GSocketEventFlags Select(GSocketEventFlags flags);
virtual GSocket *WaitConnection(wxSocketBase& wxsocket) = 0;
void Close();
virtual void Shutdown();
void SetNonBlocking(bool non_blocking) { m_non_blocking = non_blocking; }
void SetReusable() { m_reusable = true; }
void SetBroadcast() { m_broadcast = true; }
void DontDoBind() { m_dobind = false; }
void SetInitialSocketBuffers(int recv, int send)
{
m_initialRecvBufferSize = recv;
m_initialSendBufferSize = send;
}
wxSocketError SetLocal(GAddress *address);
wxSocketError SetPeer(GAddress *address);
// accessors
// ---------
GAddress *GetLocal();
GAddress *GetPeer();
wxSocketError GetError() const { return m_error; }
bool IsOk() const { return m_error == wxSOCKET_NOERROR; }
// creating/closing the socket
// --------------------------
// notice that SetLocal() must be called before creating the socket using
// any of the functions below
//
// all of Create() functions return wxSOCKET_NOERROR if the operation
// completed successfully or one of:
// wxSOCKET_INVSOCK - the socket is in use.
// wxSOCKET_INVADDR - the local (server) or peer (client) address has not
// been set.
// wxSOCKET_IOERR - any other error.
// create a socket listening on the local address specified by SetLocal()
// (notice that DontDoBind() is ignored by this function)
wxSocketError CreateServer();
// create a socket connected to the peer address specified by SetPeer()
// (notice that DontDoBind() is ignored by this function)
//
// this function may return wxSOCKET_WOULDBLOCK in addition to the return
// values listed above
wxSocketError CreateClient();
// create (and bind unless DontDoBind() had been called) an UDP socket
// associated with the given local address
wxSocketError CreateUDP();
// may be called whether the socket was created or not, calls DoClose() if
// it was indeed created
void Close();
virtual void Shutdown();
// IO operations
// -------------
virtual int Read(char *buffer, int size) = 0;
virtual int Write(const char *buffer, int size) = 0;
wxSocketEventFlags Select(wxSocketEventFlags flags);
virtual wxSocketImpl *WaitConnection(wxSocketBase& wxsocket) = 0;
// notifications
// -------------
// notify m_wxsocket about the given socket event by calling its (inaptly
// named) OnRequest() method
void NotifyOnStateChange(GSocketEvent event);
void NotifyOnStateChange(wxSocketNotify event);
// FIXME: making these functions virtual is a hack necessary to make the
// wxBase library link without requiring wxNet under Unix where
// GSocketSelectManager (part of wxBase) uses them, they don't
// wxSocketSelectManager (part of wxBase) uses them, they don't
// really need to be virtual at all
virtual void Detected_Read() { }
virtual void Detected_Write() { }
virtual void Notify(bool WXUNUSED(notify)) { }
// this is officially SOCKET (unsigned int) under Windows but we don't want
// to include winsock.h which defines SOCKET from here so just use int
// under all platforms
int m_fd;
// TODO: make these fields protected and provide accessors for those of
// them that wxSocketBase really needs
//protected:
SOCKET m_fd;
int m_initialRecvBufferSize;
int m_initialSendBufferSize;
GAddress *m_local;
GAddress *m_peer;
GSocketError m_error;
wxSocketError m_error;
bool m_non_blocking;
bool m_server;
@@ -247,37 +305,71 @@ public:
struct timeval m_timeout;
GSocketEventFlags m_detected;
wxSocketEventFlags m_detected;
protected:
GSocketBase(wxSocketBase& wxsocket);
wxSocketImpl(wxSocketBase& wxsocket);
private:
// handle the given connect() return value (which may be 0 or EWOULDBLOCK
// or something else)
virtual wxSocketError DoHandleConnect(int ret) = 0;
// called by Close() if we have a valid m_fd
virtual void DoClose() = 0;
// put this socket into non-blocking mode and enable monitoring this socket
// as part of the event loop
virtual void UnblockAndRegisterWithEventLoop() = 0;
// check that the socket wasn't created yet and that the given address
// (either m_local or m_peer depending on the socket kind) is valid and
// set m_error and return false if this is not the case
bool PreCreateCheck(GAddress *addr);
// set the given socket option: this just wraps setsockopt(SOL_SOCKET)
int SetSocketOption(int optname, int optval)
{
// although modern Unix systems use "const void *" for the 4th
// parameter here, old systems and Winsock still use "const char *"
return setsockopt(m_fd, SOL_SOCKET, optname,
reinterpret_cast<const char *>(&optval),
sizeof(optval));
}
// set the given socket option to true value: this is an even simpler
// wrapper for setsockopt(SOL_SOCKET) for boolean options
int EnableSocketOption(int optname)
{
return SetSocketOption(optname, 1);
}
// apply the options to the (just created) socket and register it with the
// event loop by calling UnblockAndRegisterWithEventLoop()
void PostCreation();
// update local address after binding/connecting
wxSocketError UpdateLocalAddress();
// set in ctor and never changed except that it's reset to NULL when the
// socket is shut down
wxSocketBase *m_wxsocket;
DECLARE_NO_COPY_CLASS(GSocketBase)
DECLARE_NO_COPY_CLASS(wxSocketImpl)
};
#if defined(__WINDOWS__)
#if defined(__WXMSW__)
#include "wx/msw/gsockmsw.h"
#else
#include "wx/unix/gsockunx.h"
#endif
/* Global initializers */
/* GSocket_Init() must be called at the beginning (but after calling
* GSocketManager::Set() if a custom manager should be used) */
bool GSocket_Init();
/* GSocket_Cleanup() must be called at the end */
void GSocket_Cleanup();
/* GAddress */
// TODO: make GAddress a real class instead of this mix of C and C++
// Represents a socket endpoint, i.e. -- in spite of its name -- not an address
// but an (address, port) pair
struct GAddress
@@ -288,7 +380,7 @@ struct GAddress
GAddressType m_family;
int m_realfamily;
GSocketError m_error;
wxSocketError m_error;
};
GAddress *GAddress_new();
@@ -303,48 +395,48 @@ GAddressType GAddress_GetFamily(GAddress *address);
* address family will be implicitly set to AF_INET.
*/
GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
GSocketError GAddress_INET_SetBroadcastAddress(GAddress *address);
GSocketError GAddress_INET_SetAnyAddress(GAddress *address);
GSocketError GAddress_INET_SetHostAddress(GAddress *address,
wxSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
wxSocketError GAddress_INET_SetBroadcastAddress(GAddress *address);
wxSocketError GAddress_INET_SetAnyAddress(GAddress *address);
wxSocketError GAddress_INET_SetHostAddress(GAddress *address,
unsigned long hostaddr);
GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
wxSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
const char *protocol);
GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port);
wxSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port);
GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname,
wxSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname,
size_t sbuf);
unsigned long GAddress_INET_GetHostAddress(GAddress *address);
unsigned short GAddress_INET_GetPort(GAddress *address);
GSocketError _GAddress_translate_from(GAddress *address,
wxSocketError _GAddress_translate_from(GAddress *address,
struct sockaddr *addr, int len);
GSocketError _GAddress_translate_to (GAddress *address,
wxSocketError _GAddress_translate_to (GAddress *address,
struct sockaddr **addr, int *len);
GSocketError _GAddress_Init_INET(GAddress *address);
wxSocketError _GAddress_Init_INET(GAddress *address);
#if wxUSE_IPV6
GSocketError GAddress_INET6_SetHostName(GAddress *address, const char *hostname);
GSocketError GAddress_INET6_SetAnyAddress(GAddress *address);
GSocketError GAddress_INET6_SetHostAddress(GAddress *address,
wxSocketError GAddress_INET6_SetHostName(GAddress *address, const char *hostname);
wxSocketError GAddress_INET6_SetAnyAddress(GAddress *address);
wxSocketError GAddress_INET6_SetHostAddress(GAddress *address,
struct in6_addr hostaddr);
GSocketError GAddress_INET6_SetPortName(GAddress *address, const char *port,
wxSocketError GAddress_INET6_SetPortName(GAddress *address, const char *port,
const char *protocol);
GSocketError GAddress_INET6_SetPort(GAddress *address, unsigned short port);
wxSocketError GAddress_INET6_SetPort(GAddress *address, unsigned short port);
GSocketError GAddress_INET6_GetHostName(GAddress *address, char *hostname,
wxSocketError GAddress_INET6_GetHostName(GAddress *address, char *hostname,
size_t sbuf);
GSocketError GAddress_INET6_GetHostAddress(GAddress *address,struct in6_addr *hostaddr);
wxSocketError GAddress_INET6_GetHostAddress(GAddress *address,struct in6_addr *hostaddr);
unsigned short GAddress_INET6_GetPort(GAddress *address);
#endif // wxUSE_IPV6
// these functions are available under all platforms but only implemented under
// Unix ones, elsewhere they just return GSOCK_INVADDR
GSocketError _GAddress_Init_UNIX(GAddress *address);
GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
// Unix ones, elsewhere they just return wxSOCKET_INVADDR
wxSocketError _GAddress_Init_UNIX(GAddress *address);
wxSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
wxSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
#endif /* wxUSE_SOCKETS */

8
include/wx/private/gsocketiohandler.h
View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: wx/private/gsocketiohandler.h
// Purpose: class for registering GSocket in wxSelectDispatcher
// Purpose: class for registering sockets with wxSelectDispatcher
// Authors: Lukasz Michalski
// Created: December 2006
// Copyright: (c) Lukasz Michalski
@@ -18,10 +18,10 @@
#include "wx/private/selectdispatcher.h"
#include "wx/private/gsocket.h"
class WXDLLIMPEXP_BASE wxGSocketIOHandler : public wxFDIOHandler
class WXDLLIMPEXP_BASE wxSocketIOHandler : public wxFDIOHandler
{
public:
wxGSocketIOHandler(GSocket* socket)
wxSocketIOHandler(wxSocketImpl *socket)
{
m_socket = socket;
m_flags = 0;
@@ -36,7 +36,7 @@ public:
virtual void OnExceptionWaiting() { m_socket->Detected_Read(); }
private:
GSocket* m_socket;
wxSocketImpl *m_socket;
int m_flags;
};

96
include/wx/socket.h
View File

@@ -22,71 +22,77 @@
#include "wx/event.h"
#include "wx/sckaddr.h"
#include "wx/private/gsocket.h"
#include "wx/list.h"
class wxSocketImpl;
// ------------------------------------------------------------------------
// Types and constants
// ------------------------------------------------------------------------
// Types of different socket notifications or events.
//
// NB: the values here should be consecutive and start with 0 as they are
// used to construct the wxSOCKET_XXX_FLAG bit mask values below
enum wxSocketNotify
{
wxSOCKET_INPUT = GSOCK_INPUT,
wxSOCKET_OUTPUT = GSOCK_OUTPUT,
wxSOCKET_CONNECTION = GSOCK_CONNECTION,
wxSOCKET_LOST = GSOCK_LOST
wxSOCKET_INPUT,
wxSOCKET_OUTPUT,
wxSOCKET_CONNECTION,
wxSOCKET_LOST,
wxSOCKET_MAX_EVENT
};
enum
{
wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG
wxSOCKET_INPUT_FLAG = 1 << wxSOCKET_INPUT,
wxSOCKET_OUTPUT_FLAG = 1 << wxSOCKET_OUTPUT,
wxSOCKET_CONNECTION_FLAG = 1 << wxSOCKET_CONNECTION,
wxSOCKET_LOST_FLAG = 1 << wxSOCKET_LOST
};
typedef GSocketEventFlags wxSocketEventFlags;
// this is a combination of the bit masks defined above
typedef int wxSocketEventFlags;
enum wxSocketError
{
// from GSocket
wxSOCKET_NOERROR = GSOCK_NOERROR,
wxSOCKET_INVOP = GSOCK_INVOP,
wxSOCKET_IOERR = GSOCK_IOERR,
wxSOCKET_INVADDR = GSOCK_INVADDR,
wxSOCKET_INVSOCK = GSOCK_INVSOCK,
wxSOCKET_NOHOST = GSOCK_NOHOST,
wxSOCKET_INVPORT = GSOCK_INVPORT,
wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
wxSOCKET_MEMERR = GSOCK_MEMERR,
// wxSocket-specific (not yet implemented)
wxSOCKET_DUMMY
wxSOCKET_NOERROR = 0,
wxSOCKET_INVOP,
wxSOCKET_IOERR,
wxSOCKET_INVADDR,
wxSOCKET_INVSOCK,
wxSOCKET_NOHOST,
wxSOCKET_INVPORT,
wxSOCKET_WOULDBLOCK,
wxSOCKET_TIMEDOUT,
wxSOCKET_MEMERR,
wxSOCKET_OPTERR
};
// socket options/flags bit masks
enum
{
wxSOCKET_NONE = 0,
wxSOCKET_NOWAIT = 1,
wxSOCKET_WAITALL = 2,
wxSOCKET_BLOCK = 4,
wxSOCKET_REUSEADDR = 8,
wxSOCKET_BROADCAST = 16,
wxSOCKET_NOBIND = 32
};
enum wxSocketType
{
wxSOCKET_UNINIT,
wxSOCKET_CLIENT,
wxSOCKET_SERVER,
wxSOCKET_BASE,
wxSOCKET_DATAGRAM
wxSOCKET_NONE = 0,
wxSOCKET_NOWAIT = 1,
wxSOCKET_WAITALL = 2,
wxSOCKET_BLOCK = 4,
wxSOCKET_REUSEADDR = 8,
wxSOCKET_BROADCAST = 16,
wxSOCKET_NOBIND = 32
};
typedef int wxSocketFlags;
// socket kind values (badly defined, don't use)
enum wxSocketType
{
wxSOCKET_UNINIT,
wxSOCKET_CLIENT,
wxSOCKET_SERVER,
wxSOCKET_BASE,
wxSOCKET_DATAGRAM
};
// --------------------------------------------------------------------------
@@ -111,14 +117,14 @@ public:
// state
bool Ok() const { return IsOk(); }
bool IsOk() const { return (m_socket != NULL); }
bool IsOk() const { return m_impl != NULL; }
bool Error() const { return m_error; }
bool IsClosed() const { return m_closed; }
bool IsConnected() const { return m_connected; }
bool IsData() { return WaitForRead(0, 0); }
bool IsDisconnected() const { return !IsConnected(); }
wxUint32 LastCount() const { return m_lcount; }
wxSocketError LastError() const { return (wxSocketError)m_socket->GetError(); }
wxSocketError LastError() const;
void SaveState();
void RestoreState();
@@ -182,7 +188,7 @@ public:
// Implementation from now on
// --------------------------
// do not use, should be private (called from GSocket)
// do not use, should be private (called from wxSocketImpl only)
void OnRequest(wxSocketNotify notify);
// do not use, not documented nor supported
@@ -201,7 +207,7 @@ private:
// wait until the given flags are set for this socket or the given timeout
// (or m_timeout) expires
//
// notice that GSOCK_LOST_FLAG is always taken into account but the return
// notice that wxSOCKET_LOST_FLAG is always taken into account but the return
// value depends on whether it is included in flags or not: if it is, and the
// connection is indeed lost, true is returned, but if it isn't then the
// function returns false in this case
@@ -215,7 +221,7 @@ private:
private:
// socket
GSocket *m_socket; // GSocket
wxSocketImpl *m_impl; // port-specific implementation
wxSocketType m_type; // wxSocket type
// state

2
include/wx/unix/app.h
View File

@@ -52,6 +52,4 @@ private:
// the signal handlers
WX_DECLARE_HASH_MAP(int, SignalHandler, wxIntegerHash, wxIntegerEqual, SignalHandlerHash);
SignalHandlerHash m_signalHandlerHash;
friend class GSocketGUIFunctionsTableBase;
};

8
include/wx/unix/apptbase.h
View File

@@ -46,13 +46,13 @@ public:
// wxThread helpers
// ----------------
// TODO
#if wxUSE_SOCKETS
// Darwin uses the same wxSocketManager in console and GUI and, like MSW,
// uses SetDefaultSocketManager() to initialize it
#if wxUSE_SOCKETS && !defined(__DARWIN__)
// returns the select()-based socket manager for console applications which
// is also used by some ports (wxX11, wxDFB) in the GUI build (hence it is
// here and not in wxConsoleAppTraits)
virtual GSocketManager *GetSocketManager();
virtual wxSocketManager *GetSocketManager();
#endif
protected:

2
include/wx/unix/apptrait.h
View File

@@ -81,7 +81,7 @@ public:
#endif
#if wxUSE_SOCKETS && defined(wxHAS_GUI_SOCKET_MANAGER)
virtual GSocketManager *GetSocketManager();
virtual wxSocketManager *GetSocketManager();
#endif
};

146
include/wx/unix/gsockunx.h
View File

@@ -1,51 +1,62 @@
/* -------------------------------------------------------------------------
* Project: GSocket (Generic Socket) for WX
* Name: gsockunx.h
* Copyright: (c) Guilhem Lavaux
* Licence: wxWindows Licence
* Purpose: GSocket Unix header
* CVSID: $Id$
* -------------------------------------------------------------------------
*/
/////////////////////////////////////////////////////////////////////////////
// Name: wx/unix/gsockunx.h
// Purpose: wxSocketImpl implementation for Unix systems
// Authors: Guilhem Lavaux, Vadim Zeitlin
// Created: April 1997
// RCS-ID: $Id$
// Copyright: (c) 1997 Guilhem Lavaux
// (c) 2008 Vadim Zeitlin
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_UNIX_GSOCKUNX_H_
#define _WX_UNIX_GSOCKUNX_H_
#include <unistd.h>
#include <sys/ioctl.h>
class wxGSocketIOHandler;
class wxSocketIOHandler;
class GSocket : public GSocketBase
class wxSocketImplUnix : public wxSocketImpl
{
public:
GSocket(wxSocketBase& wxsocket);
virtual ~GSocket();
wxSocketImplUnix(wxSocketBase& wxsocket);
virtual void Shutdown();
virtual GSocket *WaitConnection(wxSocketBase& wxsocket);
virtual wxSocketImpl *WaitConnection(wxSocketBase& wxsocket);
GSocketError SetServer();
bool SetReusable();
bool SetBroadcast();
bool DontDoBind();
GSocketError Connect(GSocketStream stream);
GSocketError SetNonOriented();
int Read(char *buffer, int size);
int Write(const char *buffer, int size);
void SetNonBlocking(bool non_block);
GSocketError WXDLLIMPEXP_NET GetError();
GSocketError GetSockOpt(int level, int optname, void *optval, int *optlen);
GSocketError SetSockOpt(int level, int optname,
const void *optval, int optlen);
//attach or detach from main loop
void Notify(bool flag);
void Detected_Read();
void Detected_Write();
private:
virtual wxSocketError DoHandleConnect(int ret);
virtual void DoClose()
{
wxSocketManager * const manager = wxSocketManager::Get();
if ( manager )
{
manager->Uninstall_Callback(this, wxSOCKET_INPUT);
manager->Uninstall_Callback(this, wxSOCKET_OUTPUT);
}
close(m_fd);
}
virtual void UnblockAndRegisterWithEventLoop()
{
int trueArg = 1;
ioctl(m_fd, FIONBIO, &trueArg);
EnableEvents();
}
// enable or disable notifications for socket input/output events but only
// if m_use_events is true; do nothing otherwise
void EnableEvents()
virtual void EnableEvents()
{
if ( m_use_events )
DoEnableEvents(true);
@@ -67,38 +78,36 @@ private:
//
// notice that these functions also update m_detected: EnableEvent() clears
// the corresponding bit in it and DisableEvent() sets it
void EnableEvent(GSocketEvent event);
void DisableEvent(GSocketEvent event);
void EnableEvent(wxSocketNotify event);
void DisableEvent(wxSocketNotify event);
GSocketError Input_Timeout();
GSocketError Output_Timeout();
wxSocketError Input_Timeout();
wxSocketError Output_Timeout();
int Recv_Stream(char *buffer, int size);
int Recv_Dgram(char *buffer, int size);
int Send_Stream(const char *buffer, int size);
int Send_Dgram(const char *buffer, int size);
public:
/* DFE: We can't protect these data member until the GUI code is updated */
/* protected: */
wxGSocketIOHandler *m_handler;
// true if socket should fire events
bool m_use_events;
protected:
// true if socket should fire events
bool m_use_events;
// pointer for storing extra (usually GUI-specific) data
void *m_gui_dependent;
// descriptors for input and output event notification channels associated
// with the socket
int m_fds[2];
private:
// notify the associated wxSocket about a change in socket state and shut
// down the socket if the event is GSOCK_LOST
void OnStateChange(GSocketEvent event);
// down the socket if the event is wxSOCKET_LOST
void OnStateChange(wxSocketNotify event);
// give it access to our m_fds
friend class wxSocketFDBasedManager;
};
// A version of GSocketManager which uses FDs for socket IO
//
// This class uses GSocket::m_gui_dependent field to store the 2 (for input and
// output) FDs associated with the socket.
class GSocketFDBasedManager : public GSocketManager
// A version of wxSocketManager which uses FDs for socket IO
class wxSocketFDBasedManager : public wxSocketManager
{
public:
// no special initialization/cleanup needed when using FDs
@@ -106,28 +115,9 @@ public:
virtual void OnExit() { }
// allocate/free the storage we need
virtual bool Init_Socket(GSocket *socket)
virtual wxSocketImpl *CreateSocket(wxSocketBase& wxsocket)
{
socket->m_gui_dependent = malloc(sizeof(int)*2);
int * const fds = static_cast<int *>(socket->m_gui_dependent);
fds[0] = -1;
fds[1] = -1;
return true;
}
virtual void Close_Socket(GSocket *socket)
{
Uninstall_Callback(socket, GSOCK_INPUT);
Uninstall_Callback(socket, GSOCK_OUTPUT);
close(socket->m_fd);
}
virtual void Destroy_Socket(GSocket *socket)
{
free(socket->m_gui_dependent);
return new wxSocketImplUnix(wxsocket);
}
protected:
@@ -140,8 +130,8 @@ protected:
FD_OUTPUT
};
// get the FD index corresponding to the given GSocketEvent
SocketDir GetDirForEvent(GSocket *socket, GSocketEvent event)
// get the FD index corresponding to the given wxSocketNotify
SocketDir GetDirForEvent(wxSocketImpl *socket, wxSocketNotify event)
{
switch ( event )
{
@@ -149,34 +139,34 @@ protected:
wxFAIL_MSG( "unexpected socket event" );
// fall through
case GSOCK_LOST:
case wxSOCKET_LOST:
// fall through
case GSOCK_INPUT:
case wxSOCKET_INPUT:
return FD_INPUT;
case GSOCK_OUTPUT:
case wxSOCKET_OUTPUT:
return FD_OUTPUT;
case GSOCK_CONNECTION:
case wxSOCKET_CONNECTION:
// FIXME: explain this?
return socket->m_server ? FD_INPUT : FD_OUTPUT;
}
}
// access the FDs we store
int& FD(GSocket *socket, SocketDir d)
int& FD(wxSocketImpl *socket, SocketDir d)
{
return static_cast<int *>(socket->m_gui_dependent)[d];
return static_cast<wxSocketImplUnix *>(socket)->m_fds[d];
}
};
// Common base class for all ports using X11-like (and hence implemented in
// X11, Motif and GTK) AddInput() and RemoveInput() functions
class GSocketInputBasedManager : public GSocketFDBasedManager
class wxSocketInputBasedManager : public wxSocketFDBasedManager
{
public:
virtual void Install_Callback(GSocket *socket, GSocketEvent event)
virtual void Install_Callback(wxSocketImpl *socket, wxSocketNotify event)
{
wxCHECK_RET( socket->m_fd != -1,
"shouldn't be called on invalid socket" );
@@ -190,7 +180,7 @@ public:
fd = AddInput(socket, d);
}
virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event)
virtual void Uninstall_Callback(wxSocketImpl *socket, wxSocketNotify event)
{
const SocketDir d = GetDirForEvent(socket, event);
@@ -205,7 +195,7 @@ public:
private:
// these functions map directly to XtAdd/RemoveInput() or
// gdk_input_add/remove()
virtual int AddInput(GSocket *socket, SocketDir d) = 0;
virtual int AddInput(wxSocketImpl *socket, SocketDir d) = 0;
virtual void RemoveInput(int fd) = 0;
};