Wrappers for *ToText

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

diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h
index 2e3f86d256205969c5c86fc2cd8f7939ec72b763..857cc04c53afead0486cf1adc919f9094ba71bb7 100644 (file)
--- a/include/wx/gsocket.h
+++ b/include/wx/gsocket.h
@@ -1,7 +1,7 @@
 /* -------------------------------------------------------------------------
  * Project: GSocket (Generic Socket)
  * Name:    gsocket.h
 /* -------------------------------------------------------------------------
  * Project: GSocket (Generic Socket)
  * Name:    gsocket.h

- * Author:  Guilhem Lavaux  
+ * Author:  Guilhem Lavaux

  *          Guillermo Rodriguez Garcia <guille@iies.es> (maintainer)
  * Purpose: GSocket include file (system independent)
  * CVSID:   $Id$
  *          Guillermo Rodriguez Garcia <guille@iies.es> (maintainer)
  * Purpose: GSocket include file (system independent)
  * CVSID:   $Id$


@@ -11,33 +11,50 @@
 #ifndef __GSOCKET_H
 #define __GSOCKET_H
 
 #ifndef __GSOCKET_H
 #define __GSOCKET_H
 

+/* DFE: Define this and compile gsocket.cpp instead of gsocket.c and
+   compile existing GUI gsock*.c as C++ to try out the new GSocket. */
+/* #define wxUSE_GSOCKET_CPLUSPLUS 1 */
+#undef wxUSE_GSOCKET_CPLUSPLUS
+#if !defined(__cplusplus) && defined(wxUSE_GSOCKET_CPLUSPLUS)
+#error "You need to compile this file (probably a GUI gsock peice) as C++"
+#endif
+

 #ifndef __GSOCKET_STANDALONE__
 #include "wx/setup.h"
 #ifndef __GSOCKET_STANDALONE__
 #include "wx/setup.h"

+#include "wx/platform.h"
+
+#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */
+

 #endif
 
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
 
 #include <stddef.h>
 #endif
 
 #if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
 
 #include <stddef.h>

-#include <sys/types.h>

 
 

-#if !defined(__cplusplus)
-typedef unsigned int bool;
+/*
+   Including sys/types.h under cygwin results in the warnings about "fd_set
+   having been defined in sys/types.h" when winsock.h is included later and
+   doesn't seem to be necessary anyhow. It's not needed under Mac neither.
+ */
+#if !defined(__WXMAC__) && !defined(__CYGWIN__) && !defined(__WXWINCE__)
+#include <sys/types.h>

 #endif
 
 #endif
 

-#ifndef TRUE
-#define TRUE 1
+#ifdef __WXWINCE__
+#include <stdlib.h>

 #endif
 
 #endif
 

-#ifndef FALSE
-#define FALSE 0
+#ifdef wxUSE_GSOCKET_CPLUSPLUS
+typedef class GSocketBSD GSocket;

 #endif
 
 #endif
 

-

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

+#ifndef wxUSE_GSOCKET_CPLUSPLUS

 typedef struct _GSocket GSocket;
 typedef struct _GSocket GSocket;

+#endif

 typedef struct _GAddress GAddress;
 
 typedef enum {
 typedef struct _GAddress GAddress;
 
 typedef enum {


@@ -88,10 +105,39 @@ typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
                                 char *cdata);
 
 
                                 char *cdata);
 
 

+/* Functions tables for internal use by GSocket code: */
+
+#ifndef __WINDOWS__
+struct GSocketBaseFunctionsTable
+{
+    void (*Detected_Read)(GSocket *socket);
+    void (*Detected_Write)(GSocket *socket);
+};
+#endif
+
+struct GSocketGUIFunctionsTable
+{
+    int  (*GUI_Init)(void);
+    void (*GUI_Cleanup)(void);
+    int  (*GUI_Init_Socket)(GSocket *socket);
+    void (*GUI_Destroy_Socket)(GSocket *socket);
+#ifndef __WINDOWS__
+    void (*Install_Callback)(GSocket *socket, GSocketEvent event);
+    void (*Uninstall_Callback)(GSocket *socket, GSocketEvent event);
+#endif
+    void (*Enable_Events)(GSocket *socket);
+    void (*Disable_Events)(GSocket *socket);
+};
+
+

 /* Global initializers */
 
 /* Global initializers */
 

+/* Sets GUI functions callbacks. Must be called *before* GSocket_Init
+   if the app uses async sockets. */
+void GSocket_SetGUIFunctions(struct GSocketGUIFunctionsTable *guifunc);
+

 /* GSocket_Init() must be called at the beginning */
 /* GSocket_Init() must be called at the beginning */

