/////////////////////////////////////////////////////////////////////////////
-// 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
*
*/
-class WXDLLIMPEXP_NET wxTCPServer;
-class WXDLLIMPEXP_NET wxTCPClient;
+class WXDLLIMPEXP_FWD_NET wxTCPServer;
+class WXDLLIMPEXP_FWD_NET wxTCPClient;
-class WXDLLIMPEXP_NET wxTCPConnection: public wxConnectionBase
-{
- DECLARE_DYNAMIC_CLASS(wxTCPConnection)
+class wxIPCSocketStreams;
+class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
+{
public:
- wxTCPConnection(wxChar *buffer, int size);
- wxTCPConnection();
- virtual ~wxTCPConnection();
+ wxTCPConnection() { Init(); }
+ wxTCPConnection(void *buffer, size_t size)
+ : wxConnectionBase(buffer, size)
+ {
+ Init();
+ }
- // Calls that CLIENT can make
- virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
- virtual wxChar *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);
+ virtual ~wxTCPConnection();
- // Calls that SERVER can make
- virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
+ // 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 both can make
- virtual bool Disconnect(void);
+ // Will be used in the future to enable the compression but does nothing
+ // for now.
+ void Compress(bool on);
- // Callbacks to BOTH - override at will
- // Default behaviour is to delete connection and return true
- virtual bool OnDisconnect(void) { delete this; return true; }
- // To enable the compressor (NOTE: not implemented!)
- void Compress(bool on);
+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);
- // unhide the Execute overload from wxConnectionBase
- virtual bool Execute(const wxString& str)
- { return Execute(str, -1, wxIPC_TEXT); }
-protected:
- wxSocketBase *m_sock;
- wxSocketStream *m_sockstrm;
- wxDataInputStream *m_codeci;
- wxDataOutputStream *m_codeco;
- wxString m_topic;
+ // 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
+
+ // the underlying socket (wxSocketClient for IPC client and wxSocketServer
+ // for IPC server)
+ wxSocketBase *m_sock;
- friend class wxTCPServer;
- friend class wxTCPClient;
- friend class wxTCPEventHandler;
+ // various streams that we use
+ wxIPCSocketStreams *m_streams;
- DECLARE_NO_COPY_CLASS(wxTCPConnection)
+ // 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 WXDLLIMPEXP_NET wxTCPServer: public wxServerBase
+class WXDLLIMPEXP_NET wxTCPServer : public wxServerBase
{
public:
- wxTCPConnection *topLevelConnection;
-
- wxTCPServer();
- virtual ~wxTCPServer();
+ wxTCPServer();
+ virtual ~wxTCPServer();
- // Returns false on error (e.g. port number is already in use)
- virtual bool Create(const wxString& serverName);
+ // Returns false on error (e.g. port number is already in use)
+ virtual bool Create(const wxString& serverName);
- // Callbacks to SERVER - override at will
- virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
+ virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
protected:
- wxSocketServer *m_server;
+ wxSocketServer *m_server;
#ifdef __UNIX_LIKE__
- // the name of the file associated to the Unix domain socket, may be empty
- wxString m_filename;
+ // the name of the file associated to the Unix domain socket, may be empty
+ wxString m_filename;
#endif // __UNIX_LIKE__
- DECLARE_NO_COPY_CLASS(wxTCPServer)
- DECLARE_DYNAMIC_CLASS(wxTCPServer)
+ wxDECLARE_NO_COPY_CLASS(wxTCPServer);
+ DECLARE_DYNAMIC_CLASS(wxTCPServer)
};
-class WXDLLIMPEXP_NET wxTCPClient: public wxClientBase
+class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase
{
public:
- wxTCPClient();
- virtual ~wxTCPClient();
+ wxTCPClient();
- virtual bool ValidHost(const wxString& host);
+ 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);
+ // 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();
+ // Callbacks to CLIENT - override at will
+ virtual wxConnectionBase *OnMakeConnection();
private:
- DECLARE_DYNAMIC_CLASS(wxTCPClient)
+ DECLARE_DYNAMIC_CLASS(wxTCPClient)
};
#endif // wxUSE_SOCKETS && wxUSE_IPC