Fixed typo.

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

diff --git a/include/wx/ipcbase.h b/include/wx/ipcbase.h
index 178cb3b31f84c6cee890dcff5553d733368bca04..45f61b66f4e278a8cbf26b46426377422692dfe7 100644 (file)
--- a/include/wx/ipcbase.h
+++ b/include/wx/ipcbase.h
@@ -5,17 +5,13 @@
 // Modified by:
 // Created:     4/1/98
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_IPCBASEH__
 #define _WX_IPCBASEH__
 
-#ifdef __GNUG__
-#pragma interface "ipcbase.h"
-#endif
-
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
@@ -42,20 +38,26 @@ enum wxIPCFormat
   wxIPC_PRIVATE =          20
 };
 
-class WXDLLEXPORT wxServerBase;
-class WXDLLEXPORT wxClientBase;
+class WXDLLIMPEXP_BASE wxServerBase;
+class WXDLLIMPEXP_BASE wxClientBase;
 
-class WXDLLEXPORT wxConnectionBase: public wxObject
+class WXDLLIMPEXP_BASE wxConnectionBase: public wxObject
 {
   DECLARE_CLASS(wxConnectionBase)
- public:
-  inline wxConnectionBase(void) {}
-  inline ~wxConnectionBase(void) {}
+
+public:
+  wxConnectionBase(wxChar *buffer, int size); // use external buffer
+  wxConnectionBase(); // use internal, adaptive buffer
+  wxConnectionBase(const wxConnectionBase& copy);
+  virtual ~wxConnectionBase(void);
+
+  void SetConnected( bool c ) { m_connected = c; }
+  bool GetConnected() { return m_connected; }
 
   // Calls that CLIENT can make
   virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT ) = 0;
   virtual bool Execute(const wxString& str) { return Execute(str, -1, wxIPC_TEXT); }
-  virtual char *Request(const wxString& item, int *size = (int *) NULL, wxIPCFormat format = wxIPC_TEXT) = 0;
+  virtual wxChar *Request(const wxString& item, int *size = (int *) NULL, wxIPCFormat format = wxIPC_TEXT) = 0;
   virtual bool Poke(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT) = 0;
   virtual bool StartAdvise(const wxString& item) = 0;
   virtual bool StopAdvise(const wxString& item) = 0;
@@ -68,71 +70,93 @@ class WXDLLEXPORT wxConnectionBase: public wxObject
 
   // Callbacks to SERVER - override at will
   virtual bool OnExecute     ( const wxString& WXUNUSED(topic),
-                               char *WXUNUSED(data),
+                               wxChar *WXUNUSED(data),
                                int WXUNUSED(size),
                                wxIPCFormat WXUNUSED(format) )
-                             { return FALSE; };
+                             { return false; };
 
-  virtual char *OnRequest    ( const wxString& WXUNUSED(topic),
+  virtual wxChar *OnRequest    ( const wxString& WXUNUSED(topic),
                                const wxString& WXUNUSED(item),
                                int *WXUNUSED(size),
                                wxIPCFormat WXUNUSED(format) )
-                             { return (char *) NULL; };
+                             { return (wxChar *) NULL; };
 
   virtual bool OnPoke        ( const wxString& WXUNUSED(topic),
                                const wxString& WXUNUSED(item),
                                wxChar *WXUNUSED(data),
                                int WXUNUSED(size),
                                wxIPCFormat WXUNUSED(format) )
-                             { return FALSE; };
+                             { return false; };
 
   virtual bool OnStartAdvise ( const wxString& WXUNUSED(topic),
                                const wxString& WXUNUSED(item) )
-                             { return FALSE; };
+                             { return false; };
 
   virtual bool OnStopAdvise  ( const wxString& WXUNUSED(topic),
                                const wxString& WXUNUSED(item) )
-                             { return FALSE; };
+                             { return false; };
 
   // Callbacks to CLIENT - override at will
   virtual bool OnAdvise      ( const wxString& WXUNUSED(topic),
                                const wxString& WXUNUSED(item),
-                               char *WXUNUSED(data),
+                               wxChar *WXUNUSED(data),
                                int WXUNUSED(size),
                                wxIPCFormat WXUNUSED(format) )
-                             { return FALSE; };
-
-  // Callbacks to BOTH
+                             { return false; };
 
-  // Default behaviour is to delete connection and return TRUE
+  // Callbacks to BOTH - override at will
+  // Default behaviour is to delete connection and return true
   virtual bool OnDisconnect(void) = 0;
+
+  // return a buffer at least this size, reallocating buffer if needed
+  // returns NULL if using an inadequate user buffer - it can't be resized
+  wxChar *      GetBufferAtLeast( size_t bytes );
+
+protected:
+  bool          m_connected;
+private:
+  wxChar *      m_buffer;
+  size_t        m_buffersize;
+  bool          m_deletebufferwhendone;
+
+  // can't use DECLARE_NO_COPY_CLASS(wxConnectionBase) because we already
+  // have copy ctor but still forbid the default assignment operator
+  wxConnectionBase& operator=(const wxConnectionBase&);
 };
 
-class WXDLLEXPORT wxServerBase: public wxObject
+
+class WXDLLIMPEXP_BASE wxServerBase: public wxObject
 {
   DECLARE_CLASS(wxServerBase)
- public:
 
+public:
   inline wxServerBase(void) {}
-  inline ~wxServerBase(void) {};
-  virtual bool Create(const wxString& serverName) = 0; // Returns FALSE if can't create server (e.g. port
-                                  // number is already in use)
-  virtual wxConnectionBase *OnAcceptConnection(const wxString& topic) = 0;
+  inline ~wxServerBase(void) {}
+
+  // Returns false on error (e.g. port number is already in use)
+  virtual bool Create(const wxString& serverName) = 0;
 
+  // Callbacks to SERVER - override at will
+  virtual wxConnectionBase *OnAcceptConnection(const wxString& topic) = 0;
 };
 
-class WXDLLEXPORT wxClientBase: public wxObject
+class WXDLLIMPEXP_BASE wxClientBase: public wxObject
 {
   DECLARE_CLASS(wxClientBase)
- public:
-  inline wxClientBase(void) {};
-  inline ~wxClientBase(void) {};
+
+public:
+  inline wxClientBase(void) {}
+  inline ~wxClientBase(void) {}
+
   virtual bool ValidHost(const wxString& host) = 0;
-  virtual wxConnectionBase *MakeConnection(const wxString& host, const wxString& server, const wxString& topic) = 0;
-                                                // Call this to make a connection.
-                                                // Returns NULL if cannot.
-  virtual wxConnectionBase *OnMakeConnection(void) = 0; // Tailor this to return own connection.
 
+  // Call this to make a connection. Returns NULL if cannot.
+  virtual wxConnectionBase *MakeConnection(const wxString& host,
+                                           const wxString& server,
+                                           const wxString& topic) = 0;
+
+  // Callbacks to CLIENT - override at will
+  virtual wxConnectionBase *OnMakeConnection(void) = 0;
 };
 
 #endif