[wxWidgets.git] / include / wx / unix / gsockunx.h

/* -------------------------------------------------------------------------
 * Project: GSocket (Generic Socket) for WX
 * Name:    gsockunx.h
 * Purpose: GSocket Unix header
 * CVSID:   $Id$
 * -------------------------------------------------------------------------
 */

#ifndef __GSOCK_UNX_H
#define __GSOCK_UNX_H

#ifndef __GSOCKET_STANDALONE__
#include "wx/setup.h"
#endif

#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)

#ifndef __GSOCKET_STANDALONE__
#include "wx/gsocket.h"
#else
#include "gsocket.h"
#endif

#ifndef TRUE
#define TRUE 1
#endif

#ifndef FALSE
#define FALSE 0
#endif

#ifdef wxUSE_GSOCKET_CPLUSPLUS
class GSocketBSD
{
public:
    GSocketBSD();
    virtual ~GSocketBSD();
    bool IsOk() { return m_ok; }
    void Close();
    void Shutdown();
    GSocketError SetLocal(GAddress *address);
    GSocketError SetPeer(GAddress *address);
    GAddress *GetLocal();
    GAddress *GetPeer();
    GSocketError SetServer();
    GSocket *WaitConnection();
    int SetReusable();
    GSocketError Connect(GSocketStream stream);
    GSocketError SetNonOriented();
    int Read(char *buffer, int size);
    int Write(const char *buffer, int size);
    GSocketEventFlags Select(GSocketEventFlags flags);
    void SetNonBlocking(int non_block);
    void SetTimeout(unsigned long millisec);
    GSocketError GetError();
    void SetCallback(GSocketEventFlags flags,
        GSocketCallback callback, char *cdata);
    void UnsetCallback(GSocketEventFlags flags);
    GSocketError GetSockOpt(int level, int optname, void *optval, int *optlen);
    GSocketError SetSockOpt(int level, int optname,
        const void *optval, int optlen);
    /* API compatibility functions */
    static void _GSocket_Detected_Read(GSocket *socket);
    static void _GSocket_Detected_Write(GSocket *socket);
protected:
    void Enable(GSocketEvent event);
    void Disable(GSocketEvent event);
    GSocketError Input_Timeout();
    GSocketError Output_Timeout();
    int Recv_Stream(char *buffer, int size);
    int Recv_Dgram(char *buffer, int size);
    int Send_Stream(const char *buffer, int size);
    int Send_Dgram(const char *buffer, int size);
    void Detected_Read();
    void Detected_Write();
    bool m_ok;
    virtual void EventLoop_Enable_Events() = 0;
    virtual void EventLoop_Disable_Events() = 0;
    virtual void EventLoop_Install_Callback(GSocketEvent event) = 0;
    virtual void EventLoop_Uninstall_Callback(GSocketEvent event) = 0;
public:
    /* DFE: We can't protect these data member until the GUI code is updated */
    /* protected: */
#else /* def wxUSE_GSOCKET_CPLUSPLUS */

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* Definition of GSocket */
struct _GSocket
{
#endif /* def wxUSE_GSOCKET_CPLUSPLUS */
  int m_fd;
  GAddress *m_local;
  GAddress *m_peer;
  GSocketError m_error;

  int m_non_blocking;
  int m_server;
  int m_stream;
  int m_establishing;
  int m_reusable;
  unsigned long m_timeout;

  /* Callbacks */
  GSocketEventFlags m_detected;
  GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
  char *m_data[GSOCK_MAX_EVENT];

  char *m_gui_dependent;

  /* Function pointers */
  struct GSocketBaseFunctionsTable *m_functions;
};
#ifndef wxUSE_GSOCKET_CPLUSPLUS
#ifdef __cplusplus
}
#endif  /* __cplusplus */
#else
/**************************************************************************/
/* GSocketBSDGUIShim */
class GSocketBSDGUIShim:public GSocketBSD
{
    friend void GSocket_SetGUIFunctions(struct GSocketGUIFunctionsTable *guifunc);
public:
    static inline bool GUI_Init();
    static inline void GUI_Cleanup();
    static inline bool UseGUI();
    GSocketBSDGUIShim();
    virtual ~GSocketBSDGUIShim();
protected:
    virtual void EventLoop_Enable_Events();
    virtual void EventLoop_Disable_Events();
    virtual void EventLoop_Install_Callback(GSocketEvent event);
    virtual void EventLoop_Uninstall_Callback(GSocketEvent event);
private:
/* Table of GUI-related functions. We must call them indirectly because
 * of wxBase and GUI separation: */

