include/wx/gsocket.h

   1 /* -------------------------------------------------------------------------
   2  * Project:     GSocket (Generic Socket)
   3  * Name:        gsocket.h
   4  * Author:      Guilhem Lavaux
   5  *              Guillermo Rodriguez Garcia <guille@iies.es>
   6  * Copyright:   (c) Guilhem Lavaux
   7  *              (c) 2007,2008 Vadim Zeitlin <vadim@wxwidgets.org>
   8  * Licence:     wxWindows Licence
   9  * Purpose:     GSocket include file (system independent)
  10  * CVSID:       $Id$
  11  * -------------------------------------------------------------------------
  12  */
  13
  14 #ifndef _WX_GSOCKET_H_
  15 #define _WX_GSOCKET_H_
  16
  17 #include "wx/defs.h"
  18
  19 #if wxUSE_SOCKETS
  20
  21 #include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */
  22
  23 #include <stddef.h>
  24
  25 /*
  26    Including sys/types.h under Cygwin results in the warnings about "fd_set
  27    having been defined in sys/types.h" when winsock.h is included later and
  28    doesn't seem to be necessary anyhow. It's not needed under Mac neither.
  29  */
  30 #if !defined(__WXMAC__) && !defined(__CYGWIN__) && !defined(__WXWINCE__)
  31 #include <sys/types.h>
  32 #endif
  33
  34 #ifdef __WXWINCE__
  35 #include <stdlib.h>
  36 #endif
  37
  38 enum GAddressType
  39 {
  40   GSOCK_NOFAMILY = 0,
  41   GSOCK_INET,
  42   GSOCK_INET6,
  43   GSOCK_UNIX
  44 };
  45
  46 enum GSocketStream
  47 {
  48   GSOCK_STREAMED,
  49   GSOCK_UNSTREAMED
  50 };
  51
  52 enum GSocketError
  53 {
  54   GSOCK_NOERROR = 0,
  55   GSOCK_INVOP,
  56   GSOCK_IOERR,
  57   GSOCK_INVADDR,
  58   GSOCK_INVSOCK,
  59   GSOCK_NOHOST,
  60   GSOCK_INVPORT,
  61   GSOCK_WOULDBLOCK,
  62   GSOCK_TIMEDOUT,
  63   GSOCK_MEMERR,
  64   GSOCK_OPTERR
  65 };
  66
  67 /* See below for an explanation on how events work.
  68  */
  69 enum GSocketEvent
  70 {
  71   GSOCK_INPUT  = 0,
  72   GSOCK_OUTPUT = 1,
  73   GSOCK_CONNECTION = 2,
  74   GSOCK_LOST = 3,
  75   GSOCK_MAX_EVENT = 4
  76 };
  77
  78 enum
  79 {
  80   GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT,
  81   GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT,
  82   GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION,
  83   GSOCK_LOST_FLAG = 1 << GSOCK_LOST
  84 };
  85
  86 typedef int GSocketEventFlags;
  87
  88 struct GAddress;
  89 class GSocket;
  90
  91 typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
  92                                 char *cdata);
  93
  94 /*
  95    Class providing hooks abstracting the differences between console and GUI
  96    applications for socket code.
  97
  98    We also have different implementations of this class for different platforms
  99    allowing us to keep more things in the common code but the main reason for
 100    its existence is that we want the same socket code work differently
 101    depending on whether it's used from a console or a GUI program. This is
 102    achieved by implementing the virtual methods of this class differently in
 103    the objects returned by wxConsoleAppTraits::GetSocketFunctionsTable() and
 104    the same method in wxGUIAppTraits.
 105  */
 106 class GSocketManager
 107 {
 108 public:
 109     // set the manager to use, we don't take ownership of it
 110     //
 111     // this should be called before GSocket_Init(), i.e. before the first
 112     // wxSocket object is created, otherwise the manager returned by
 113     // wxAppTraits::GetSocketManager() will be used
 114     static void Set(GSocketManager *manager);
 115
 116     // return the manager to use
 117     //
 118     // this initializes the manager at first use
 119     static GSocketManager *Get()
 120     {
 121         if ( !ms_manager )
 122             Init();
 123
 124         return ms_manager;
 125     }
 126
 127     // called before the first wxSocket is created and should do the
 128     // initializations needed in order to use the network
 129     //
 130     // return true if initialized successfully
 131     virtual bool OnInit() = 0;
 132
 133     // undo the initializations of OnInit()
 134     virtual void OnExit() = 0;
 135
 136
 137     // do manager-specific socket initializations (and undo it): this is called
 138     // in the beginning/end of the socket initialization/destruction
 139     virtual bool Init_Socket(GSocket *socket) = 0;
 140     virtual void Destroy_Socket(GSocket *socket) = 0;
 141
 142     virtual void Install_Callback(GSocket *socket, GSocketEvent event) = 0;
 143     virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) = 0;
 144
 145     virtual void Enable_Events(GSocket *socket) = 0;
 146     virtual void Disable_Events(GSocket *socket) = 0;
 147
 148     virtual ~GSocketManager() { }
 149
 150 private:
 151     // get the manager to use if we don't have it yet
 152     static void Init();
 153
 154     static GSocketManager *ms_manager;
 155 };
 156
 157 /*
 158     Base class providing functionality common to BSD and Winsock sockets.
 159
 160     TODO: merge this in wxSocket itself, there is no reason to maintain the
 161           separation between wxSocket and GSocket.
 162  */
 163 class GSocketBase
 164 {
 165 public:
 166     GSocketEventFlags Select(GSocketEventFlags flags);
 167
 168 #ifdef __WINDOWS__
 169     SOCKET m_fd;
 170 #else
 171     int m_fd;
 172 #endif
 173
 174     bool m_ok;
 175     int m_initialRecvBufferSize;
 176     int m_initialSendBufferSize;
 177
 178     GAddress *m_local;
 179     GAddress *m_peer;
 180     GSocketError m_error;
 181
 182     bool m_non_blocking;
 183     bool m_server;
 184     bool m_stream;
 185     bool m_establishing;
 186     bool m_reusable;
 187     bool m_broadcast;
 188     bool m_dobind;
 189
 190 #ifdef __WINDOWS__
 191     struct timeval m_timeout;
 192 #else
 193     unsigned long m_timeout;
 194 #endif
 195
 196     GSocketEventFlags m_detected;
 197     GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
 198     char *m_data[GSOCK_MAX_EVENT];
 199 };
 200
 201 #if defined(__WINDOWS__)
 202     #include "wx/msw/gsockmsw.h"
 203 #else
 204     #include "wx/unix/gsockunx.h"
 205 #endif
 206
 207
 208 /* Global initializers */
 209
 210 /* GSocket_Init() must be called at the beginning (but after calling
 211  * GSocketManager::Set() if a custom manager should be used) */
 212 bool GSocket_Init();
 213
 214 /* GSocket_Cleanup() must be called at the end */
 215 void GSocket_Cleanup();
 216
 217
 218 /* Constructors / Destructors */
 219
 220 GSocket *GSocket_new();
 221
 222
 223 /* GAddress */
 224
 225 // Represents a socket endpoint, i.e. -- in spite of its name -- not an address
 226 // but an (address, port) pair
 227 struct GAddress
 228 {
 229     struct sockaddr *m_addr;
 230     size_t m_len;
 231
 232     GAddressType m_family;
 233     int m_realfamily;
 234
 235     GSocketError m_error;
 236 };
 237
 238 GAddress *GAddress_new();
 239 GAddress *GAddress_copy(GAddress *address);
 240 void GAddress_destroy(GAddress *address);
 241
 242 void GAddress_SetFamily(GAddress *address, GAddressType type);
 243 GAddressType GAddress_GetFamily(GAddress *address);
 244
 245 /* The use of any of the next functions will set the address family to
 246  * the specific one. For example if you use GAddress_INET_SetHostName,
 247  * address family will be implicitly set to AF_INET.
 248  */
 249
 250 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
 251 GSocketError GAddress_INET_SetBroadcastAddress(GAddress *address);
 252 GSocketError GAddress_INET_SetAnyAddress(GAddress *address);
 253 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
 254                                           unsigned long hostaddr);
 255 GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
 256                                        const char *protocol);
 257 GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port);
 258
 259 GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname,
 260                                        size_t sbuf);
 261 unsigned long GAddress_INET_GetHostAddress(GAddress *address);
 262 unsigned short GAddress_INET_GetPort(GAddress *address);
 263
 264 GSocketError _GAddress_translate_from(GAddress *address,
 265                                       struct sockaddr *addr, int len);
 266 GSocketError _GAddress_translate_to  (GAddress *address,
 267                                       struct sockaddr **addr, int *len);
 268 GSocketError _GAddress_Init_INET(GAddress *address);
 269
 270 #if wxUSE_IPV6
 271
 272 GSocketError GAddress_INET6_SetHostName(GAddress *address, const char *hostname);
 273 GSocketError GAddress_INET6_SetAnyAddress(GAddress *address);
 274 GSocketError GAddress_INET6_SetHostAddress(GAddress *address,
 275                                           struct in6_addr hostaddr);
 276 GSocketError GAddress_INET6_SetPortName(GAddress *address, const char *port,
 277                                        const char *protocol);
 278 GSocketError GAddress_INET6_SetPort(GAddress *address, unsigned short port);
 279
 280 GSocketError GAddress_INET6_GetHostName(GAddress *address, char *hostname,
 281                                        size_t sbuf);
 282 GSocketError GAddress_INET6_GetHostAddress(GAddress *address,struct in6_addr *hostaddr);
 283 unsigned short GAddress_INET6_GetPort(GAddress *address);
 284
 285 #endif // wxUSE_IPV6
 286
 287 // these functions are available under all platforms but only implemented under
 288 // Unix ones, elsewhere they just return GSOCK_INVADDR
 289 GSocketError _GAddress_Init_UNIX(GAddress *address);
 290 GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
 291 GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
 292
 293 // standard linux headers produce many warnings when used with icc
 294 #if defined(__INTELC__) && defined(__LINUX__)
 295     inline void wxFD_ZERO(fd_set *fds)
 296     {
 297         #pragma warning(push)
 298         #pragma warning(disable:593)
 299         FD_ZERO(fds);
 300         #pragma warning(pop)
 301     }
 302
 303     inline void wxFD_SET(int fd, fd_set *fds)
 304     {
 305         #pragma warning(push, 1)
 306         #pragma warning(disable:1469)
 307         FD_SET(fd, fds);
 308         #pragma warning(pop)
 309     }
 310
 311     inline bool wxFD_ISSET(int fd, fd_set *fds)
 312     {
 313         #pragma warning(push, 1)
 314         #pragma warning(disable:1469)
 315         return FD_ISSET(fd, fds);
 316         #pragma warning(pop)
 317     }
 318     inline bool wxFD_CLR(int fd, fd_set *fds)
 319     {
 320         #pragma warning(push, 1)
 321         #pragma warning(disable:1469)
 322         return FD_CLR(fd, fds);
 323         #pragma warning(pop)
 324     }
 325 #else // !__INTELC__
 326     #define wxFD_ZERO(fds) FD_ZERO(fds)
 327     #define wxFD_SET(fd, fds) FD_SET(fd, fds)
 328     #define wxFD_ISSET(fd, fds) FD_ISSET(fd, fds)
 329     #define wxFD_CLR(fd, fds) FD_CLR(fd, fds)
 330 #endif // __INTELC__/!__INTELC__
 331
 332 // this is for Windows where configure doesn't define this
 333 #ifndef SOCKOPTLEN_T
 334     #define SOCKOPTLEN_T int
 335 #endif
 336
 337 #endif /* wxUSE_SOCKETS */
 338
 339 #endif /* _WX_GSOCKET_H_ */