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> (maintainer)
   6  * Purpose: GSocket include file (system independent)
   7  * CVSID:   $Id$
   8  * -------------------------------------------------------------------------
   9  */
  10
  11 #ifndef __GSOCKET_H
  12 #define __GSOCKET_H
  13
  14 /* DFE: Define this and compile gsocket.cpp instead of gsocket.c and
  15    compile existing GUI gsock*.c as C++ to try out the new GSocket. */
  16 /* #define wxUSE_GSOCKET_CPLUSPLUS 1 */
  17 #undef wxUSE_GSOCKET_CPLUSPLUS
  18 #if !defined(__cplusplus) && defined(wxUSE_GSOCKET_CPLUSPLUS)
  19 #error "You need to compile this file (probably a GUI gsock peice) as C++"
  20 #endif
  21
  22 #ifndef __GSOCKET_STANDALONE__
  23 #include "wx/setup.h"
  24 #include "wx/platform.h"
  25
  26 #include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */
  27
  28 #endif
  29
  30 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
  31
  32 #include <stddef.h>
  33
  34 /*
  35    Including sys/types.h under cygwin results in the warnings about "fd_set
  36    having been defined in sys/types.h" when winsock.h is included later and
  37    doesn't seem to be necessary anyhow. It's not needed under Mac neither.
  38  */
  39 #if !defined(__WXMAC__) && !defined(__CYGWIN__) && !defined(__WXWINCE__)
  40 #include <sys/types.h>
  41 #endif
  42
  43 #ifdef __WXWINCE__
  44 #include <stdlib.h>
  45 #endif
  46
  47 #ifdef wxUSE_GSOCKET_CPLUSPLUS
  48 typedef class GSocketBSD GSocket;
  49 #endif
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 #ifndef wxUSE_GSOCKET_CPLUSPLUS
  56 typedef struct _GSocket GSocket;
  57 #endif
  58 typedef struct _GAddress GAddress;
  59
  60 typedef enum {
  61   GSOCK_NOFAMILY = 0,
  62   GSOCK_INET,
  63   GSOCK_INET6,
  64   GSOCK_UNIX
  65 } GAddressType;
  66
  67 typedef enum {
  68   GSOCK_STREAMED,
  69   GSOCK_UNSTREAMED
  70 } GSocketStream;
  71
  72 typedef enum {
  73   GSOCK_NOERROR = 0,
  74   GSOCK_INVOP,
  75   GSOCK_IOERR,
  76   GSOCK_INVADDR,
  77   GSOCK_INVSOCK,
  78   GSOCK_NOHOST,
  79   GSOCK_INVPORT,
  80   GSOCK_WOULDBLOCK,
  81   GSOCK_TIMEDOUT,
  82   GSOCK_MEMERR
  83 } GSocketError;
  84
  85 /* See below for an explanation on how events work.
  86  */
  87 typedef enum {
  88   GSOCK_INPUT  = 0,
  89   GSOCK_OUTPUT = 1,
  90   GSOCK_CONNECTION = 2,
  91   GSOCK_LOST = 3,
  92   GSOCK_MAX_EVENT = 4
  93 } GSocketEvent;
  94
  95 enum {
  96   GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT,
  97   GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT,
  98   GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION,
  99   GSOCK_LOST_FLAG = 1 << GSOCK_LOST
 100 };
 101
 102 typedef int GSocketEventFlags;
 103
 104 typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
 105                                 char *cdata);
 106
 107
 108 /* Functions tables for internal use by GSocket code: */
 109
 110 #ifndef __WINDOWS__
 111 struct GSocketBaseFunctionsTable
 112 {
 113     void (*Detected_Read)(GSocket *socket);
 114     void (*Detected_Write)(GSocket *socket);
 115 };
 116 #endif
 117
 118 struct GSocketGUIFunctionsTable
 119 {
 120     int  (*GUI_Init)(void);
 121     void (*GUI_Cleanup)(void);
 122     int  (*GUI_Init_Socket)(GSocket *socket);
 123     void (*GUI_Destroy_Socket)(GSocket *socket);
 124 #ifndef __WINDOWS__
 125     void (*Install_Callback)(GSocket *socket, GSocketEvent event);
 126     void (*Uninstall_Callback)(GSocket *socket, GSocketEvent event);
 127 #endif
 128     void (*Enable_Events)(GSocket *socket);
 129     void (*Disable_Events)(GSocket *socket);
 130 };
 131
 132
 133 /* Global initializers */
 134
 135 /* Sets GUI functions callbacks. Must be called *before* GSocket_Init
 136    if the app uses async sockets. */
 137 void GSocket_SetGUIFunctions(struct GSocketGUIFunctionsTable *guifunc);
 138
 139 /* GSocket_Init() must be called at the beginning */
 140 int GSocket_Init(void);
 141
 142 /* GSocket_Cleanup() must be called at the end */
 143 void GSocket_Cleanup(void);
 144
 145
 146 /* Constructors / Destructors */
 147
 148 GSocket *GSocket_new(void);
 149 void GSocket_destroy(GSocket *socket);
 150
 151
 152 #ifndef wxUSE_GSOCKET_CPLUSPLUS
 153
 154 /* GSocket_Shutdown:
 155  *  Disallow further read/write operations on this socket, close
 156  *  the fd and disable all callbacks.
 157  */
 158 void GSocket_Shutdown(GSocket *socket);
 159
 160 /* Address handling */
 161
 162 /* GSocket_SetLocal:
 163  * GSocket_GetLocal:
 164  * GSocket_SetPeer:
 165  * GSocket_GetPeer:
 166  *  Set or get the local or peer address for this socket. The 'set'
 167  *  functions return GSOCK_NOERROR on success, an error code otherwise.
 168  *  The 'get' functions return a pointer to a GAddress object on success,
 169  *  or NULL otherwise, in which case they set the error code of the
 170  *  corresponding GSocket.
 171  *
 172  *  Error codes:
 173  *    GSOCK_INVSOCK - the socket is not valid.
 174  *    GSOCK_INVADDR - the address is not valid.
 175  */
 176 GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address);
 177 GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address);
 178 GAddress *GSocket_GetLocal(GSocket *socket);
 179 GAddress *GSocket_GetPeer(GSocket *socket);
 180
 181 /* Server specific parts */
 182
 183 /* GSocket_SetServer:
 184  *  Sets up this socket as a server. The local address must have been
 185  *  set with GSocket_SetLocal() before GSocket_SetServer() is called.
 186  *  Returns GSOCK_NOERROR on success, one of the following otherwise:
 187  *
 188  *  Error codes:
 189  *    GSOCK_INVSOCK - the socket is in use.
 190  *    GSOCK_INVADDR - the local address has not been set.
 191  *    GSOCK_IOERR   - low-level error.
 192  */
 193 GSocketError GSocket_SetServer(GSocket *socket);
 194
 195 /* GSocket_WaitConnection:
 196  *  Waits for an incoming client connection. Returns a pointer to
 197  *  a GSocket object, or NULL if there was an error, in which case
 198  *  the last error field will be updated for the calling GSocket.
 199  *
 200  *  Error codes (set in the calling GSocket)
 201  *    GSOCK_INVSOCK    - the socket is not valid or not a server.
 202  *    GSOCK_TIMEDOUT   - timeout, no incoming connections.
 203  *    GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
 204  *    GSOCK_MEMERR     - couldn't allocate memory.
 205  *    GSOCK_IOERR      - low-level error.
 206  */
 207 GSocket *GSocket_WaitConnection(GSocket *socket);
 208
 209
 210 /* Client specific parts */
 211
 212 /* GSocket_Connect:
 213  *  For stream (connection oriented) sockets, GSocket_Connect() tries
 214  *  to establish a client connection to a server using the peer address
 215  *  as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the
 216  *  connection has been succesfully established, or one of the error
 217  *  codes listed below. Note that for nonblocking sockets, a return
 218  *  value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
 219  *  request can be completed later; you should use GSocket_Select()
 220  *  to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the
 221  *  corresponding asynchronous events.
 222  *
 223  *  For datagram (non connection oriented) sockets, GSocket_Connect()
 224  *  just sets the peer address established with GSocket_SetPeer() as
 225  *  default destination.
 226  *
 227  *  Error codes:
 228  *    GSOCK_INVSOCK    - the socket is in use or not valid.
 229  *    GSOCK_INVADDR    - the peer address has not been established.
 230  *    GSOCK_TIMEDOUT   - timeout, the connection failed.
 231  *    GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
 232  *    GSOCK_MEMERR     - couldn't allocate memory.
 233  *    GSOCK_IOERR      - low-level error.
 234  */
 235 GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
 236
 237
 238 /* Datagram sockets */
 239
 240 /* GSocket_SetNonOriented:
 241  *  Sets up this socket as a non-connection oriented (datagram) socket.
 242  *  Before using this function, the local address must have been set
 243  *  with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR
 244  *  on success, or one of the following otherwise.
 245  *
 246  *  Error codes:
 247  *    GSOCK_INVSOCK - the socket is in use.
 248  *    GSOCK_INVADDR - the local address has not been set.
 249  *    GSOCK_IOERR   - low-level error.
 250  */
 251 GSocketError GSocket_SetNonOriented(GSocket *socket);
 252
 253
 254 /* Generic IO */
 255
 256 /* Like recv(), send(), ... */
 257
 258 /* For datagram sockets, the incoming / outgoing addresses
 259  * are stored as / read from the 'peer' address field.
 260  */
 261 int GSocket_Read(GSocket *socket, char *buffer, int size);
 262 int GSocket_Write(GSocket *socket, const char *buffer,
 263                   int size);
 264
 265 /* GSocket_Select:
 266  *  Polls the socket to determine its status. This function will
 267  *  check for the events specified in the 'flags' parameter, and
 268  *  it will return a mask indicating which operations can be
 269  *  performed. This function won't block, regardless of the
 270  *  mode (blocking | nonblocking) of the socket.
 271  */
 272 GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags);
 273
 274
 275 /* Attributes */
 276
 277 /* GSocket_SetNonBlocking:
 278  *  Sets the socket to non-blocking mode. All IO calls will return
 279  *  immediately.
 280  */
 281 void GSocket_SetNonBlocking(GSocket *socket, int non_block);
 282
 283 /* GSocket_SetTimeout:
 284  *  Sets the timeout for blocking calls. Time is expressed in
 285  *  milliseconds.
 286  */
 287 void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
 288
 289 #endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
 290
 291 /* GSocket_GetError:
 292  *  Returns the last error occured for this socket. Note that successful
 293  *  operations do not clear this back to GSOCK_NOERROR, so use it only
 294  *  after an error.
 295  */
 296 GSocketError WXDLLIMPEXP_NET GSocket_GetError(GSocket *socket);
 297
 298 #ifndef wxUSE_GSOCKET_CPLUSPLUS
 299
 300 /* Callbacks */
 301
 302 /* GSOCK_INPUT:
 303  *   There is data to be read in the input buffer. If, after a read
 304  *   operation, there is still data available, the callback function will
 305  *   be called again.
 306  * GSOCK_OUTPUT:
 307  *   The socket is available for writing. That is, the next write call
 308  *   won't block. This event is generated only once, when the connection is
 309  *   first established, and then only if a call failed with GSOCK_WOULDBLOCK,
 310  *   when the output buffer empties again. This means that the app should
 311  *   assume that it can write since the first OUTPUT event, and no more
 312  *   OUTPUT events will be generated unless an error occurs.
 313  * GSOCK_CONNECTION:
 314  *   Connection succesfully established, for client sockets, or incoming
 315  *   client connection, for server sockets. Wait for this event (also watch
 316  *   out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
 317  * GSOCK_LOST:
 318  *   The connection is lost (or a connection request failed); this could
 319  *   be due to a failure, or due to the peer closing it gracefully.
 320  */
 321
 322 /* GSocket_SetCallback:
 323  *  Enables the callbacks specified by 'flags'. Note that 'flags'
 324  *  may be a combination of flags OR'ed toghether, so the same
 325  *  callback function can be made to accept different events.
 326  *  The callback function must have the following prototype:
 327  *
 328  *  void function(GSocket *socket, GSocketEvent event, char *cdata)
 329  */
 330 void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
 331                          GSocketCallback fallback, char *cdata);
 332
 333 /* GSocket_UnsetCallback:
 334  *  Disables all callbacks specified by 'flags', which may be a
 335  *  combination of flags OR'ed toghether.
 336  */
 337 void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags);
 338
 339 #endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
 340
 341
 342 /* GAddress */
 343
 344 GAddress *GAddress_new(void);
 345 GAddress *GAddress_copy(GAddress *address);
 346 void GAddress_destroy(GAddress *address);
 347
 348 void GAddress_SetFamily(GAddress *address, GAddressType type);
 349 GAddressType GAddress_GetFamily(GAddress *address);
 350
 351 /* The use of any of the next functions will set the address family to
 352  * the specific one. For example if you use GAddress_INET_SetHostName,
 353  * address family will be implicitly set to AF_INET.
 354  */
 355
 356 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
 357 GSocketError GAddress_INET_SetAnyAddress(GAddress *address);
 358 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
 359                                           unsigned long hostaddr);
 360 GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
 361                                        const char *protocol);
 362 GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port);
 363
 364 GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname,
 365                                        size_t sbuf);
 366 unsigned long GAddress_INET_GetHostAddress(GAddress *address);
 367 unsigned short GAddress_INET_GetPort(GAddress *address);
 368
 369 /* TODO: Define specific parts (INET6, UNIX) */
 370
 371 GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
 372 GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
 373
 374 #ifdef __cplusplus
 375 }
 376 #endif /* __cplusplus */
 377
 378 #ifdef wxUSE_GSOCKET_CPLUSPLUS
 379 #include "wx/unix/gsockunx.h"
 380 #endif
 381
 382 #endif    /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
 383
 384 #endif    /* __GSOCKET_H */