Minor corrections to make dist after reports

[wxWidgets.git] / include / wx / sckipc.h

diff --git a/include/wx/sckipc.h b/include/wx/sckipc.h
index 19a6fe2e1f295b6ed7c3c0c866b3bd6f9f71fb33..4d4164cd8c9e2762d1dc3d43c86f4b1dff8aa193 100644 (file)
--- a/include/wx/sckipc.h
+++ b/include/wx/sckipc.h
@@ -1,23 +1,25 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sckipc.h
-// Purpose:     Interprocess communication
-// Author:      Julian Smart/Guilhem Lavaux (big rewrite)
-// Modified by: Guilhem Lavaux 1997
+// 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) 1993 Julian Smart
-//              (c) 1997, 1998 Guilhem Lavaux
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart 1993
+//              (c) Guilhem Lavaux 1997, 1998
+//              (c) 2000 Guillermo Rodriguez <guille@iies.es>
+// 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"
@@ -47,87 +49,95 @@
  *
  */
 
-class wxTCPServer;
-class wxTCPClient;
-class wxTCPConnection: public wxConnectionBase
-{
-  DECLARE_DYNAMIC_CLASS(wxTCPConnection)
-  
-protected:
-  wxSocketBase *m_sock;
-  wxSocketStream *m_sockstrm;
-  wxDataInputStream *m_codeci;
-  wxDataOutputStream *m_codeco;
-  wxString m_topic;
+class WXDLLIMPEXP_FWD_NET wxTCPServer;
+class WXDLLIMPEXP_FWD_NET wxTCPClient;
 
-  friend class wxTCPServer;
-  friend class wxTCPClient;
-  friend void Client_OnRequest(wxSocketBase&,
-                              wxSocketBase::wxRequestEvent, char *);
-  friend void Server_OnRequest(wxSocketServer&,
-                              wxSocketBase::wxRequestEvent, char *);
+class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
+{
 public:
-
-  wxTCPConnection(char *buffer, int size);
+  wxTCPConnection(void *buffer, size_t size);
   wxTCPConnection();
   virtual ~wxTCPConnection();
 
-  // Calls that CLIENT can make
-  bool Execute(char *data, int size = -1,
-               wxDataFormat format = wxDF_TEXT);
-  char *Request(const wxString& item, int *size = NULL,
-                wxDataFormat format = wxDF_TEXT);
-  bool Poke(const wxString& item, char *data, int size = -1,
-            wxDataFormat format = wxDF_TEXT);
-  bool StartAdvise(const wxString& item);
-  bool StopAdvise(const wxString& item);
+  // To enable the compressor (NOTE: not implemented!)
+  void Compress(bool on);
+
 
-  // Calls that SERVER can make
-  bool Advise(const wxString& item, char *data, int size = -1,
-              wxDataFormat format = wxDF_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
-  bool Disconnect();
+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);
 
-  // Called when we lost the peer.
-  bool OnDisconnect() { return TRUE; }
 
-  // To enable the compressor
-  void Compress(bool on);
+  wxSocketBase       *m_sock;
+  wxSocketStream     *m_sockstrm;
+  wxDataInputStream  *m_codeci;
+  wxDataOutputStream *m_codeco;
+  wxString            m_topic;
+
+  friend class wxTCPServer;
+  friend class wxTCPClient;
+  friend class wxTCPEventHandler;
+
+  DECLARE_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 if can't create server (e.g. port number is already in use)
-  virtual bool Create(const wxString& server_name); 
+
+  // Returns false on error (e.g. port number is already in use)
+  virtual bool Create(const wxString& serverName);
+
   virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
+
+  wxTCPConnection *topLevelConnection;
+
+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__
+
+  DECLARE_NO_COPY_CLASS(wxTCPServer)
+  DECLARE_DYNAMIC_CLASS(wxTCPServer)
 };
 
-class wxTCPClient: public wxClientBase
+class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase
 {
-  DECLARE_DYNAMIC_CLASS(wxTCPClient)
-
-public: 
+public:
   wxTCPClient();
   virtual ~wxTCPClient();
 
   virtual bool ValidHost(const wxString& host);
-    // Call this to make a connection.
-    // Returns NULL if cannot.
+
+  // 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.
+
+  // 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