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