/////////////////////////////////////////////////////////////////////////////
-// 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
// Copyright: (c) Julian Smart 1993
// (c) Guilhem Lavaux 1997, 1998
// (c) 2000 Guillermo Rodriguez <guille@iies.es>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_SCKIPC_H
#define _WX_SCKIPC_H
-#ifdef __GNUG__
-#pragma interface "sckipc.h"
-#endif
-
#include "wx/defs.h"
#if wxUSE_SOCKETS && wxUSE_IPC
*
*/
-class WXDLLEXPORT wxTCPServer;
-class WXDLLEXPORT wxTCPClient;
+class WXDLLIMPEXP_FWD_NET wxTCPServer;
+class WXDLLIMPEXP_FWD_NET wxTCPClient;
+
+class wxIPCSocketStreams;
-class WXDLLEXPORT wxTCPConnection: public wxConnectionBase
+class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
{
- DECLARE_DYNAMIC_CLASS(wxTCPConnection)
public:
- wxTCPConnection(char *buffer, int size);
- wxTCPConnection();
- virtual ~wxTCPConnection();
-
- // Calls that CLIENT can make
- virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = 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);
+ wxTCPConnection() { Init(); }
+ wxTCPConnection(void *buffer, size_t size)
+ : wxConnectionBase(buffer, size)
+ {
+ Init();
+ }
- // Calls that SERVER can make
- virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
+ virtual ~wxTCPConnection();
- // Calls that both can make
- virtual bool Disconnect(void);
+ // 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);
- // Default behaviour is to delete connection and return TRUE
- virtual bool OnDisconnect(void) { delete this; return TRUE; }
+ // Will be used in the future to enable the compression but does nothing
+ // for now.
+ void Compress(bool on);
- // To enable the compressor
- void Compress(bool on);
protected:
- wxSocketBase *m_sock;
- wxSocketStream *m_sockstrm;
- wxDataInputStream *m_codeci;
- wxDataOutputStream *m_codeco;
- wxString m_topic;
+ 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);
+
+
+ // 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
- friend class wxTCPServer;
- friend class wxTCPClient;
- friend class wxTCPEventHandler;
+ // the underlying socket (wxSocketClient for IPC client and wxSocketServer
+ // for IPC server)
+ wxSocketBase *m_sock;
+
+ // various streams that we use
+ wxIPCSocketStreams *m_streams;
+
+ // the topic of this connection
+ wxString m_topic;
private:
- //
- // We're hiding an Execute method in ConnectionBase
- //
- virtual bool Execute(const wxString& str)
- { return Execute(str, -1, wxIPC_TEXT); }
+ // 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();
- wxTCPServer();
- virtual ~wxTCPServer();
+ // Returns false on error (e.g. port number is already in use)
+ virtual bool Create(const wxString& serverName);
- // 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);
+ virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
+
+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__
+
+ 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 // wxUSE_SOCKETS && wxUSE_IPC
projects / wxWidgets.git / blobdiff