-bool GSocket_Init(void);
+int GSocket_Init(void);

 
 /* GSocket_Cleanup() must be called at the end */
 void GSocket_Cleanup(void);
 
 /* GSocket_Cleanup() must be called at the end */
 void GSocket_Cleanup(void);


@@ -103,6 +149,7 @@ GSocket *GSocket_new(void);
 void GSocket_destroy(GSocket *socket);
 
 
 void GSocket_destroy(GSocket *socket);
 
 

+#ifndef wxUSE_GSOCKET_CPLUSPLUS

 
 /* GSocket_Shutdown:
  *  Disallow further read/write operations on this socket, close
 
 /* GSocket_Shutdown:
  *  Disallow further read/write operations on this socket, close


@@ -137,11 +184,11 @@ GAddress *GSocket_GetPeer(GSocket *socket);
  *  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:
  *  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.
  *  Error codes:
  *    GSOCK_INVSOCK - the socket is in use.
  *    GSOCK_INVADDR - the local address has not been set.

- *    GSOCK_IOERR   - low-level error. 
+ *    GSOCK_IOERR   - low-level error.

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


@@ -155,7 +202,7 @@ GSocketError GSocket_SetServer(GSocket *socket);
  *    GSOCK_TIMEDOUT   - timeout, no incoming connections.
  *    GSOCK_WOULDBLOCK - the call would block and the socket is nonblocking.
  *    GSOCK_MEMERR     - couldn't allocate memory.
  *    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. 
+ *    GSOCK_IOERR      - low-level error.

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


@@ -183,7 +230,7 @@ GSocket *GSocket_WaitConnection(GSocket *socket);
  *    GSOCK_TIMEDOUT   - timeout, the connection failed.
  *    GSOCK_WOULDBLOCK - connection in progress (nonblocking sockets only)
  *    GSOCK_MEMERR     - couldn't allocate memory.
  *    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. 
+ *    GSOCK_IOERR      - low-level error.

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


@@ -199,7 +246,7 @@ GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
  *  Error codes:
  *    GSOCK_INVSOCK - the socket is in use.
  *    GSOCK_INVADDR - the local address has not been set.
  *  Error codes:
  *    GSOCK_INVSOCK - the socket is in use.
  *    GSOCK_INVADDR - the local address has not been set.

- *    GSOCK_IOERR   - low-level error. 
+ *    GSOCK_IOERR   - low-level error.

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


@@ -231,7 +278,7 @@ GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags);
  *  Sets the socket to non-blocking mode. All IO calls will return
  *  immediately.
  */
  *  Sets the socket to non-blocking mode. All IO calls will return
  *  immediately.
  */

-void GSocket_SetNonBlocking(GSocket *socket, bool non_block);
+void GSocket_SetNonBlocking(GSocket *socket, int non_block);

 
 /* GSocket_SetTimeout:
  *  Sets the timeout for blocking calls. Time is expressed in
 
 /* GSocket_SetTimeout:
  *  Sets the timeout for blocking calls. Time is expressed in


@@ -239,13 +286,16 @@ void GSocket_SetNonBlocking(GSocket *socket, bool non_block);
  */
 void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
 
  */
 void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
 

+#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
+

 /* GSocket_GetError:
  *  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.
  */
 /* GSocket_GetError:
  *  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 WXDLLIMPEXP_NET GSocket_GetError(GSocket *socket);

 
 

+#ifndef wxUSE_GSOCKET_CPLUSPLUS

 
 /* Callbacks */
 
 
 /* Callbacks */
 


@@ -254,7 +304,7 @@ GSocketError GSocket_GetError(GSocket *socket);
  *   operation, there is still data available, the callback function will
  *   be called again.
  * GSOCK_OUTPUT:
  *   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 
+ *   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
  *   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


@@ -286,6 +336,8 @@ void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
  */
 void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags);
 
  */
 void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags);
 

+#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
+

 
 /* GAddress */
 
 
 /* GAddress */
 


@@ -320,9 +372,12 @@ GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
 GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
 
 #ifdef __cplusplus
 GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
 
 #ifdef __cplusplus

-};
+}

 #endif /* __cplusplus */
 
 #endif /* __cplusplus */
 

+#ifdef wxUSE_GSOCKET_CPLUSPLUS
+#include "wx/unix/gsockunx.h"
+#endif

 
 #endif    /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
 
 
 #endif    /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */