Trying to hide evidence of my negative programming skills...

[wxWidgets.git] / include / wx / gsocket.h

diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h
index e5a9070209c0f5b106f299c6a5fae3445ea3dc63..5f6924aed3f7d0a70cea3e123f637e8fb2e7f94c 100644 (file)
--- a/include/wx/gsocket.h
+++ b/include/wx/gsocket.h
@@ -1,10 +1,13 @@
 /* -------------------------------------------------------------------------
  * Project: GSocket (Generic Socket)
  * Name:    gsocket.h
 /* -------------------------------------------------------------------------
  * Project: GSocket (Generic Socket)
  * Name:    gsocket.h

+ * Author:  Guilhem Lavaux
+ *          Guillermo Rodriguez Garcia <guille@iies.es> (maintainer)

  * Purpose: GSocket include file (system independent)
  * CVSID:   $Id$
  * -------------------------------------------------------------------------
  */
  * Purpose: GSocket include file (system independent)
  * CVSID:   $Id$
  * -------------------------------------------------------------------------
  */

+

 #ifndef __GSOCKET_H
 #define __GSOCKET_H
 
 #ifndef __GSOCKET_H
 #define __GSOCKET_H
 


@@ -15,21 +18,10 @@
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
 
 #include <stddef.h>
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
 
 #include <stddef.h>

+#ifndef __WXMAC__

 #include <sys/types.h>
 #include <sys/types.h>

-
-#if !defined(__cplusplus)
-typedef unsigned int bool;
-#endif
-
-#ifndef TRUE
-#define TRUE 1
-#endif
-
-#ifndef FALSE
-#define FALSE 0

 #endif
 
 #endif
 

-

 #ifdef __cplusplus
 extern "C" {
 #endif
 #ifdef __cplusplus
 extern "C" {
 #endif


@@ -62,6 +54,8 @@ typedef enum {
   GSOCK_MEMERR
 } GSocketError;
 
   GSOCK_MEMERR
 } GSocketError;
 

+/* See below for an explanation on how events work.
+ */

 typedef enum {
   GSOCK_INPUT  = 0,
   GSOCK_OUTPUT = 1,
 typedef enum {
   GSOCK_INPUT  = 0,
   GSOCK_OUTPUT = 1,


@@ -86,65 +80,125 @@ typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
 /* Global initializers */
 
 /* GSocket_Init() must be called at the beginning */
 /* Global initializers */
 
 /* GSocket_Init() must be called at the beginning */

-bool GSocket_Init();
-/* GSocket_Cleanup() must be called at the ending */
-void GSocket_Cleanup();
+int GSocket_Init(void);
+
+/* GSocket_Cleanup() must be called at the end */
+void GSocket_Cleanup(void);
+

 
 /* Constructors / Destructors */
 
 
 /* Constructors / Destructors */
 

-GSocket *GSocket_new();
+GSocket *GSocket_new(void);

 void GSocket_destroy(GSocket *socket);
 
 void GSocket_destroy(GSocket *socket);
 

-/* This will disable all further IO calls to this socket */
+
+
+/* GSocket_Shutdown:
+ *  Disallow further read/write operations on this socket, close
+ *  the fd and disable all callbacks.
+ */

 void GSocket_Shutdown(GSocket *socket);
 
 /* Address handling */
 
 void GSocket_Shutdown(GSocket *socket);
 
 /* Address handling */
 

+/* GSocket_SetLocal:
+ * GSocket_GetLocal:
+ * GSocket_SetPeer:
+ * GSocket_GetPeer:
+ *  Set or get the local or peer address for this socket. The 'set'
+ *  functions return GSOCK_NOERROR on success, an error code otherwise.
+ *  The 'get' functions return a pointer to a GAddress object on success,
+ *  or NULL otherwise, in which case they set the error code of the
+ *  corresponding GSocket.
+ *
+ *  Error codes:
+ *    GSOCK_INVSOCK - the socket is not valid.
+ *    GSOCK_INVADDR - the address is not valid.
+ */

 GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address);
 GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address);
 GAddress *GSocket_GetLocal(GSocket *socket);
 GAddress *GSocket_GetPeer(GSocket *socket);
 
 GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address);
 GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address);
 GAddress *GSocket_GetLocal(GSocket *socket);
 GAddress *GSocket_GetPeer(GSocket *socket);
 

