fixed Cygwin compilation (there's no _get_osfhandle)

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

diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h
index 10eb21f79e7b08a779516523d366498e8f56475c..a527a8586a9a5f4fbcd36e02e4824cd62659cdd8 100644 (file)
--- a/include/wx/gsocket.h
+++ b/include/wx/gsocket.h
@@ -1,40 +1,47 @@
 /* -------------------------------------------------------------------------
  * 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_STANDALONE__
 #include "wx/setup.h"
 #ifndef __GSOCKET_H
 #define __GSOCKET_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 int bool;
-#endif

 
 

-#ifndef TRUE
-#define TRUE 1
+/*
+   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 FALSE
-#define FALSE 0
+#ifdef __WXWINCE__
+#include <stdlib.h>

 #endif
 
 #endif
 

+class GSocket;

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

-typedef struct _GSocket GSocket;

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


@@ -59,9 +66,12 @@ typedef enum {
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_TIMEDOUT,
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_TIMEDOUT,

-  GSOCK_MEMERR
+  GSOCK_MEMERR,
+  GSOCK_OPTERR

 } GSocketError;
 
 } 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,


@@ -83,139 +93,48 @@ typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
                                 char *cdata);
 
 
                                 char *cdata);
 
 

-/* Global initializers */
-
-/* GSocket_Init() must be called at the beginning */
-bool GSocket_Init();
-/* GSocket_Cleanup() must be called at the ending */
-void GSocket_Cleanup();
-
-/* Constructors / Destructors */
-
-GSocket *GSocket_new();
-void GSocket_destroy(GSocket *socket);
-
-/* This will disable all further IO calls to this socket */
-void GSocket_Shutdown(GSocket *socket);
-
-/* Address handling */
-
-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:
- *  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.
- */
-GSocketError GSocket_SetServer(GSocket *socket);
-
-/* GSocket_WaitConnection:
- *  Waits for an incoming client connection.
- */
-GSocket *GSocket_WaitConnection(GSocket *socket);
-
-/* 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.
- */
-GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
+/* Functions tables for internal use by GSocket code: */
+
+/* Actually this is a misnomer now, but reusing this name means I don't
+   have to ifdef app traits or common socket code */
+class GSocketGUIFunctionsTable
+{
+public:
+    virtual bool OnInit() = 0;
+    virtual void OnExit() = 0;
+    virtual bool CanUseEventLoop() = 0;
+    virtual bool Init_Socket(GSocket *socket) = 0;
+    virtual void Destroy_Socket(GSocket *socket) = 0;
+#ifndef __WINDOWS__
+    virtual void Install_Callback(GSocket *socket, GSocketEvent event) = 0;
+    virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) = 0;
+#endif
+    virtual void Enable_Events(GSocket *socket) = 0;
+    virtual void Disable_Events(GSocket *socket) = 0;
+};

 
 

-/* Generic IO */

 
 

-/* Like recv(), send(), ... */
+/* Global initializers */

 
 

-/* NOTE: In case we read from a non-oriented connection, the incoming
- * (outgoing) connection address is stored in the "Local" ("Peer")
- * field.
- */
-int GSocket_Read(GSocket *socket, char *buffer, int size);
-int GSocket_Write(GSocket *socket, const char *buffer,
-                  int size);
-
-/* GSocket_Select:
- *  Polls the socket to determine its status. This function will
- *  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.
- */
-GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags);
+/* Sets GUI functions callbacks. Must be called *before* GSocket_Init
+   if the app uses async sockets. */
+void GSocket_SetGUIFunctions(GSocketGUIFunctionsTable *guifunc);

 
 

-/* Flags/Parameters */
+/* GSocket_Init() must be called at the beginning */
+int GSocket_Init(void);

 
 

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

 
 

-/* GSocket_SetNonBlocking:
- *  Sets the socket to non-blocking mode. This is useful if
- *  we don't want to wait.
- */
-void GSocket_SetNonBlocking(GSocket *socket, bool non_block);

 
 

-/* GSocket_GetError:
- *  Returns the last error occured for this socket.
- */
-GSocketError GSocket_GetError(GSocket *socket);
-
-/* 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()
- */
+/* Constructors / Destructors */

 
 

-/* GSocket_SetCallback:
- *  Enables the callbacks specified by 'flags'. Note that 'flags'
- *  may be a combination of flags OR'ed toghether, so the same
- *  callback function can be made to accept different events.
- *  The callback function must have the following prototype:
- *
- *  void function(GSocket *socket, GSocketEvent event, char *cdata)
- */
-void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
-                         GSocketCallback fallback, char *cdata);
+GSocket *GSocket_new(void);

 
 

-/* GSocket_UnsetCallback:
- *  Disables all callbacks specified by 'flags', which may be a
- *  combination of flags OR'ed toghether.
- */
-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 +147,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,


@@ -245,9 +165,16 @@ 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 */
 

+# if defined(__WINDOWS__)
+#  include "wx/msw/gsockmsw.h"
+# elif defined(__WXMAC__) && !defined(__DARWIN__)
+#  include "wx/mac/gsockmac.h"
+# else
+#  include "wx/unix/gsockunx.h"
+# endif

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