X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d422d01eec769f5339087b4b3ad352d3d164bf1b..edc09871744140f16b2ef6b7abaa2289d7deb260:/include/wx/gsocket.h diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h index 7190696fd0..ffd70673d6 100644 --- a/include/wx/gsocket.h +++ b/include/wx/gsocket.h @@ -1,32 +1,48 @@ /* ------------------------------------------------------------------------- - * 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 (maintainer) + * Copyright: (c) Guilhem Lavaux + * Licence: wxWindows Licence + * Purpose: GSocket include file (system independent) + * CVSID: $Id$ * ------------------------------------------------------------------------- */ + #ifndef __GSOCKET_H #define __GSOCKET_H -#include "wx/setup.h" +#ifndef __GSOCKET_STANDALONE__ +#include "wx/defs.h" -#if wxUSE_SOCKETS +#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */ -#include +#endif + +#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) -#if !defined(__cplusplus) -typedef int bool; +#include + +/* + 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 TRUE -#define TRUE 1 +#ifdef __WXWINCE__ +#include #endif -#ifndef FALSE -#define FALSE 0 +class GSocket; + +#ifdef __cplusplus +extern "C" { #endif -typedef struct _GSocket GSocket; typedef struct _GAddress GAddress; typedef enum { @@ -49,10 +65,14 @@ typedef enum { GSOCK_INVSOCK, GSOCK_NOHOST, GSOCK_INVPORT, - GSOCK_TRYAGAIN, - GSOCK_MEMERR + GSOCK_WOULDBLOCK, + GSOCK_TIMEDOUT, + GSOCK_MEMERR, + GSOCK_OPTERR } GSocketError; +/* See below for an explanation on how events work. + */ typedef enum { GSOCK_INPUT = 0, GSOCK_OUTPUT = 1, @@ -73,137 +93,64 @@ typedef int GSocketEventFlags; 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); - -/* Client specific parts */ - -/* - 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 */ +/* Functions tables for internal use by GSocket code: */ + +/* Actually this is a misnomer now, but reusing this name means I don't + have to ifdef app traits or common socket code */ +class GSocketGUIFunctionsTable +{ +public: + // needed since this class declares virtual members + virtual ~GSocketGUIFunctionsTable() { } + virtual bool OnInit() = 0; + virtual void OnExit() = 0; + virtual bool CanUseEventLoop() = 0; + virtual bool Init_Socket(GSocket *socket) = 0; + virtual void Destroy_Socket(GSocket *socket) = 0; +#ifndef __WINDOWS__ + virtual void Install_Callback(GSocket *socket, GSocketEvent event) = 0; + virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) = 0; +#endif + virtual void Enable_Events(GSocket *socket) = 0; + virtual void Disable_Events(GSocket *socket) = 0; +}; -/* 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); -/* Flags/Parameters */ +/* Global initializers */ -/* - GSocket_SetTimeout() sets the timeout for reading and writing IO call. Time - is expressed in milliseconds. - */ -void GSocket_SetTimeout(GSocket *socket, unsigned long millisec); +/* Sets GUI functions callbacks. Must be called *before* GSocket_Init + if the app uses async sockets. */ +void GSocket_SetGUIFunctions(GSocketGUIFunctionsTable *guifunc); -/* - 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); +/* GSocket_Init() must be called at the beginning */ +int GSocket_Init(void); -/* - GSocket_GetError() returns the last error occured on the socket stream. -*/ +/* GSocket_Cleanup() must be called at the end */ +void GSocket_Cleanup(void); -GSocketError GSocket_GetError(GSocket *socket); -/* Callbacks */ +/* Constructors / Destructors */ -/* - 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); +GSocket *GSocket_new(void); -/* - UnsetCallback will disables all fallbacks specified by "event". - NOTE: event may be a combination of flags -*/ -void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags event); /* GAddress */ -GAddress *GAddress_new(); +GAddress *GAddress_new(void); GAddress *GAddress_copy(GAddress *address); 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_SetAnyAddress(GAddress *address); GSocketError GAddress_INET_SetHostAddress(GAddress *address, unsigned long hostaddr); GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port, @@ -220,23 +167,18 @@ unsigned short GAddress_INET_GetPort(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 - */ - -/* On systems needing an event id */ -void GSocket_SetEventID(GSocket *socket, unsigned long evt_id); - -/* On systems which don't have background refresh */ -void GSocket_DoEvent(unsigned long evt_id); - #ifdef __cplusplus -}; +} #endif /* __cplusplus */ +# if defined(__WINDOWS__) +# include "wx/msw/gsockmsw.h" +# elif defined(__WXMAC__) && !defined(__DARWIN__) +# include "wx/mac/gsockmac.h" +# else +# include "wx/unix/gsockunx.h" +# endif -#endif - /* wxUSE_SOCKETS */ +#endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */ -#endif - /* __GSOCKET_H */ +#endif /* __GSOCKET_H */