bracket unused function

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

diff --git a/include/wx/sckipc.h b/include/wx/sckipc.h
index 8ca86b2ae25b1e635d9b137ef9f4683abae0147e..6eccefc84a5cfd6af0fc959ed0761f9c3cff2a30 100644 (file)
--- a/include/wx/sckipc.h
+++ b/include/wx/sckipc.h
@@ -1,23 +1,25 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sckipc.h
 /////////////////////////////////////////////////////////////////////////////
 // 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$
 // 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
 
 #ifndef _WX_SCKIPC_H
 #define _WX_SCKIPC_H
 

-#ifdef __GNUG__
-#pragma interface
-#endif
-

 #include "wx/defs.h"
 #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"
 #include "wx/ipcbase.h"
 #include "wx/socket.h"
 #include "wx/sckstrm.h"


@@ -47,86 +49,112 @@
  *
  */
 
  *
  */
 

-class wxTCPServer;
-class wxTCPClient;
-class wxTCPConnection: public wxConnectionBase
+class WXDLLIMPEXP_FWD_NET wxTCPServer;
+class WXDLLIMPEXP_FWD_NET wxTCPClient;
+
+class wxIPCSocketStreams;
+
+class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxTCPConnection)
-  
-protected:
-  wxSocketBase *m_sock;
-  wxSocketStream *m_sockstrm;
-  wxDataStream *m_codec;
-  wxString m_topic;
-
-  friend class wxTCPServer;
-  friend class wxTCPClient;
-  friend void Client_OnRequest(wxSocketBase&,
-                              wxSocketBase::wxRequestEvent, char *);
-  friend void Server_OnRequest(wxSocketServer&,
-                              wxSocketBase::wxRequestEvent, char *);

 public:
 public:

+    wxTCPConnection() { Init(); }
+    wxTCPConnection(void *buffer, size_t size)
+        : wxConnectionBase(buffer, size)
+    {
+        Init();
+    }
+
+    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);
+
+    // Will be used in the future to enable the compression but does nothing
+    // for now.
+    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);
+

 
 

-  wxTCPConnection(char *buffer, int size);
-  wxTCPConnection();
-  virtual ~wxTCPConnection();
+    // 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

 
 

-  // 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);
+    // the underlying socket (wxSocketClient for IPC client and wxSocketServer
+    // for IPC server)
+    wxSocketBase *m_sock;

 
 

-  // Calls that SERVER can make
-  bool Advise(const wxString& item, char *data, int size = -1,
-              wxDataFormat format = wxDF_TEXT);
+    // various streams that we use
+    wxIPCSocketStreams *m_streams;

 
 

-  // Calls that both can make
-  bool Disconnect();
+    // the topic of this connection
+    wxString m_topic;

 
 

-  // Called when we lost the peer.
-  bool OnDisconnect() { return TRUE; }
+private:
+    // common part of both ctors
+    void Init();

 
 

-  // To enable the compressor
-  void Compress(bool on);
+    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:
 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); 
-  virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
+    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);
+
+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();
+public:
+    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