Minor corrections to make dist after reports

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

diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h
index 938b6f0b77794b3fd127b0a1e8e645d07a22d11e..1de34db8fb130c447291e47acf6bc16041d967de 100644 (file)
--- a/include/wx/gsocket.h
+++ b/include/wx/gsocket.h
@@ -1,48 +1,58 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * Project: GSocket (Generic Socket)
- * Name:    gsocket.h
- * Purpose: GSocket include file (system independent)
- * CVSID:   $Id$
+ * Project:     GSocket (Generic Socket)
+ * Name:        gsocket.h
+ * Author:      Guilhem Lavaux
+ *              Guillermo Rodriguez Garcia <guille@iies.es>
+ * Copyright:   (c) Guilhem Lavaux
+ *              (c) 2007 Vadim Zeitlin <vadim@wxwidgets.org>
+ * Licence:     wxWindows Licence
+ * Purpose:     GSocket include file (system independent)
+ * CVSID:       $Id$

  * -------------------------------------------------------------------------
  */
  * -------------------------------------------------------------------------
  */

-#ifndef __GSOCKET_H
-#define __GSOCKET_H

 
 

-#include "wx/setup.h"
+#ifndef _WX_GSOCKET_H_
+#define _WX_GSOCKET_H_
+
+#include "wx/defs.h"

 
 #if wxUSE_SOCKETS
 
 
 #if wxUSE_SOCKETS
 

-#include <stddef.h>
-#include <sys/types.h>
+#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */

 
 

-#if !defined(__cplusplus)
-typedef int bool;
-#endif
+#include <stddef.h>

 
 

-#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
 

-typedef struct _GSocket GSocket;

 typedef struct _GAddress GAddress;
 
 typedef struct _GAddress GAddress;
 

-typedef enum {
+enum GAddressType
+{

   GSOCK_NOFAMILY = 0,
   GSOCK_INET,
   GSOCK_INET6,
   GSOCK_UNIX
   GSOCK_NOFAMILY = 0,
   GSOCK_INET,
   GSOCK_INET6,
   GSOCK_UNIX

-} GAddressType;
+};

 
 

-typedef enum {
+enum GSocketStream
+{

   GSOCK_STREAMED,
   GSOCK_UNSTREAMED
   GSOCK_STREAMED,
   GSOCK_UNSTREAMED

-} GSocketStream;
+};

 
 

-typedef enum {
+enum GSocketError
+{

   GSOCK_NOERROR = 0,
   GSOCK_INVOP,
   GSOCK_IOERR,
   GSOCK_NOERROR = 0,
   GSOCK_INVOP,
   GSOCK_IOERR,


@@ -51,19 +61,24 @@ typedef enum {
   GSOCK_NOHOST,
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_NOHOST,
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,

-  GSOCK_TIMEOUT,
-  GSOCK_MEMERR
-} GSocketError;
+  GSOCK_TIMEDOUT,
+  GSOCK_MEMERR,
+  GSOCK_OPTERR
+};

 
 

-typedef enum {
+/* See below for an explanation on how events work.
+ */
+enum GSocketEvent
+{

   GSOCK_INPUT  = 0,
   GSOCK_OUTPUT = 1,
   GSOCK_CONNECTION = 2,
   GSOCK_LOST = 3,
   GSOCK_MAX_EVENT = 4
   GSOCK_INPUT  = 0,
   GSOCK_OUTPUT = 1,
   GSOCK_CONNECTION = 2,
   GSOCK_LOST = 3,
   GSOCK_MAX_EVENT = 4

-} GSocketEvent;
+};

 
 

-enum {
+enum
+{

   GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT,
   GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT,
   GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION,
   GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT,
   GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT,
   GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION,


@@ -72,123 +87,95 @@ enum {
 
 typedef int GSocketEventFlags;
 
 
 typedef int GSocketEventFlags;
 

+class GSocket;
+

 typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
                                 char *cdata);
 
 typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
                                 char *cdata);
 

-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* Global initialisers */
-
-/* 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 IO calls to this socket but errors are still available */
-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() setups the socket as a server. It uses the "Local" field
-  of GSocket. "Local" must be set by GSocket_SetLocal() before
-  GSocket_SetServer() is called. In the other case, it returns GSOCK_INVADDR.
-*/
-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. In the other case, it returns GSOCK_INVADDR.
-*/
-GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
-
-/* Generic IO */
+   Class providing hooks abstracting the differences between console and GUI
+   applications for socket code.
+
+   We also have different implementations of this class for different platforms
+   allowing us to keep more things in the common code but the main reason for
+   its existence is that we want the same socket code work differently
+   depending on whether it's used from a console or a GUI program. This is
+   achieved by implementing the virtual methods of this class differently in
+   the objects returned by wxConsoleAppTraits::GetSocketFunctionsTable() and
+   the same method in wxGUIAppTraits.
+ */
+class GSocketManager
+{
+public:
+    // set the manager to use, we don't take ownership of it
+    //
+    // this should be called before GSocket_Init(), i.e. before the first
+    // wxSocket object is created, otherwise the manager returned by
+    // wxAppTraits::GetSocketManager() will be used
+    static void Set(GSocketManager *manager);
+
+    // return the manager to use
+    //
+    // this initializes the manager at first use
+    static GSocketManager *Get()
+    {
+        if ( !ms_manager )
+            Init();
+
+        return ms_manager;
+    }
+
+    // called before the first wxSocket is created and should do the
+    // initializations needed in order to use the network
+    //
+    // return true if initialized successfully
+    virtual bool OnInit() = 0;
+
+    // undo the initializations of OnInit()
+    virtual void OnExit() = 0;
+
+
+    // do manager-specific socket initializations (and undo it): this is called
+    // in the beginning/end of the socket initialization/destruction
+    virtual bool Init_Socket(GSocket *socket) = 0;
+    virtual void Destroy_Socket(GSocket *socket) = 0;
+
+    virtual void Install_Callback(GSocket *socket, GSocketEvent event) = 0;
+    virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) = 0;
+
+    virtual void Enable_Events(GSocket *socket) = 0;
+    virtual void Disable_Events(GSocket *socket) = 0;
+
+    virtual ~GSocketManager() { }
+
+private:
+    // get the manager to use if we don't have it yet
+    static void Init();
+
+    static GSocketManager *ms_manager;
+};

 
 

-/* 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.
-*/
-int GSocket_Read(GSocket *socket, char *buffer, int size);
-int GSocket_Write(GSocket *socket, const char *buffer,
-                  int size);
-bool GSocket_DataAvailable(GSocket *socket);
+#if defined(__WINDOWS__)
+    #include "wx/msw/gsockmsw.h"
+#else
+    #include "wx/unix/gsockunx.h"
+#endif

 
 

-/* Flags/Parameters */

 
 

-/*
-  GSocket_SetTimeout() sets the timeout for reading and writing IO call. Time
-  is expressed in milliseconds.
- */
-void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
+/* Global initializers */

 
 

-/*
-  GSocket_SetBlocking() puts the socket in non-blocking mode. This is useful
-  if we don't want to wait.
-*/
-void GSocket_SetNonBlocking(GSocket *socket, bool non_block);
+/* GSocket_Init() must be called at the beginning (but after calling
+ * GSocketManager::Set() if a custom manager should be used) */
+bool GSocket_Init();

 
 

-/*
-  GSocket_GetError() returns the last error occured on the socket stream.
-*/
+/* GSocket_Cleanup() must be called at the end */
+void GSocket_Cleanup();

 
 

-GSocketError GSocket_GetError(GSocket *socket);

 
 

-/* Callbacks */
+/* Constructors / Destructors */

 
 

-/*
-   Only one fallback is possible for each event (INPUT, OUTPUT, CONNECTION, LOST)
-   INPUT: The function is called when there is at least a byte in the
-          input buffer
-   OUTPUT: The function is called when the system is sure the next write call
-           will not block
-   CONNECTION: Two cases is possible:
-             Client socket -> the connection is established
-             Server socket -> a client request a connection
-   LOST: the connection is lost
-
-   SetCallback accepts a combination of these flags so a same callback can
-   receive different events.
-
-   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()
-*/
-void GSocket_SetCallback(GSocket *socket, GSocketEventFlags event,
-                         GSocketCallback fallback, char *cdata);
+GSocket *GSocket_new();

 
 

-/*
-  UnsetCallback will disables all fallbacks specified by "event".
-  NOTE: event may be a combination of flags
-*/
-void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags event);

 
 /* GAddress */
 
 
 /* GAddress */
 


