/* -------------------------------------------------------------------------
- * 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> (maintainer)
+ * Copyright: (c) Guilhem Lavaux
+ * Licence: wxWindows Licence
+ * Purpose: GSocket include file (system independent)
+ * CVSID: $Id$
* -------------------------------------------------------------------------
*/
+
#ifndef __GSOCKET_H
#define __GSOCKET_H
-#include <sys/types.h>
+#ifndef __GSOCKET_STANDALONE__
+#include "wx/defs.h"
+
+#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */
+
+#endif
-#if !defined(__cplusplus)
+#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
-typedef int bool;
+#include <stddef.h>
+/*
+ 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
-#ifndef TRUE
-#define TRUE 1
+#ifdef __WXWINCE__
+#include <stdlib.h>
#endif
-#ifndef FALSE
-#define FALSE 0
+class GSocket;
+
+#ifdef __cplusplus
+extern "C" {
#endif
-typedef struct _GSocket GSocket;
typedef struct _GAddress GAddress;
typedef enum {
GSOCK_INVADDR,
GSOCK_INVSOCK,
GSOCK_NOHOST,
- GSOCK_INVPORT
+ GSOCK_INVPORT,
+ GSOCK_WOULDBLOCK,
+ GSOCK_TIMEDOUT,
+ GSOCK_MEMERR,
+ GSOCK_OPTERR
} GSocketError;
+/* See below for an explanation on how events work.
+ */
typedef enum {
GSOCK_INPUT = 0,
GSOCK_OUTPUT = 1,
typedef int GSocketEventFlags;
-typedef void (*GSocketFallback)(GSocket *socket, GSocketEvent event,
+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);
+/* 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:
+ // needed since this class declares virtual members
+ virtual ~GSocketGUIFunctionsTable() { }
+ 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(), ... */
-/*
- 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);
+/* Global initializers */
-/* Flags */
+/* Sets GUI functions callbacks. Must be called *before* GSocket_Init
+ if the app uses async sockets. */
+void GSocket_SetGUIFunctions(GSocketGUIFunctionsTable *guifunc);
-/*
- GSocket_SetBlocking() puts the socket in non-blocking mode. This is useful
- if we don't want to wait.
-*/
-void GSocket_SetBlocking(GSocket *socket, bool block);
+/* GSocket_Init() must be called at the beginning */
+int GSocket_Init(void);
-/*
- GSocket_GetError() returns the last error occured on the socket stream.
-*/
+/* GSocket_Cleanup() must be called at the end */
+void GSocket_Cleanup(void);
-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
-
- SetFallback 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_SetFallback(GSocket *socket, GSocketEventFlags event,
- GSocketFallback fallback, char *cdata);
+GSocket *GSocket_new(void);
-/*
- UnsetFallback will disables all fallbacks specified by "event".
- NOTE: event may be a combination of flags
-*/
-void GSocket_UnsetFallback(GSocket *socket, GSocketEventFlags event);
/* GAddress */
-GAddress *GAddress_new();
+GAddress *GAddress_new(void);
GAddress *GAddress_copy(GAddress *address);
void GAddress_destroy(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_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,
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);
-/*
- * System specific functions
- */
+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
-/* On systems needing an event id */
-void GSocket_SetEventID(GSocket *socket, unsigned long evt_id);
+/* TODO: Define specific parts (UNIX) */
-/* On systems which don't have background refresh */
-void GSocket_DoEvent(unsigned long evt_id);
+GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
+GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
#ifdef __cplusplus
-};
-#endif
+}
+#endif /* __cplusplus */
-#endif
- /* __GSOCKET_H */
+# if defined(__WINDOWS__)
+# include "wx/msw/gsockmsw.h"
+# else
+# include "wx/unix/gsockunx.h"
+# endif
+
+#endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
+
+#endif /* __GSOCKET_H */
projects / wxWidgets.git / blobdiff