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