    static struct GSocketGUIFunctionsTable *ms_gui_functions;
};

#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* Definition of GAddress */
struct _GAddress
{
  struct sockaddr *m_addr;
  size_t m_len;

  GAddressType m_family;
  int m_realfamily;

  GSocketError m_error;
};
#ifdef __cplusplus
}
#endif  /* __cplusplus */

/* Compatibility methods to support old C API (from gsocket.h) */
#ifdef wxUSE_GSOCKET_CPLUSPLUS
inline void GSocket_Shutdown(GSocket *socket)
{   socket->Shutdown(); }
inline GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address)
{   return socket->SetLocal(address); }
inline GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address)
{   return socket->SetPeer(address); }
inline GAddress *GSocket_GetLocal(GSocket *socket)
{   return socket->GetLocal(); }
inline GAddress *GSocket_GetPeer(GSocket *socket)
{   return socket->GetPeer(); }
inline GSocketError GSocket_SetServer(GSocket *socket)
{   return socket->SetServer(); }
inline GSocket *GSocket_WaitConnection(GSocket *socket)
{   return socket->WaitConnection(); }
inline int GSocket_SetReusable(GSocket *socket)
{   return socket->SetReusable(); }
inline GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream)
{   return socket->Connect(stream); }
inline GSocketError GSocket_SetNonOriented(GSocket *socket)
{   return socket->SetNonOriented(); }
inline int GSocket_Read(GSocket *socket, char *buffer, int size)
{   return socket->Read(buffer,size); }
inline int GSocket_Write(GSocket *socket, const char *buffer, int size)
{   return socket->Write(buffer,size); }
inline GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags)
{   return socket->Select(flags); }
inline void GSocket_SetNonBlocking(GSocket *socket, int non_block)
{   socket->SetNonBlocking(non_block); }
inline void GSocket_SetTimeout(GSocket *socket, unsigned long millisec)
{   socket->SetTimeout(millisec); }
inline void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
                         GSocketCallback fallback, char *cdata)
{   socket->SetCallback(flags,fallback,cdata); }
inline void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags)
{   socket->UnsetCallback(flags); }
inline GSocketError GSocket_GetSockOpt(GSocket *socket, int level, int optname,
                        void *optval, int *optlen)
{   return socket->GetSockOpt(level,optname,optval,optlen); }
inline GSocketError GSocket_SetSockOpt(GSocket *socket, int level, int optname,
                        const void *optval, int optlen)
{   return socket->SetSockOpt(level,optname,optval,optlen); }

#endif /* def wxUSE_GSOCKET_CPLUSPLUS */

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

/* Input / Output */

GSocketError _GSocket_Input_Timeout(GSocket *socket);
GSocketError _GSocket_Output_Timeout(GSocket *socket);
int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size);
int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size);
int _GSocket_Send_Stream(GSocket *socket, const char *buffer, int size);
int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size);

/* Callbacks */

int  _GSocket_GUI_Init(void);
void _GSocket_GUI_Cleanup(void);

int  _GSocket_GUI_Init_Socket(GSocket *socket);
void _GSocket_GUI_Destroy_Socket(GSocket *socket);

void _GSocket_Enable_Events(GSocket *socket);
void _GSocket_Disable_Events(GSocket *socket);
void _GSocket_Install_Callback(GSocket *socket, GSocketEvent event);
void _GSocket_Uninstall_Callback(GSocket *socket, GSocketEvent event);

void _GSocket_Enable(GSocket *socket, GSocketEvent event);
void _GSocket_Disable(GSocket *socket, GSocketEvent event);

#ifndef wxUSE_GSOCKET_CPLUSPLUS
void _GSocket_Detected_Read(GSocket *socket);
void _GSocket_Detected_Write(GSocket *socket);
#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */

/* GAddress */

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_Init_UNIX(GAddress *address);


#ifdef __cplusplus
}
#endif  /* __cplusplus */

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

