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