-/* Non-oriented connections handlers */
-
-GSocketError GSocket_SetNonOriented(GSocket *socket);
-

 /* Server specific parts */
 
 /* GSocket_SetServer:
 /* Server specific parts */
 
 /* GSocket_SetServer:

- *  Sets up the socket as a server. It uses the "Local" field of GSocket.
- *  "Local" must be set by GSocket_SetLocal() before GSocket_SetServer()
- *  is called. Possible error codes are: GSOCK_INVSOCK if socket has not
- *  been initialized, GSOCK_INVADDR if the local address has not been
- *  defined and GSOCK_IOERR for other internal errors.
+ *  Sets up this socket as a server. The local address must have been
+ *  set with GSocket_SetLocal() before GSocket_SetServer() is called.
+ *  Returns GSOCK_NOERROR on success, one of the following otherwise:
+ *
+ *  Error codes:
+ *    GSOCK_INVSOCK - the socket is in use.
+ *    GSOCK_INVADDR - the local address has not been set.
+ *    GSOCK_IOERR   - low-level error.

  */
 GSocketError GSocket_SetServer(GSocket *socket);
 
 /* GSocket_WaitConnection:
  */
 GSocketError GSocket_SetServer(GSocket *socket);
 
 /* GSocket_WaitConnection:

- *  Waits for an incoming client connection.
+ *  Waits for an incoming client connection. Returns a pointer to
+ *  a GSocket object, or NULL if there was an error, in which case
+ *  the last error field will be updated for the calling GSocket.
+ *
+ *  Error codes (set in the calling GSocket)
+ *    GSOCK_INVSOCK    - the socket is not valid or not a server.
+ *    GSOCK_TIMEDOUT   - timeout, no incoming connections.
+ *    GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
+ *    GSOCK_MEMERR     - couldn't allocate memory.
+ *    GSOCK_IOERR      - low-level error.

  */
 GSocket *GSocket_WaitConnection(GSocket *socket);
 
  */
 GSocket *GSocket_WaitConnection(GSocket *socket);
 

+

 /* Client specific parts */
 
 /* GSocket_Connect:
 /* Client specific parts */
 
 /* GSocket_Connect:

- *  Establishes a client connection to a server using the "Peer"
- *  field of GSocket. "Peer" must be set by GSocket_SetPeer() before
- *  GSocket_Connect() is called. Possible error codes are GSOCK_INVSOCK,
- *  GSOCK_INVADDR, GSOCK_TIMEDOUT, GSOCK_WOULDBLOCK and GSOCK_IOERR.
- *  If a socket is nonblocking and Connect() returns GSOCK_WOULDBLOCK,
- *  the connection request can be completed later. Use GSocket_Select()
- *  to check it, or wait for a GSOCK_CONNECTION event.
+ *  For stream (connection oriented) sockets, GSocket_Connect() tries
+ *  to establish a client connection to a server using the peer address
+ *  as established with GSocket_SetPeer(). Returns GSOCK_NOERROR if the
+ *  connection has been succesfully established, or one of the error
+ *  codes listed below. Note that for nonblocking sockets, a return
+ *  value of GSOCK_WOULDBLOCK doesn't mean a failure. The connection
+ *  request can be completed later; you should use GSocket_Select()
+ *  to poll for GSOCK_CONNECTION | GSOCK_LOST, or wait for the
+ *  corresponding asynchronous events.
+ *
+ *  For datagram (non connection oriented) sockets, GSocket_Connect()
+ *  just sets the peer address established with GSocket_SetPeer() as
+ *  default destination.
+ *
+ *  Error codes:
+ *    GSOCK_INVSOCK    - the socket is in use or not valid.
+ *    GSOCK_INVADDR    - the peer address has not been established.
+ *    GSOCK_TIMEDOUT   - timeout, the connection failed.
+ *    GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
+ *    GSOCK_MEMERR     - couldn't allocate memory.
+ *    GSOCK_IOERR      - low-level error.

  */
 GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
 
  */
 GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
 

+
+/* Datagram sockets */
+
+/* GSocket_SetNonOriented:
+ *  Sets up this socket as a non-connection oriented (datagram) socket.
+ *  Before using this function, the local address must have been set
+ *  with GSocket_SetLocal(), or the call will fail. Returns GSOCK_NOERROR
+ *  on success, or one of the following otherwise.
+ *
+ *  Error codes:
+ *    GSOCK_INVSOCK - the socket is in use.
+ *    GSOCK_INVADDR - the local address has not been set.
+ *    GSOCK_IOERR   - low-level error.
+ */
+GSocketError GSocket_SetNonOriented(GSocket *socket);
+
+

 /* Generic IO */
 
 /* Like recv(), send(), ... */
 
 /* Generic IO */
 
 /* Like recv(), send(), ... */
 

