X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/98781fa30e4a8cb7b244aba345a78a2a3c8f7f25..236a34ef3e930b22ddfc48ad0eb858ebba0a14b9:/include/wx/gsocket.h?ds=inline diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h index 938b6f0b77..a97ef10439 100644 --- a/include/wx/gsocket.h +++ b/include/wx/gsocket.h @@ -1,48 +1,56 @@ /* ------------------------------------------------------------------------- - * Project: GSocket (Generic Socket) - * Name: gsocket.h - * Purpose: GSocket include file (system independent) - * CVSID: $Id$ + * Project: GSocket (Generic Socket) + * Name: gsocket.h + * Author: Guilhem Lavaux + * Guillermo Rodriguez Garcia + * Copyright: (c) Guilhem Lavaux + * (c) 2007,2008 Vadim Zeitlin + * Licence: wxWindows Licence + * Purpose: GSocket include file (system independent) + * CVSID: $Id$ * ------------------------------------------------------------------------- */ -#ifndef __GSOCKET_H -#define __GSOCKET_H -#include "wx/setup.h" +#ifndef _WX_GSOCKET_H_ +#define _WX_GSOCKET_H_ + +#include "wx/defs.h" #if wxUSE_SOCKETS -#include -#include +#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */ -#if !defined(__cplusplus) -typedef int bool; -#endif +#include -#ifndef TRUE -#define TRUE 1 +/* + Including sys/types.h under Cygwin results in the warnings about "fd_set + having been defined in sys/types.h" when winsock.h is included later and + doesn't seem to be necessary anyhow. It's not needed under Mac neither. + */ +#if !defined(__WXMAC__) && !defined(__CYGWIN__) && !defined(__WXWINCE__) +#include #endif -#ifndef FALSE -#define FALSE 0 +#ifdef __WXWINCE__ +#include #endif -typedef struct _GSocket GSocket; -typedef struct _GAddress GAddress; - -typedef enum { +enum GAddressType +{ GSOCK_NOFAMILY = 0, GSOCK_INET, GSOCK_INET6, GSOCK_UNIX -} GAddressType; +}; -typedef enum { +enum GSocketStream +{ GSOCK_STREAMED, GSOCK_UNSTREAMED -} GSocketStream; +}; -typedef enum { +enum GSocketError +{ GSOCK_NOERROR = 0, GSOCK_INVOP, GSOCK_IOERR, @@ -51,19 +59,24 @@ typedef enum { GSOCK_NOHOST, GSOCK_INVPORT, GSOCK_WOULDBLOCK, - GSOCK_TIMEOUT, - GSOCK_MEMERR -} GSocketError; + GSOCK_TIMEDOUT, + GSOCK_MEMERR, + GSOCK_OPTERR +}; -typedef enum { +/* 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 -} GSocketEvent; +}; -enum { +enum +{ GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT, GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT, GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION, @@ -72,125 +85,111 @@ enum { typedef int GSocketEventFlags; +struct GAddress; +class GSocket; + typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event, char *cdata); -#ifdef __cplusplus -extern "C" { -#endif - -/* Global initialisers */ - -/* GSocket_Init() must be called at the beginning */ -bool GSocket_Init(); -/* GSocket_Cleanup() must be called at the ending */ -void GSocket_Cleanup(); - -/* Constructors / Destructors */ - -GSocket *GSocket_new(); -void GSocket_destroy(GSocket *socket); - -/* This will disable all IO calls to this socket but errors are still available */ -void GSocket_Shutdown(GSocket *socket); - -/* Address handling */ - -GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address); -GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address); -GAddress *GSocket_GetLocal(GSocket *socket); -GAddress *GSocket_GetPeer(GSocket *socket); - -/* Non-oriented connections handlers */ - -GSocketError GSocket_SetNonOriented(GSocket *socket); - -/* Server specific parts */ - -/* - GSocket_SetServer() setups the socket as a server. It uses the "Local" field - of GSocket. "Local" must be set by GSocket_SetLocal() before - GSocket_SetServer() is called. In the other case, it returns GSOCK_INVADDR. -*/ -GSocketError GSocket_SetServer(GSocket *socket); - /* - GSocket_WaitConnection() waits for an incoming client connection. -*/ -GSocket *GSocket_WaitConnection(GSocket *socket); + Class providing hooks abstracting the differences between console and GUI + applications for socket code. + + We also have different implementations of this class for different platforms + allowing us to keep more things in the common code but the main reason for + 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. + */ +class GSocketManager +{ +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); + + // return the manager to use + // + // this initializes the manager at first use + static GSocketManager *Get() + { + if ( !ms_manager ) + Init(); + + return ms_manager; + } + + // called before the first wxSocket is created and should do the + // initializations needed in order to use the network + // + // return true if initialized successfully + virtual bool OnInit() = 0; + + // undo the initializations of OnInit() + virtual void OnExit() = 0; + + + // do manager-specific socket initializations (and undo it): this is called + // in the beginning/end of the socket initialization/destruction + virtual bool Init_Socket(GSocket *socket) = 0; + virtual void Destroy_Socket(GSocket *socket) = 0; + + virtual void Install_Callback(GSocket *socket, GSocketEvent event) = 0; + virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) = 0; + + virtual void Enable_Events(GSocket *socket) = 0; + virtual void Disable_Events(GSocket *socket) = 0; + + virtual ~GSocketManager() { } + +private: + // get the manager to use if we don't have it yet + static void Init(); + + static GSocketManager *ms_manager; +}; -/* Client specific parts */ +#if defined(__WINDOWS__) + #include "wx/msw/gsockmsw.h" +#else + #include "wx/unix/gsockunx.h" +#endif -/* - GSocket_Connect() establishes a client connection to a server using the "Peer" - field of GSocket. "Peer" must be set by GSocket_SetPeer() before - GSocket_Connect() is called. In the other case, it returns GSOCK_INVADDR. -*/ -GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream); -/* Generic IO */ +/* Global initializers */ -/* Like recv(), send(), ... */ -/* - NOTE: In case we read from a non-oriented connection, the incoming (outgoing) - connection address is stored in the "Local" ("Peer") field. -*/ -int GSocket_Read(GSocket *socket, char *buffer, int size); -int GSocket_Write(GSocket *socket, const char *buffer, - int size); -bool GSocket_DataAvailable(GSocket *socket); +/* GSocket_Init() must be called at the beginning (but after calling + * GSocketManager::Set() if a custom manager should be used) */ +bool GSocket_Init(); -/* Flags/Parameters */ +/* GSocket_Cleanup() must be called at the end */ +void GSocket_Cleanup(); -/* - GSocket_SetTimeout() sets the timeout for reading and writing IO call. Time - is expressed in milliseconds. - */ -void GSocket_SetTimeout(GSocket *socket, unsigned long millisec); -/* - GSocket_SetBlocking() puts the socket in non-blocking mode. This is useful - if we don't want to wait. -*/ -void GSocket_SetNonBlocking(GSocket *socket, bool non_block); +/* Constructors / Destructors */ -/* - GSocket_GetError() returns the last error occured on the socket stream. -*/ +GSocket *GSocket_new(); -GSocketError GSocket_GetError(GSocket *socket); -/* Callbacks */ +/* GAddress */ -/* - Only one fallback is possible for each event (INPUT, OUTPUT, CONNECTION, LOST) - INPUT: The function is called when there is at least a byte in the - input buffer - OUTPUT: The function is called when the system is sure the next write call - will not block - CONNECTION: Two cases is possible: - Client socket -> the connection is established - Server socket -> a client request a connection - LOST: the connection is lost - - SetCallback accepts a combination of these flags so a same callback can - receive different events. - - An event is generated only once and its state is reseted when the relative - IO call is requested. - For example: INPUT -> GSocket_Read() - CONNECTION -> GSocket_Accept() -*/ -void GSocket_SetCallback(GSocket *socket, GSocketEventFlags event, - GSocketCallback fallback, char *cdata); +// Represents a socket endpoint, i.e. -- in spite of its name -- not an address +// but an (address, port) pair +struct GAddress +{ + struct sockaddr *m_addr; + size_t m_len; -/* - UnsetCallback will disables all fallbacks specified by "event". - NOTE: event may be a combination of flags -*/ -void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags event); + GAddressType m_family; + int m_realfamily; -/* GAddress */ + GSocketError m_error; +}; GAddress *GAddress_new(); GAddress *GAddress_copy(GAddress *address); @@ -199,13 +198,14 @@ void GAddress_destroy(GAddress *address); void GAddress_SetFamily(GAddress *address, GAddressType type); GAddressType GAddress_GetFamily(GAddress *address); -/* - The use of any of the next functions will set the address family to the adapted - one. For example if you use GAddress_INET_SetHostName, address family will be AF_INET - implicitely -*/ +/* The use of any of the next functions will set the address family to + * the specific one. For example if you use GAddress_INET_SetHostName, + * 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, unsigned long hostaddr); GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port, @@ -217,28 +217,35 @@ GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname, unsigned long GAddress_INET_GetHostAddress(GAddress *address); unsigned short GAddress_INET_GetPort(GAddress *address); -/* TODO: Define specific parts (INET6, UNIX) */ +GSocketError _GAddress_translate_from(GAddress *address, + struct sockaddr *addr, int len); +GSocketError _GAddress_translate_to (GAddress *address, + struct sockaddr **addr, int *len); +GSocketError _GAddress_Init_INET(GAddress *address); -GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path); -GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf); - -/* - * System specific functions - */ +#if wxUSE_IPV6 -/* On systems needing an event id */ -void GSocket_SetEventID(GSocket *socket, unsigned long evt_id); +GSocketError GAddress_INET6_SetHostName(GAddress *address, const char *hostname); +GSocketError GAddress_INET6_SetAnyAddress(GAddress *address); +GSocketError GAddress_INET6_SetHostAddress(GAddress *address, + struct in6_addr hostaddr); +GSocketError GAddress_INET6_SetPortName(GAddress *address, const char *port, + const char *protocol); +GSocketError GAddress_INET6_SetPort(GAddress *address, unsigned short port); -/* On systems which don't have background refresh */ -void GSocket_DoEvent(unsigned long evt_id); +GSocketError GAddress_INET6_GetHostName(GAddress *address, char *hostname, + size_t sbuf); +GSocketError GAddress_INET6_GetHostAddress(GAddress *address,struct in6_addr *hostaddr); +unsigned short GAddress_INET6_GetPort(GAddress *address); -#ifdef __cplusplus -}; -#endif /* __cplusplus */ +#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); -#endif - /* wxUSE_SOCKETS */ +#endif /* wxUSE_SOCKETS */ -#endif - /* __GSOCKET_H */ +#endif /* _WX_GSOCKET_H_ */