X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9bf10d6bd3df0d5ad9d9849f162b17a62c3ac51f..f8b1df0b15f843b8f47efb9bee38f1de0fa95020:/include/wx/gsocket.h?ds=inline diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h index 14dc3c609f..1de34db8fb 100644 --- a/include/wx/gsocket.h +++ b/include/wx/gsocket.h @@ -1,58 +1,58 @@ /* ------------------------------------------------------------------------- - * Project: GSocket (Generic Socket) - * Name: gsocket.h - * Author: Guilhem Lavaux - * Guillermo Rodriguez Garcia (maintainer) - * 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 Vadim Zeitlin + * Licence: wxWindows Licence + * Purpose: GSocket include file (system independent) + * CVSID: $Id$ * ------------------------------------------------------------------------- */ -#ifndef __GSOCKET_H -#define __GSOCKET_H +#ifndef _WX_GSOCKET_H_ +#define _WX_GSOCKET_H_ -#ifndef __GSOCKET_STANDALONE__ -#include "wx/setup.h" -#endif - -#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) +#include "wx/defs.h" -#include -#include +#if wxUSE_SOCKETS -#if !defined(__cplusplus) -typedef unsigned int bool; -#endif +#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */ -#ifndef TRUE -#define TRUE 1 -#endif +#include -#ifndef FALSE -#define FALSE 0 +/* + 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 - -#ifdef __cplusplus -extern "C" { +#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, @@ -62,20 +62,23 @@ typedef enum { GSOCK_INVPORT, GSOCK_WOULDBLOCK, GSOCK_TIMEDOUT, - GSOCK_MEMERR -} GSocketError; + GSOCK_MEMERR, + GSOCK_OPTERR +}; /* See below for an explanation on how events work. */ -typedef enum { +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, @@ -84,13 +87,85 @@ enum { typedef int GSocketEventFlags; +class GSocket; + typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event, char *cdata); +/* + 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; +}; + +#if defined(__WINDOWS__) + #include "wx/msw/gsockmsw.h" +#else + #include "wx/unix/gsockunx.h" +#endif + /* Global initializers */ -/* GSocket_Init() must be called at the beginning */ +/* 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 */ @@ -100,191 +175,6 @@ void GSocket_Cleanup(); /* Constructors / Destructors */ GSocket *GSocket_new(); -void GSocket_destroy(GSocket *socket); - - - -/* GSocket_Shutdown: - * Disallow further read/write operations on this socket, close - * the fd and disable all callbacks. - */ -void GSocket_Shutdown(GSocket *socket); - -/* Address handling */ - -/* GSocket_SetLocal: - * GSocket_GetLocal: - * GSocket_SetPeer: - * GSocket_GetPeer: - * Set or get the local or peer address for this socket. The 'set' - * functions return GSOCK_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 GSocket. - * - * Error codes: - * GSOCK_INVSOCK - the socket is not valid. - * GSOCK_INVADDR - the address is not valid. - */ -GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address); -GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address); -GAddress *GSocket_GetLocal(GSocket *socket); -GAddress *GSocket_GetPeer(GSocket *socket); - -/* Server specific parts */ - -/* GSocket_SetServer: - * Sets up this socket as a server. The local address must have been - * set with GSocket_SetLocal() before GSocket_SetServer() is called. - * Returns GSOCK_NOERROR on success, one of the following otherwise: - * - * Error codes: - * GSOCK_INVSOCK - the socket is in use. - * GSOCK_INVADDR - the local address has not been set. - * GSOCK_IOERR - low-level error. - */ -GSocketError GSocket_SetServer(GSocket *socket); - -/* GSocket_WaitConnection: - * Waits for an incoming client connection. Returns a pointer to - * a GSocket object, or NULL if there was an error, in which case - * the last error field will be updated for the calling GSocket. - * - * Error codes (set in the calling GSocket) - * GSOCK_INVSOCK - the socket is not valid or not a server. - * GSOCK_TIMEDOUT - timeout, no incoming connections. - * GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking. - * GSOCK_MEMERR - couldn't allocate memory. - * GSOCK_IOERR - low-level error. - */ -GSocket *GSocket_WaitConnection(GSocket *socket); - - -/* Client specific parts */ - -/* GSocket_Connect: - * For stream (connection oriented) sockets, GSocket_Connect() tries - * to establish a client connection to a server using the peer address - * as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the - * connection has been succesfully established, or one of the error - * codes listed below. Note that for nonblocking sockets, a return - * value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection - * request can be completed later; you should use GSocket_Select() - * to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the - * corresponding asynchronous events. - * - * For datagram (non connection oriented) sockets, GSocket_Connect() - * just sets the peer address established with GSocket_SetPeer() as - * default destination. - * - * Error codes: - * GSOCK_INVSOCK - the socket is in use or not valid. - * GSOCK_INVADDR - the peer address has not been established. - * GSOCK_TIMEDOUT - timeout, the connection failed. - * GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only) - * GSOCK_MEMERR - couldn't allocate memory. - * GSOCK_IOERR - low-level error. - */ -GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream); - - -/* Datagram sockets */ - -/* GSocket_SetNonOriented: - * Sets up this socket as a non-connection oriented (datagram) socket. - * Before using this function, the local address must have been set - * with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR - * on success, or one of the following otherwise. - * - * Error codes: - * GSOCK_INVSOCK - the socket is in use. - * GSOCK_INVADDR - the local address has not been set. - * GSOCK_IOERR - low-level error. - */ -GSocketError GSocket_SetNonOriented(GSocket *socket); - - -/* Generic IO */ - -/* Like recv(), send(), ... */ - -/* For datagram sockets, the incoming / outgoing addresses - * are stored as / read from the 'peer' address field. - */ -int GSocket_Read(GSocket *socket, char *buffer, int size); -int GSocket_Write(GSocket *socket, const char *buffer, - int size); - -/* GSocket_Select: - * 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. - */ -GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags); - - -/* Attributes */ - -/* GSocket_SetNonBlocking: - * Sets the socket to non-blocking mode. All IO calls will return - * immediately. - */ -void GSocket_SetNonBlocking(GSocket *socket, bool non_block); - -/* GSocket_SetTimeout: - * Sets the timeout for blocking calls. Time is expressed in - * milliseconds. - */ -void GSocket_SetTimeout(GSocket *socket, unsigned long millisec); - -/* GSocket_GetError: - * Returns the last error occured for this socket. Note that successful - * operations do not clear this back to GSOCK_NOERROR, so use it only - * after an error. - */ -GSocketError GSocket_GetError(GSocket *socket); - - -/* Callbacks */ - -/* GSOCK_INPUT: - * There is data to be read in the input buffer. If, after a read - * operation, there is still data available, the callback function will - * be called again. - * GSOCK_OUTPUT: - * The socket is available for writing. That is, the next write call - * won't block. This event is generated only once, when the connection is - * first established, and then only if a call failed with GSOCK_WOULDBLOCK, - * when the output buffer empties again. This means that the app should - * assume that it can write since the first OUTPUT event, and no more - * OUTPUT events will be generated unless an error occurs. - * GSOCK_CONNECTION: - * Connection succesfully established, for client sockets, or incoming - * client connection, for server sockets. Wait for this event (also watch - * out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call. - * GSOCK_LOST: - * The connection is lost (or a connection request failed); this could - * be due to a failure, or due to the peer closing it gracefully. - */ - -/* GSocket_SetCallback: - * Enables the callbacks specified by 'flags'. Note that 'flags' - * may be a combination of flags OR'ed toghether, so the same - * callback function can be made to accept different events. - * The callback function must have the following prototype: - * - * void function(GSocket *socket, GSocketEvent event, char *cdata) - */ -void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags, - GSocketCallback fallback, char *cdata); - -/* GSocket_UnsetCallback: - * Disables all callbacks specified by 'flags', which may be a - * combination of flags OR'ed toghether. - */ -void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags); /* GAddress */ @@ -302,6 +192,7 @@ GAddressType GAddress_GetFamily(GAddress *address); */ 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); @@ -314,16 +205,28 @@ 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) */ +#if wxUSE_IPV6 -GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path); -GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf); +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); -#ifdef __cplusplus -}; -#endif /* __cplusplus */ +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); + +#endif // wxUSE_IPV6 +/* TODO: Define specific parts (UNIX) */ + +GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path); +GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf); -#endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */ +#endif /* wxUSE_SOCKETS */ -#endif /* __GSOCKET_H */ +#endif /* _WX_GSOCKET_H_ */