-/* NOTE: In case we read from a non-oriented connection, the incoming
- * (outgoing) connection address is stored in the "Local" ("Peer")
- * field.
+/* For datagram sockets, the incoming / outgoing addresses
+ * are stored as / read from the 'peer' address field.

  */
 int GSocket_Read(GSocket *socket, char *buffer, int size);
 int GSocket_Write(GSocket *socket, const char *buffer,
  */
 int GSocket_Read(GSocket *socket, char *buffer, int size);
 int GSocket_Write(GSocket *socket, const char *buffer,


@@ -155,45 +209,53 @@ int GSocket_Write(GSocket *socket, const char *buffer,
  *  check for the events specified in the 'flags' parameter, and
  *  it will return a mask indicating which operations can be
  *  performed. This function won't block, regardless of the
  *  check for the events specified in the 'flags' parameter, and
  *  it will return a mask indicating which operations can be
  *  performed. This function won't block, regardless of the

- *  mode (blocking|nonblocking) of the socket.
+ *  mode (blocking | nonblocking) of the socket.

  */
 GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags);
 
  */
 GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags);
 

-/* Flags/Parameters */

 
 

-/* GSocket_SetTimeout:
- *  Sets the timeout for blocking calls. Time is
- *  expressed in milliseconds.
- */
-void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
+/* Attributes */

 
 /* GSocket_SetNonBlocking:
 
 /* GSocket_SetNonBlocking:

- *  Sets the socket to non-blocking mode. This is useful if
- *  we don't want to wait.
+ *  Sets the socket to non-blocking mode. All IO calls will return
+ *  immediately.
+ */
+void GSocket_SetNonBlocking(GSocket *socket, int non_block);
+
+/* GSocket_SetTimeout:
+ *  Sets the timeout for blocking calls. Time is expressed in
+ *  milliseconds.

  */
  */

-void GSocket_SetNonBlocking(GSocket *socket, bool non_block);
+void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);

 
 /* GSocket_GetError:
 
 /* GSocket_GetError:

- *  Returns the last error occured for this socket.
+ *  Returns the last error occured for this socket. Note that successful
+ *  operations do not clear this back to GSOCK_NOERROR, so use it only
+ *  after an error.

  */
 GSocketError GSocket_GetError(GSocket *socket);
 
  */
 GSocketError GSocket_GetError(GSocket *socket);
 

+

 /* Callbacks */
 
 /* Callbacks */
 

-/* Only one callback is possible for each event (INPUT, OUTPUT, CONNECTION
- * and LOST). The callbacks are called in the following situations:
- *
- * INPUT: There is at least one byte in the input buffer
- * OUTPUT: The system is sure that the next write call will not block
- * CONNECTION: Two cases are possible:
- *           Client socket -> the connection is established
- *           Server socket -> a client requests a connection
- * LOST: The connection is lost
- *
- * An event is generated only once and its state is reseted when the
- * relative IO call is requested.
- * For example: INPUT -> GSocket_Read()
- *              CONNECTION -> GSocket_Accept()
+/* GSOCK_INPUT:
+ *   There is data to be read in the input buffer. If, after a read
+ *   operation, there is still data available, the callback function will
+ *   be called again.
+ * GSOCK_OUTPUT:
+ *   The socket is available for writing. That is, the next write call
+ *   won't block. This event is generated only once, when the connection is
+ *   first established, and then only if a call failed with GSOCK_WOULDBLOCK,
+ *   when the output buffer empties again. This means that the app should
+ *   assume that it can write since the first OUTPUT event, and no more
+ *   OUTPUT events will be generated unless an error occurs.
+ * GSOCK_CONNECTION:
+ *   Connection succesfully established, for client sockets, or incoming
+ *   client connection, for server sockets. Wait for this event (also watch
+ *   out for GSOCK_LOST) after you issue a nonblocking GSocket_Connect() call.
+ * GSOCK_LOST:
+ *   The connection is lost (or a connection request failed); this could
+ *   be due to a failure, or due to the peer closing it gracefully.

  */
 
 /* GSocket_SetCallback:
  */
 
 /* GSocket_SetCallback:


@@ -213,9 +275,10 @@ void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
  */
 void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags);
 
  */
 void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags);
 

+

 /* GAddress */
 
 /* GAddress */
 

-GAddress *GAddress_new();
+GAddress *GAddress_new(void);

 GAddress *GAddress_copy(GAddress *address);
 void GAddress_destroy(GAddress *address);
 
 GAddress *GAddress_copy(GAddress *address);
 void GAddress_destroy(GAddress *address);
 


@@ -228,6 +291,7 @@ GAddressType GAddress_GetFamily(GAddress *address);
  */
 
 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
  */
 
 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);

+GSocketError GAddress_INET_SetAnyAddress(GAddress *address);

 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
                                           unsigned long hostaddr);
 GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
                                           unsigned long hostaddr);
 GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,