Move body of SetFocusOnCanvas to .cpp file

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

diff --git a/include/wx/gsocket.h b/include/wx/gsocket.h
index e5a9070209c0f5b106f299c6a5fae3445ea3dc63..a97ef104398bfc1a8eff171621dc892c53b9f33d 100644 (file)
--- a/include/wx/gsocket.h
+++ b/include/wx/gsocket.h
@@ -1,55 +1,56 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * 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,2008 Vadim Zeitlin <vadim@wxwidgets.org>
+ * Licence:     wxWindows Licence
+ * Purpose:     GSocket include file (system independent)
+ * CVSID:       $Id$

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

-#ifndef __GSOCKET_H
-#define __GSOCKET_H

 
 

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

 
 

-#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
+#include "wx/defs.h"

 
 

-#include <stddef.h>
-#include <sys/types.h>
+#if wxUSE_SOCKETS

 
 

-#if !defined(__cplusplus)
-typedef unsigned int bool;
-#endif
+#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */

 
 

-#ifndef TRUE
-#define TRUE 1
-#endif
+#include <stddef.h>

 
 

-#ifndef FALSE
-#define FALSE 0
+/*
+   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
 

-
-#ifdef __cplusplus
-extern "C" {
+#ifdef __WXWINCE__
+#include <stdlib.h>

 #endif
 
 #endif
 

-typedef struct _GSocket GSocket;
-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,


@@ -59,18 +60,23 @@ typedef enum {
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_TIMEDOUT,
   GSOCK_INVPORT,
   GSOCK_WOULDBLOCK,
   GSOCK_TIMEDOUT,

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


@@ -79,141 +85,111 @@ enum {
 
 typedef int GSocketEventFlags;
 
 
 typedef int GSocketEventFlags;
 

+struct GAddress;
+class GSocket;
+

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

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

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

-/* GSocket_Init() must be called at the beginning */
+/* GSocket_Init() must be called at the beginning (but after calling
+ * GSocketManager::Set() if a custom manager should be used) */

 bool GSocket_Init();
 bool GSocket_Init();

-/* GSocket_Cleanup() must be called at the ending */
+
+/* GSocket_Cleanup() must be called at the end */

 void GSocket_Cleanup();
 
 void GSocket_Cleanup();
 

+

 /* Constructors / Destructors */
 
 GSocket *GSocket_new();
 /* 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);
-
-/* 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.
- */
-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);
-
-/* Flags/Parameters */
-
-/* GSocket_SetTimeout:
- *  Sets the timeout for blocking calls. Time is
- *  expressed in milliseconds.
- */
-void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
-
-/* 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()
- */
+/* GAddress */

 
 

-/* 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);
+// Represents a socket endpoint, i.e. -- in spite of its name -- not an address
+// but an (address, port) pair
+struct GAddress
+{
+    struct sockaddr *m_addr;
+    size_t m_len;

 
 

-/* 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);
+    GAddressType m_family;
+    int m_realfamily;

 
 

-/* GAddress */
+    GSocketError m_error;
+};

 
 GAddress *GAddress_new();
 GAddress *GAddress_copy(GAddress *address);
 
 GAddress *GAddress_new();
 GAddress *GAddress_copy(GAddress *address);


@@ -228,6 +204,8 @@ 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_SetPortName(GAddress *address, const char *port,
 GSocketError GAddress_INET_SetHostAddress(GAddress *address,
                                           unsigned long hostaddr);
 GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,


@@ -239,16 +217,35 @@ 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) */
+GSocketError _GAddress_translate_from(GAddress *address,
+                                      struct sockaddr *addr, int len);
+GSocketError _GAddress_translate_to  (GAddress *address,
+                                      struct sockaddr **addr, int *len);
+GSocketError _GAddress_Init_INET(GAddress *address);

 
 

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

 
 

-#ifdef __cplusplus
-};
-#endif /* __cplusplus */
+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);

 
 

+#endif // wxUSE_IPV6
+
+// these functions are available under all platforms but only implemented under
+// Unix ones, elsewhere they just return GSOCK_INVADDR
+GSocketError _GAddress_Init_UNIX(GAddress *address);
+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_ */