#endif  /* __GSOCK_UNX_H */
Commit	Line	Data
dbd300df GL	1	/* -------------------------------------------------------------------------
	2	* Project: GSocket (Generic Socket) for WX
	3	* Name: gsockunx.h
	4	* Purpose: GSocket Unix header
	5	* CVSID: $Id$
	6	* -------------------------------------------------------------------------
	7	*/
483249fc	8
a324a7bc GL	9	#ifndef __GSOCK_UNX_H
	10	#define __GSOCK_UNX_H
	11
483249fc	12	#ifndef __GSOCKET_STANDALONE__
d422d01e	13	#include "wx/setup.h"
483249fc	14	#endif
d422d01e	15
483249fc	16	#if wxUSE_SOCKETS \|\| defined(__GSOCKET_STANDALONE__)
d422d01e	17
483249fc	18	#ifndef __GSOCKET_STANDALONE__
d422d01e	19	#include "wx/gsocket.h"
483249fc GRG	20	#else
	21	#include "gsocket.h"
	22	#endif
	23
5c9eff30 GRG	24	#ifndef TRUE
	25	#define TRUE 1
	26	#endif
	27
	28	#ifndef FALSE
	29	#define FALSE 0
	30	#endif
	31
09e6e5ec DE	32	#ifdef wxUSE_GSOCKET_CPLUSPLUS
	33	class GSocketBSD
	34	{
	35	public:
	36	GSocketBSD();
444cb1fd	37	virtual ~GSocketBSD();
09e6e5ec DE	38	bool IsOk() { return m_ok; }
	39	void Close();
	40	void Shutdown();
	41	GSocketError SetLocal(GAddress *address);
	42	GSocketError SetPeer(GAddress *address);
	43	GAddress *GetLocal();
	44	GAddress *GetPeer();
	45	GSocketError SetServer();
	46	GSocket *WaitConnection();
b082b524	47	int SetReusable();
09e6e5ec DE	48	GSocketError Connect(GSocketStream stream);
	49	GSocketError SetNonOriented();
	50	int Read(char *buffer, int size);
	51	int Write(const char *buffer, int size);
	52	GSocketEventFlags Select(GSocketEventFlags flags);
	53	void SetNonBlocking(int non_block);
	54	void SetTimeout(unsigned long millisec);
	55	GSocketError GetError();
	56	void SetCallback(GSocketEventFlags flags,
	57	GSocketCallback callback, char *cdata);
	58	void UnsetCallback(GSocketEventFlags flags);
b082b524 DE	59	GSocketError GetSockOpt(int level, int optname, void optval, int optlen);
	60	GSocketError SetSockOpt(int level, int optname,
	61	const void *optval, int optlen);
09e6e5ec DE	62	/* API compatibility functions */
	63	static void _GSocket_Detected_Read(GSocket *socket);
	64	static void _GSocket_Detected_Write(GSocket *socket);
	65	protected:
	66	void Enable(GSocketEvent event);
	67	void Disable(GSocketEvent event);
	68	GSocketError Input_Timeout();
	69	GSocketError Output_Timeout();
	70	int Recv_Stream(char *buffer, int size);
	71	int Recv_Dgram(char *buffer, int size);
	72	int Send_Stream(const char *buffer, int size);
	73	int Send_Dgram(const char *buffer, int size);
	74	void Detected_Read();
	75	void Detected_Write();
	76	bool m_ok;
444cb1fd DE	77	virtual void EventLoop_Enable_Events() = 0;
	78	virtual void EventLoop_Disable_Events() = 0;
	79	virtual void EventLoop_Install_Callback(GSocketEvent event) = 0;
	80	virtual void EventLoop_Uninstall_Callback(GSocketEvent event) = 0;
09e6e5ec	81	public:
b6db2e91 SN	82	/* DFE: We can't protect these data member until the GUI code is updated */
	83	/* protected: */
	84	#else /* def wxUSE_GSOCKET_CPLUSPLUS */
a324a7bc	85
09e6e5ec DE	86	#ifdef __cplusplus
	87	extern "C" {
	88	#endif /* __cplusplus */
a324a7bc	89	/* Definition of GSocket */
483249fc GRG	90	struct _GSocket
483249fc GRG	91	{
b6db2e91	92	#endif /* def wxUSE_GSOCKET_CPLUSPLUS */
a324a7bc	93	int m_fd;
483249fc GRG	94	GAddress *m_local;
483249fc GRG	95	GAddress *m_peer;
a324a7bc GL	96	GSocketError m_error;
a324a7bc GL	97
27a97d02 GRG	98	int m_non_blocking;
	99	int m_server;
	100	int m_stream;
27a97d02	101	int m_establishing;
bb0926cc	102	int m_reusable;
39b91eca	103	unsigned long m_timeout;
a324a7bc	104
39b91eca	105	/* Callbacks */
483249fc	106	GSocketEventFlags m_detected;
98781fa3	107	GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
a324a7bc GL	108	char *m_data[GSOCK_MAX_EVENT];
a324a7bc GL	109
a324a7bc	110	char *m_gui_dependent;
38bb138f VS	111
	112	/* Function pointers */
	113	struct GSocketBaseFunctionsTable *m_functions;
a324a7bc	114	};
09e6e5ec DE	115	#ifndef wxUSE_GSOCKET_CPLUSPLUS
	116	#ifdef __cplusplus
	117	}
	118	#endif /* __cplusplus */
1119a830	119	#else
b6db2e91 SN	120	/**************************************************************************/
b6db2e91 SN	121	/* GSocketBSDGUIShim */
1119a830 DE	122	class GSocketBSDGUIShim:public GSocketBSD
	123	{
	124	friend void GSocket_SetGUIFunctions(struct GSocketGUIFunctionsTable *guifunc);
	125	public:
	126	static inline bool GUI_Init();
	127	static inline void GUI_Cleanup();
	128	static inline bool UseGUI();
	129	GSocketBSDGUIShim();
	130	virtual ~GSocketBSDGUIShim();
	131	protected:
	132	virtual void EventLoop_Enable_Events();
	133	virtual void EventLoop_Disable_Events();
	134	virtual void EventLoop_Install_Callback(GSocketEvent event);
	135	virtual void EventLoop_Uninstall_Callback(GSocketEvent event);
	136	private:
	137	/* Table of GUI-related functions. We must call them indirectly because
	138	* of wxBase and GUI separation: */
	139
	140	static struct GSocketGUIFunctionsTable *ms_gui_functions;
	141	};
	142
b6db2e91	143	#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
a324a7bc	144
09e6e5ec DE	145	#ifdef __cplusplus
	146	extern "C" {
	147	#endif /* __cplusplus */
a324a7bc	148	/* Definition of GAddress */
483249fc GRG	149	struct _GAddress
483249fc GRG	150	{
a324a7bc GL	151	struct sockaddr *m_addr;
	152	size_t m_len;
	153
	154	GAddressType m_family;
	155	int m_realfamily;
	156
	157	GSocketError m_error;
	158	};
09e6e5ec DE	159	#ifdef __cplusplus
	160	}
	161	#endif /* __cplusplus */
	162
b6db2e91	163	/* Compatibility methods to support old C API (from gsocket.h) */
09e6e5ec DE	164	#ifdef wxUSE_GSOCKET_CPLUSPLUS
	165	inline void GSocket_Shutdown(GSocket *socket)
	166	{ socket->Shutdown(); }
	167	inline GSocketError GSocket_SetLocal(GSocket socket, GAddress address)
	168	{ return socket->SetLocal(address); }
	169	inline GSocketError GSocket_SetPeer(GSocket socket, GAddress address)
	170	{ return socket->SetPeer(address); }
	171	inline GAddress GSocket_GetLocal(GSocket socket)
	172	{ return socket->GetLocal(); }
	173	inline GAddress GSocket_GetPeer(GSocket socket)
	174	{ return socket->GetPeer(); }
	175	inline GSocketError GSocket_SetServer(GSocket *socket)
	176	{ return socket->SetServer(); }
	177	inline GSocket GSocket_WaitConnection(GSocket socket)
	178	{ return socket->WaitConnection(); }
b082b524 DE	179	inline int GSocket_SetReusable(GSocket *socket)
b082b524 DE	180	{ return socket->SetReusable(); }
09e6e5ec DE	181	inline GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream)
	182	{ return socket->Connect(stream); }
	183	inline GSocketError GSocket_SetNonOriented(GSocket *socket)
	184	{ return socket->SetNonOriented(); }
	185	inline int GSocket_Read(GSocket socket, char buffer, int size)
	186	{ return socket->Read(buffer,size); }
	187	inline int GSocket_Write(GSocket socket, const char buffer, int size)
	188	{ return socket->Write(buffer,size); }
	189	inline GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags)
	190	{ return socket->Select(flags); }
	191	inline void GSocket_SetNonBlocking(GSocket *socket, int non_block)
	192	{ socket->SetNonBlocking(non_block); }
	193	inline void GSocket_SetTimeout(GSocket *socket, unsigned long millisec)
	194	{ socket->SetTimeout(millisec); }
	195	inline void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
	196	GSocketCallback fallback, char *cdata)
	197	{ socket->SetCallback(flags,fallback,cdata); }
	198	inline void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags)
	199	{ socket->UnsetCallback(flags); }
