X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0834112f89c4c5da7864e17e6f483ce296798ce6..a4301b8f14d21b7d28fc4f6a247b740d945ca6dc:/include/wx/sckipc.h?ds=sidebyside diff --git a/include/wx/sckipc.h b/include/wx/sckipc.h index 87d414217c..d446cc4700 100644 --- a/include/wx/sckipc.h +++ b/include/wx/sckipc.h @@ -1,25 +1,25 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: sckipc.h +// Name: wx/sckipc.h // Purpose: Interprocess communication implementation (wxSocket version) // Author: Julian Smart // Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998 // Guillermo Rodriguez (updated for wxSocket v2) Jan 2000 +// (callbacks deprecated) Mar 2000 // Created: 1993 // RCS-ID: $Id$ // Copyright: (c) Julian Smart 1993 // (c) Guilhem Lavaux 1997, 1998 // (c) 2000 Guillermo Rodriguez -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// + #ifndef _WX_SCKIPC_H #define _WX_SCKIPC_H -#ifdef __GNUG__ -#pragma interface -#endif - #include "wx/defs.h" -#include "wx/setup.h" + +#if wxUSE_SOCKETS && wxUSE_IPC + #include "wx/ipcbase.h" #include "wx/socket.h" #include "wx/sckstrm.h" @@ -49,98 +49,112 @@ * */ -class wxTCPServer; -class wxTCPClient; -class wxTCPConnection: public wxConnectionBase -{ - DECLARE_DYNAMIC_CLASS(wxTCPConnection) +class WXDLLIMPEXP_FWD_NET wxTCPServer; +class WXDLLIMPEXP_FWD_NET wxTCPClient; -protected: - wxSocketBase *m_sock; - wxSocketStream *m_sockstrm; - wxDataInputStream *m_codeci; - wxDataOutputStream *m_codeco; - wxString m_topic; - - friend class wxTCPServer; - friend class wxTCPClient; - friend void Client_OnRequest(wxSocketBase&, - wxSocketNotify, char *); - friend void Server_OnRequest(wxSocketServer&, - wxSocketNotify, char *); +class wxIPCSocketStreams; + +class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase +{ public: + wxTCPConnection() { Init(); } + wxTCPConnection(void *buffer, size_t size) + : wxConnectionBase(buffer, size) + { + Init(); + } + + virtual ~wxTCPConnection(); - wxTCPConnection(char *buffer, int size); - wxTCPConnection(); - virtual ~wxTCPConnection(); + // implement base class pure virtual methods + virtual const void *Request(const wxString& item, + size_t *size = NULL, + wxIPCFormat format = wxIPC_TEXT); + virtual bool StartAdvise(const wxString& item); + virtual bool StopAdvise(const wxString& item); + virtual bool Disconnect(void); - // Calls that CLIENT can make - virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT); - virtual bool Execute(const wxString& str) { return Execute(str, -1, wxIPC_TEXT); } - virtual char *Request(const wxString& item, int *size = NULL, wxIPCFormat format = wxIPC_TEXT); - virtual bool Poke(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT); - virtual bool StartAdvise(const wxString& item); - virtual bool StopAdvise(const wxString& item); + // Will be used in the future to enable the compression but does nothing + // for now. + void Compress(bool on); - // Calls that SERVER can make - virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT); - // Calls that both can make - virtual bool Disconnect(void); +protected: + virtual bool DoExecute(const void *data, size_t size, wxIPCFormat format); + virtual bool DoPoke(const wxString& item, const void *data, size_t size, + wxIPCFormat format); + virtual bool DoAdvise(const wxString& item, const void *data, size_t size, + wxIPCFormat format); - // Callbacks to SERVER - override at will - virtual bool OnExecute(const wxString& topic, char *data, int size, wxIPCFormat format) { return FALSE; }; - virtual char *OnRequest(const wxString& topic, const wxString& item, int *size, wxIPCFormat format) { return NULL; }; - virtual bool OnPoke(const wxString& topic, const wxString& item, char *data, int size, wxIPCFormat format) { return FALSE; }; - virtual bool OnStartAdvise(const wxString& topic, const wxString& item) { return FALSE; }; - virtual bool OnStopAdvise(const wxString& topic, const wxString& item) { return FALSE; }; - // Callbacks to CLIENT - override at will - virtual bool OnAdvise(const wxString& topic, const wxString& item, char *data, int size, wxIPCFormat format) { return FALSE; }; + // notice that all the members below are only initialized once the + // connection is made, i.e. in MakeConnection() for the client objects and + // after OnAcceptConnection() in the server ones - // Callbacks to BOTH + // the underlying socket (wxSocketClient for IPC client and wxSocketServer + // for IPC server) + wxSocketBase *m_sock; - // Default behaviour is to delete connection and return TRUE - virtual bool OnDisconnect(void) { delete this; return TRUE; } + // various streams that we use + wxIPCSocketStreams *m_streams; - // To enable the compressor - void Compress(bool on); + // the topic of this connection + wxString m_topic; private: + // common part of both ctors + void Init(); + + friend class wxTCPServer; + friend class wxTCPClient; + friend class wxTCPEventHandler; + + wxDECLARE_NO_COPY_CLASS(wxTCPConnection); + DECLARE_DYNAMIC_CLASS(wxTCPConnection) }; -class wxTCPServer: public wxServerBase +class WXDLLIMPEXP_NET wxTCPServer : public wxServerBase { - DECLARE_DYNAMIC_CLASS(wxTCPServer) - public: - wxTCPConnection *topLevelConnection; + wxTCPServer(); + virtual ~wxTCPServer(); + + // Returns false on error (e.g. port number is already in use) + virtual bool Create(const wxString& serverName); + + virtual wxConnectionBase *OnAcceptConnection(const wxString& topic); - wxTCPServer(); - virtual ~wxTCPServer(); +protected: + wxSocketServer *m_server; + +#ifdef __UNIX_LIKE__ + // the name of the file associated to the Unix domain socket, may be empty + wxString m_filename; +#endif // __UNIX_LIKE__ - // Returns FALSE if can't create server (e.g. port number is already in use) - virtual bool Create(const wxString& server_name); - virtual wxConnectionBase *OnAcceptConnection(const wxString& topic); + wxDECLARE_NO_COPY_CLASS(wxTCPServer); + DECLARE_DYNAMIC_CLASS(wxTCPServer) }; -class wxTCPClient: public wxClientBase +class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase { - DECLARE_DYNAMIC_CLASS(wxTCPClient) - public: - wxTCPClient(); - virtual ~wxTCPClient(); - - virtual bool ValidHost(const wxString& host); - // Call this to make a connection. - // Returns NULL if cannot. - virtual wxConnectionBase *MakeConnection(const wxString& host, - const wxString& server, - const wxString& topic); - - // Tailor this to return own connection. - virtual wxConnectionBase *OnMakeConnection(); + wxTCPClient(); + + virtual bool ValidHost(const wxString& host); + + // Call this to make a connection. Returns NULL if cannot. + virtual wxConnectionBase *MakeConnection(const wxString& host, + const wxString& server, + const wxString& topic); + + // Callbacks to CLIENT - override at will + virtual wxConnectionBase *OnMakeConnection(); + +private: + DECLARE_DYNAMIC_CLASS(wxTCPClient) }; -#endif // ipcsock.h +#endif // wxUSE_SOCKETS && wxUSE_IPC + +#endif // _WX_SCKIPC_H