removing double includes

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

diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h
index 6070b76de8d377c4060d16dbffea2a9bb6d985a4..1de34db8fb130c447291e47acf6bc16041d967de 100644 (file)
--- a/include/wx/gsocket.h
+++ b/include/wx/gsocket.h
@@ -1,24 +1,24 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * 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$
+ * 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
+#ifndef _WX_GSOCKET_H_
+#define _WX_GSOCKET_H_

 
 

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

 
 

-#include "wx/dlimpexp.h" // for WXDLLIMPEXP_NET
+#if wxUSE_SOCKETS

 
 

-#endif
-
-#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
+#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */

 
 #include <stddef.h>
 
 
 #include <stddef.h>
 


@@ -35,26 +35,24 @@
 #include <stdlib.h>
 #endif
 
 #include <stdlib.h>
 #endif
 

-#ifdef __cplusplus
-extern "C" {
-#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,


@@ -64,20 +62,23 @@ typedef enum {
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_TIMEDOUT,
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_TIMEDOUT,

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

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

-typedef enum {
+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,


@@ -86,241 +87,99 @@ 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);
 

-
-/* Functions tables for internal use by GSocket code: */
-
-#ifndef __WINDOWS__
-struct GSocketBaseFunctionsTable
+/*
+   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

 {
 {

-    void (*Detected_Read)(GSocket *socket);
-    void (*Detected_Write)(GSocket *socket);
-};
-#endif
+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);

 
 

-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);
-};
+    // return the manager to use
+    //
+    // this initializes the manager at first use
+    static GSocketManager *Get()
+    {
+        if ( !ms_manager )
+            Init();

 
 

+        return ms_manager;
+    }

 
 

-/* Global initializers */
+    // 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;

 
 

-/* Sets GUI functions callbacks. Must be called *before* GSocket_Init
-   if the app uses async sockets. */
-void GSocket_SetGUIFunctions(struct GSocketGUIFunctionsTable *guifunc);
+    // undo the initializations of OnInit()
+    virtual void OnExit() = 0;

 
 

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

 
 

+    // 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;

 
 

-/* Constructors / Destructors */
+    virtual void Install_Callback(GSocket *socket, GSocketEvent event) = 0;
+    virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) = 0;

 
 

-GSocket *GSocket_new(void);
-void GSocket_destroy(GSocket *socket);
+    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();

 
 

-/* GSocket_Shutdown:
- *  Disallow further read/write operations on this socket, close
- *  the fd and disable all callbacks.
- */
-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);
-
-/* Server specific parts */
-
-/* GSocket_SetServer:
- *  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:
- *  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);
-
-
-/* Client specific parts */
-
-/* GSocket_Connect:
- *  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);
-
-
-/* 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(), ... */
+    static GSocketManager *ms_manager;
+};

 
 

-/* 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 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);
+#if defined(__WINDOWS__)
+    #include "wx/msw/gsockmsw.h"
+#else
+    #include "wx/unix/gsockunx.h"
+#endif

 
 
 
 

-/* Attributes */
+/* Global initializers */

 
 

-/* GSocket_SetNonBlocking:
- *  Sets the socket to non-blocking mode. All IO calls will return
- *  immediately.
- */
-void GSocket_SetNonBlocking(GSocket *socket, int 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_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();

 
 

-/* 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 WXDLLIMPEXP_NET GSocket_GetError(GSocket *socket);
-
-
-/* Callbacks */
-
-/* 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:
- *  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);
+/* Constructors / Destructors */

 
 

-/* 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);
+GSocket *GSocket_new();

 
 
 /* GAddress */
 
 
 
 /* GAddress */
 

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

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


@@ -333,6 +192,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_SetBroadcastAddress(GAddress *address);

 GSocketError GAddress_INET_SetAnyAddress(GAddress *address);
 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
                                           unsigned long hostaddr);
 GSocketError GAddress_INET_SetAnyAddress(GAddress *address);
 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
                                           unsigned long hostaddr);


@@ -345,16 +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);
+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);
+
+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);

 
 

-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+#endif // wxUSE_IPV6

 
 

+/* 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 || defined(__GSOCKET_STANDALONE__) */
+#endif /* wxUSE_SOCKETS */

 
 

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