b082b524 DE	200	inline GSocketError GSocket_GetSockOpt(GSocket *socket, int level, int optname,
	201	void optval, int optlen)
	202	{ return socket->GetSockOpt(level,optname,optval,optlen); }
	203	inline GSocketError GSocket_SetSockOpt(GSocket *socket, int level, int optname,
	204	const void *optval, int optlen)
	205	{ return socket->SetSockOpt(level,optname,optval,optlen); }
09e6e5ec	206
b6db2e91	207	#endif /* def wxUSE_GSOCKET_CPLUSPLUS */
09e6e5ec DE	208
	209	#ifdef __cplusplus
	210	extern "C" {
	211	#endif /* __cplusplus */
a324a7bc	212
483249fc GRG	213	/* Input / Output */
	214
	215	GSocketError _GSocket_Input_Timeout(GSocket *socket);
	216	GSocketError _GSocket_Output_Timeout(GSocket *socket);
a324a7bc GL	217	int _GSocket_Recv_Stream(GSocket socket, char buffer, int size);
	218	int _GSocket_Recv_Dgram(GSocket socket, char buffer, int size);
	219	int _GSocket_Send_Stream(GSocket socket, const char buffer, int size);
	220	int _GSocket_Send_Dgram(GSocket socket, const char buffer, int size);
483249fc GRG	221
	222	/* Callbacks */
	223
38bb138f VS	224	int _GSocket_GUI_Init(void);
	225	void _GSocket_GUI_Cleanup(void);
	226
	227	int _GSocket_GUI_Init_Socket(GSocket *socket);
	228	void _GSocket_GUI_Destroy_Socket(GSocket *socket);
5ff86996	229
483249fc GRG	230	void _GSocket_Enable_Events(GSocket *socket);
	231	void _GSocket_Disable_Events(GSocket *socket);
	232	void _GSocket_Install_Callback(GSocket *socket, GSocketEvent event);
	233	void _GSocket_Uninstall_Callback(GSocket *socket, GSocketEvent event);
	234
5ff86996 GRG	235	void _GSocket_Enable(GSocket *socket, GSocketEvent event);
5ff86996 GRG	236	void _GSocket_Disable(GSocket *socket, GSocketEvent event);
09e6e5ec DE	237
09e6e5ec DE	238	#ifndef wxUSE_GSOCKET_CPLUSPLUS
5ff86996 GRG	239	void _GSocket_Detected_Read(GSocket *socket);
5ff86996 GRG	240	void _GSocket_Detected_Write(GSocket *socket);
b6db2e91	241	#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
5ff86996	242
483249fc	243	/* GAddress */
e00f35bb	244
54e575f9 GL	245	GSocketError _GAddress_translate_from(GAddress *address,
54e575f9 GL	246	struct sockaddr *addr, int len);
9bf10d6b GRG	247	GSocketError _GAddress_translate_to (GAddress *address,
9bf10d6b GRG	248	struct sockaddr *addr, int len);
54e575f9	249	GSocketError _GAddress_Init_INET(GAddress *address);
54e575f9	250	GSocketError _GAddress_Init_UNIX(GAddress *address);
a324a7bc	251
9bf10d6b	252
d422d01e RR	253	#ifdef __cplusplus
d422d01e RR	254	}
483249fc	255	#endif /* __cplusplus */
d422d01e	256
483249fc	257	#endif /* wxUSE_SOCKETS \|\| defined(__GSOCKET_STANDALONE__) */
d422d01e	258
483249fc	259	#endif /* __GSOCK_UNX_H */