added and documented wx_const/static_cast<>

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

diff --git a/include/wx/sckipc.h b/include/wx/sckipc.h
index ef78d5f86646ee3b31aafddd94798e06e75f2525..9a49fb98ca124fdf096d6e953e36873809e104a3 100644 (file)
--- a/include/wx/sckipc.h
+++ b/include/wx/sckipc.h
@@ -1,23 +1,29 @@
 /////////////////////////////////////////////////////////////////////////////
 // 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
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma interface "sckipc.h"

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


@@ -47,53 +53,57 @@
  *
  */
 
  *
  */
 

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

 {
   DECLARE_DYNAMIC_CLASS(wxTCPConnection)
 {
   DECLARE_DYNAMIC_CLASS(wxTCPConnection)

-  
-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&,
-                              wxSocketBase::wxRequestEvent, char *);
-  friend void Server_OnRequest(wxSocketServer&,
-                              wxSocketBase::wxRequestEvent, char *);

 public:
 public:

-
-  wxTCPConnection(char *buffer, int size);
+  wxTCPConnection(wxChar *buffer, int size);

   wxTCPConnection();
   virtual ~wxTCPConnection();
 
   // Calls that CLIENT can make
   wxTCPConnection();
   virtual ~wxTCPConnection();
 
   // Calls that CLIENT can make

-  bool Execute(wxChar *data, int size = -1,
-               wxIPCFormat format = wxIPC_TEXT);
-  char *Request(const wxString& item, int *size = NULL,
-                wxIPCFormat format = wxIPC_TEXT);
-  bool Poke(const wxString& item, wxChar *data, int size = -1,
-            wxIPCFormat format = wxIPC_TEXT);
-  bool StartAdvise(const wxString& item);
-  bool StopAdvise(const wxString& item);
+  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);

 
   // Calls that SERVER can make
 
   // Calls that SERVER can make

-  bool Advise(const wxString& item, wxChar *data, int size = -1,
-              wxIPCFormat format = wxIPC_TEXT);
+  virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);

 
   // Calls that both can make
 
   // Calls that both can make

-  bool Disconnect();
+  virtual bool Disconnect(void);

 
 

-  // Called when we lost the peer.
-  bool OnDisconnect() { return TRUE; }
+  // 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
+  // To enable the compressor (NOTE: not implemented!)

   void Compress(bool on);
   void Compress(bool on);

+
+protected:
+  wxSocketBase       *m_sock;
+  wxSocketStream     *m_sockstrm;
+  wxDataInputStream  *m_codeci;
+  wxDataOutputStream *m_codeco;
+  wxString            m_topic;
+
+  friend class wxTCPServer;
+  friend class wxTCPClient;
+  friend class wxTCPEventHandler;
+
+private:
+  //
+  // We're hiding an Execute method in ConnectionBase
+  //
+  virtual bool Execute(const wxString& str)
+    { return Execute(str, -1, wxIPC_TEXT); }
+
+    DECLARE_NO_COPY_CLASS(wxTCPConnection)

 };
 
 class wxTCPServer: public wxServerBase
 };
 
 class wxTCPServer: public wxServerBase


@@ -105,29 +115,43 @@ public:
 
   wxTCPServer();
   virtual ~wxTCPServer();
 
   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);
+
+  // Callbacks to SERVER - override at will

   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__
+
+    DECLARE_NO_COPY_CLASS(wxTCPServer)

 };
 
 class wxTCPClient: public wxClientBase
 {
   DECLARE_DYNAMIC_CLASS(wxTCPClient)
 
 };
 
 class wxTCPClient: public wxClientBase
 {
   DECLARE_DYNAMIC_CLASS(wxTCPClient)
 

-public: 
+public:

   wxTCPClient();
   virtual ~wxTCPClient();
 
   virtual bool ValidHost(const wxString& host);
   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);
   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();
 };
 
   virtual wxConnectionBase *OnMakeConnection();
 };
 

-#endif // ipcsock.h
+#endif // wxUSE_SOCKETS && wxUSE_IPC
+
+#endif // _WX_SCKIPC_H