X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/91a40e94b9efe799e401638edf84e75d3285d11b..44c87b7d15d5c1f5926beffa4cd5c9d1d2045e04:/include/wx/unix/gsockunx.h diff --git a/include/wx/unix/gsockunx.h b/include/wx/unix/gsockunx.h index cf04be6a65..0d57fe5a2f 100644 --- a/include/wx/unix/gsockunx.h +++ b/include/wx/unix/gsockunx.h @@ -1,72 +1,50 @@ /* ------------------------------------------------------------------------- - * Project: GSocket (Generic Socket) for WX - * Name: gsockunx.h - * Purpose: GSocket Unix header - * CVSID: $Id$ + * Project: GSocket (Generic Socket) for WX + * Name: gsockunx.h + * Copyright: (c) Guilhem Lavaux + * Licence: wxWindows Licence + * Purpose: GSocket Unix header + * CVSID: $Id$ * ------------------------------------------------------------------------- */ -#ifndef __GSOCK_UNX_H -#define __GSOCK_UNX_H +#ifndef _WX_UNIX_GSOCKUNX_H_ +#define _WX_UNIX_GSOCKUNX_H_ -#ifndef __GSOCKET_STANDALONE__ -#include "wx/setup.h" -#endif +class wxGSocketIOHandler; -#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) - -#ifndef __GSOCKET_STANDALONE__ -#include "wx/gsocket.h" -#else -#include "gsocket.h" -#endif - -class GSocketGUIFunctionsTableConcrete: public GSocketGUIFunctionsTable -{ -public: - virtual bool OnInit(); - virtual void OnExit(); - virtual bool CanUseEventLoop(); - virtual bool Init_Socket(GSocket *socket); - virtual void Destroy_Socket(GSocket *socket); - virtual void Install_Callback(GSocket *socket, GSocketEvent event); - virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event); - virtual void Enable_Events(GSocket *socket); - virtual void Disable_Events(GSocket *socket); -}; - -class GSocket +class GSocket : public GSocketBase { public: - GSocket(); + GSocket(wxSocketBase& wxsocket); virtual ~GSocket(); - bool IsOk() { return m_ok; } - void Close(); - void Shutdown(); - GSocketError SetLocal(GAddress *address); - GSocketError SetPeer(GAddress *address); - GAddress *GetLocal(); - GAddress *GetPeer(); + + virtual void Close(); + virtual void Shutdown(); + virtual GSocket *WaitConnection(wxSocketBase& wxsocket); + GSocketError SetServer(); - GSocket *WaitConnection(); bool SetReusable(); + bool SetBroadcast(); + bool DontDoBind(); 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(bool non_block); - void SetTimeout(unsigned long millisec); GSocketError WXDLLIMPEXP_NET 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); - virtual void Detected_Read(); - virtual void Detected_Write(); + //attach or detach from main loop + void Notify(bool flag); + void Detected_Read(); + void Detected_Write(); + protected: + //enable or disable event callback using gsocket gui callback table + void EnableEvents(bool flag = true); + void DisableEvents() { EnableEvents(false); } void Enable(GSocketEvent event); void Disable(GSocketEvent event); GSocketError Input_Timeout(); @@ -75,69 +53,138 @@ protected: int Recv_Dgram(char *buffer, int size); int Send_Stream(const char *buffer, int size); int Send_Dgram(const char *buffer, int size); - bool m_ok; public: /* DFE: We can't protect these data member until the GUI code is updated */ /* protected: */ - int m_fd; - GAddress *m_local; - GAddress *m_peer; - GSocketError m_error; + wxGSocketIOHandler *m_handler; - bool m_non_blocking; - bool m_server; - bool m_stream; - bool m_establishing; - bool m_reusable; - unsigned long m_timeout; + // true if socket should fire events + bool m_use_events; - /* Callbacks */ - GSocketEventFlags m_detected; - GSocketCallback m_cbacks[GSOCK_MAX_EVENT]; - char *m_data[GSOCK_MAX_EVENT]; - - char *m_gui_dependent; + // pointer for storing extra (usually GUI-specific) data + void *m_gui_dependent; +private: + // notify the associated wxSocket about a change in socket state and shut + // down the socket if the event is GSOCK_LOST + void OnStateChange(GSocketEvent event); }; -#ifdef __cplusplus -extern "C" { -#endif /* __cplusplus */ -/* Definition of GAddress */ -struct _GAddress +// A version of GSocketManager which uses FDs for socket IO +// +// This class uses GSocket::m_gui_dependent field to store the 2 (for input and +// output) FDs associated with the socket. +class GSocketFDBasedManager : public GSocketManager { - struct sockaddr *m_addr; - size_t m_len; - - GAddressType m_family; - int m_realfamily; +public: + // no special initialization/cleanup needed when using FDs + virtual bool OnInit() { return true; } + virtual void OnExit() { } + + // allocate/free the storage we need + virtual bool Init_Socket(GSocket *socket) + { + socket->m_gui_dependent = malloc(sizeof(int)*2); + int * const fds = static_cast(socket->m_gui_dependent); + + fds[0] = -1; + fds[1] = -1; + + return true; + } + virtual void Destroy_Socket(GSocket *socket) + { + free(socket->m_gui_dependent); + } + + virtual void Enable_Events(GSocket *socket) + { + Install_Callback(socket, GSOCK_INPUT); + Install_Callback(socket, GSOCK_OUTPUT); + } + virtual void Disable_Events(GSocket *socket) + { + Uninstall_Callback(socket, GSOCK_INPUT); + Uninstall_Callback(socket, GSOCK_OUTPUT); + } - GSocketError m_error; +protected: + // identifies either input or output direction + // + // NB: the values of this enum shouldn't change + enum SocketDir + { + FD_INPUT, + FD_OUTPUT + }; + + // get the FD index corresponding to the given GSocketEvent + SocketDir GetDirForEvent(GSocket *socket, GSocketEvent event) + { + switch ( event ) + { + default: + wxFAIL_MSG( "unexpected socket event" ); + // fall through + + case GSOCK_LOST: + // fall through + + case GSOCK_INPUT: + return FD_INPUT; + + case GSOCK_OUTPUT: + return FD_OUTPUT; + + case GSOCK_CONNECTION: + // FIXME: explain this? + return socket->m_server ? FD_INPUT : FD_OUTPUT; + } + } + + // access the FDs we store + int& FD(GSocket *socket, SocketDir d) + { + return static_cast(socket->m_gui_dependent)[d]; + } }; -#ifdef __cplusplus -} -#endif /* __cplusplus */ - - -#ifdef __cplusplus -extern "C" { -#endif /* __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); +// Common base class for all ports using X11-like (and hence implemented in +// X11, Motif and GTK) AddInput() and RemoveInput() functions +class GSocketInputBasedManager : public GSocketFDBasedManager +{ +public: + virtual void Install_Callback(GSocket *socket, GSocketEvent event) + { + wxCHECK_RET( socket->m_fd != -1, + "shouldn't be called on invalid socket" ); + + const SocketDir d = GetDirForEvent(socket, event); + + int& fd = FD(socket, d); + if ( fd != -1 ) + RemoveInput(fd); + + fd = AddInput(socket, d); + } + + virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event) + { + const SocketDir d = GetDirForEvent(socket, event); + + int& fd = FD(socket, d); + if ( fd != -1 ) + { + RemoveInput(fd); + fd = -1; + } + } + +private: + // these functions map directly to XtAdd/RemoveInput() or + // gdk_input_add/remove() + virtual int AddInput(GSocket *socket, SocketDir d) = 0; + virtual void RemoveInput(int fd) = 0; +}; -#ifdef __cplusplus -} -#endif /* __cplusplus */ - -#endif /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */ - -#endif /* __GSOCK_UNX_H */ +#endif /* _WX_UNIX_GSOCKUNX_H_ */