@@ -199,13 +186,14 @@ void GAddress_destroy(GAddress *address);
 void GAddress_SetFamily(GAddress *address, GAddressType type);
 GAddressType GAddress_GetFamily(GAddress *address);
 
 void GAddress_SetFamily(GAddress *address, GAddressType type);
 GAddressType GAddress_GetFamily(GAddress *address);
 

-/*
-   The use of any of the next functions will set the address family to the adapted
-   one. For example if you use GAddress_INET_SetHostName, address family will be AF_INET
-   implicitely
-*/
+/* The use of any of the next functions will set the address family to
+ * the specific one. For example if you use GAddress_INET_SetHostName,
+ * address family will be implicitly set to AF_INET.
+ */

 
 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
 
 GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);

+GSocketError GAddress_INET_SetBroadcastAddress(GAddress *address);
+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,


@@ -217,28 +205,28 @@ GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname,
 unsigned long GAddress_INET_GetHostAddress(GAddress *address);
 unsigned short GAddress_INET_GetPort(GAddress *address);
 
 unsigned long GAddress_INET_GetHostAddress(GAddress *address);
 unsigned short GAddress_INET_GetPort(GAddress *address);
 

-/* TODO: Define specific parts (INET6, UNIX) */
+#if wxUSE_IPV6

 
 

-GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
-GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
-
-/*
- * System specific functions
- */
+GSocketError GAddress_INET6_SetHostName(GAddress *address, const char *hostname);
+GSocketError GAddress_INET6_SetAnyAddress(GAddress *address);
+GSocketError GAddress_INET6_SetHostAddress(GAddress *address,
+                                          struct in6_addr hostaddr);
+GSocketError GAddress_INET6_SetPortName(GAddress *address, const char *port,
+                                       const char *protocol);
+GSocketError GAddress_INET6_SetPort(GAddress *address, unsigned short port);

 
 

-/* On systems needing an event id */
-void GSocket_SetEventID(GSocket *socket, unsigned long evt_id);
+GSocketError GAddress_INET6_GetHostName(GAddress *address, char *hostname,
+                                       size_t sbuf);
+GSocketError GAddress_INET6_GetHostAddress(GAddress *address,struct in6_addr *hostaddr);
+unsigned short GAddress_INET6_GetPort(GAddress *address);

 
 

-/* On systems which don't have background refresh */
-void GSocket_DoEvent(unsigned long evt_id);
+#endif // wxUSE_IPV6

 
 

-#ifdef __cplusplus
-};
-#endif /* __cplusplus */
+/* TODO: Define specific parts (UNIX) */

 
 

+GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
+GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);

 
 

-#endif
-    /* wxUSE_SOCKETS */
+#endif /* wxUSE_SOCKETS */

 
 

-#endif
-    /* __GSOCKET_H */
+#endif /* _WX_GSOCKET_H_ */