adding missing defaults

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

diff --git a/include/wx/sckipc.h b/include/wx/sckipc.h
index 939283e94040a8f6af7c118e00e02228579f203d..a131e2b1fdf4f896930b2af5fd5dd6248b3d6bf4 100644 (file)
--- a/include/wx/sckipc.h
+++ b/include/wx/sckipc.h
@@ -4,23 +4,22 @@
 // Author:      Julian Smart
 // Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998
 //              Guillermo Rodriguez (updated for wxSocket v2) Jan 2000
 // 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) Julian Smart 1993
 //              (c) Guilhem Lavaux 1997, 1998
 //              (c) 2000 Guillermo Rodriguez <guille@iies.es>
 // Created:     1993
 // RCS-ID:      $Id$
 // 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
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_SCKIPC_H
 #define _WX_SCKIPC_H
 

-#ifdef __GNUG__
-#pragma interface "sckipc.h"
-#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"


@@ -50,21 +49,21 @@
  *
  */
 
  *
  */
 

-class WXDLLEXPORT wxTCPServer;
-class WXDLLEXPORT wxTCPClient;
+class WXDLLIMPEXP_FWD_NET wxTCPServer;
+class WXDLLIMPEXP_FWD_NET wxTCPClient;

 
 

-class WXDLLEXPORT wxTCPConnection: public wxConnectionBase
+class WXDLLIMPEXP_NET wxTCPConnection: public wxConnectionBase

 {
   DECLARE_DYNAMIC_CLASS(wxTCPConnection)
 {
   DECLARE_DYNAMIC_CLASS(wxTCPConnection)

+

 public:
 public:

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

   wxTCPConnection();
   virtual ~wxTCPConnection();
 
   // Calls that CLIENT can make
   virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
   wxTCPConnection();
   virtual ~wxTCPConnection();
 
   // Calls that CLIENT can make
   virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);

-  virtual bool Execute(const wxString& str) { return Execute(str, -1, wxIPC_TEXT); }
-  virtual char *Request(const wxString& item, int *size = NULL, 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 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);


@@ -75,79 +74,79 @@ public:
   // Calls that both can make
   virtual bool Disconnect(void);
 
   // Calls that both can make
   virtual bool Disconnect(void);
 

-  // Callbacks to SERVER - override at will
-  virtual bool OnExecute(const wxString& topic, char *data, int size, wxIPCFormat format)
-    { return wxConnectionBase::OnExecute(topic, data, size, format); };
-  virtual char *OnRequest(const wxString& topic, const wxString& item, int *size, wxIPCFormat format)
-    { return wxConnectionBase::OnRequest(topic, item, size, format); };
-  virtual bool OnPoke(const wxString& topic, const wxString& item, char *data, int size, wxIPCFormat format)
-    { return wxConnectionBase::OnPoke(topic, item, data, size, format); };
-  virtual bool OnStartAdvise(const wxString& topic, const wxString& item)
-    { return wxConnectionBase::OnStartAdvise(topic, item); };
-  virtual bool OnStopAdvise(const wxString& topic, const wxString& item)
-    { return wxConnectionBase::OnStopAdvise(topic, item); };
-
-  // Callbacks to CLIENT - override at will
-  virtual bool OnAdvise(const wxString& topic, const wxString& item, char *data, int size, wxIPCFormat format)
-    { return wxConnectionBase::OnAdvise(topic, item, data, size, format); };
-
-  // Callbacks to BOTH
-
-  // Default behaviour is to delete connection and return TRUE
-  virtual bool OnDisconnect(void) { delete this; 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);
 

+  // unhide the Execute overload from wxConnectionBase
+  // FIXME-UTF8: change Execute() to DoExecute() to avoid having to do this;
+  //             don't use c_str() below after removing ANSI build
+  virtual bool Execute(const wxString& str)
+    { return Execute(str.c_str(), -1, wxIPC_TEXT); }
+

 protected:
 protected:

-  wxSocketBase *m_sock;
-  wxSocketStream *m_sockstrm;
-  wxDataInputStream *m_codeci;
+  wxSocketBase       *m_sock;
+  wxSocketStream     *m_sockstrm;
+  wxDataInputStream  *m_codeci;

   wxDataOutputStream *m_codeco;
   wxDataOutputStream *m_codeco;

-  wxString m_topic;
+  wxString            m_topic;

 
   friend class wxTCPServer;
   friend class wxTCPClient;
 
   friend class wxTCPServer;
   friend class wxTCPClient;

-  friend void Client_OnRequest(wxSocketBase&,
-                               wxSocketNotify, char *);
-  friend void Server_OnRequest(wxSocketServer&,
-                               wxSocketNotify, char *);
+  friend class wxTCPEventHandler;

 
 

-private:
+  DECLARE_NO_COPY_CLASS(wxTCPConnection)

 };
 
 };
 

-class wxTCPServer: public wxServerBase
+class WXDLLIMPEXP_NET wxTCPServer: public wxServerBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxTCPServer)
-

 public:
   wxTCPConnection *topLevelConnection;
 
   wxTCPServer();
   virtual ~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);
+
+  // 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)
+  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);
 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);
 
   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();

+
+private:
+  DECLARE_DYNAMIC_CLASS(wxTCPClient)

 };
 
 };
 

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