added wxSemaphore (with docs), new version of wxCondition and bug fixes to wxThread...

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

diff --git a/include/wx/ipcbase.h b/include/wx/ipcbase.h
index e2b849b7a12255954f4d1ec154ea6bb57f562f3e..6d3e80562cd165a4ec6fd742a86dbed7970fad70 100644 (file)
--- a/include/wx/ipcbase.h
+++ b/include/wx/ipcbase.h
@@ -42,19 +42,20 @@ enum wxIPCFormat
   wxIPC_PRIVATE =          20
 };
 
-class WXDLLEXPORT wxDDEServerBase;
-class WXDLLEXPORT wxDDEClientBase;
+class WXDLLEXPORT wxServerBase;
+class WXDLLEXPORT wxClientBase;
 
 class WXDLLEXPORT wxConnectionBase: public wxObject
 {
   DECLARE_CLASS(wxConnectionBase)
- public:
+
+public:
   inline wxConnectionBase(void) {}
   inline ~wxConnectionBase(void) {}
 
   // Calls that CLIENT can make
-  virtual bool Execute(wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT ) = 0;
-  virtual bool Execute(const wxString& str) { return Execute(WXSTRINGCAST str, -1, wxIPC_TEXT); }
+  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 bool Poke(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT) = 0;
   virtual bool StartAdvise(const wxString& item) = 0;
@@ -67,23 +68,42 @@ class WXDLLEXPORT wxConnectionBase: public wxObject
   virtual bool Disconnect(void) = 0;
 
   // Callbacks to SERVER - override at will
-  virtual bool OnExecute( const wxString& WXUNUSED(topic), char *WXUNUSED(data), int WXUNUSED(size), 
-                          int WXUNUSED(format) ) { return FALSE; };
-  virtual wxChar *OnRequest( const wxString& WXUNUSED(topic), const wxString& WXUNUSED(item), 
-                            int *WXUNUSED(size), int WXUNUSED(format) ) { return (wxChar *) NULL; };
-  virtual bool OnPoke( const wxString& WXUNUSED(topic), const wxString& WXUNUSED(item), wxChar *WXUNUSED(data), 
-                      int WXUNUSED(size), int WXUNUSED(format) ) { return FALSE; };
-  virtual bool OnStartAdvise( const wxString& WXUNUSED(topic), const wxString& WXUNUSED(item) ) 
-                              { return FALSE; };
-  virtual bool OnStopAdvise( const wxString& WXUNUSED(topic), const wxString& WXUNUSED(item) ) 
+  virtual bool OnExecute     ( const wxString& WXUNUSED(topic),
+                               char *WXUNUSED(data),
+                               int WXUNUSED(size),
+                               wxIPCFormat WXUNUSED(format) )
                              { return FALSE; };
 
-  // Callbacks to CLIENT - override at will
-  virtual bool OnAdvise( const wxString& WXUNUSED(topic), const wxString& WXUNUSED(item), wxChar *WXUNUSED(data), 
-                        int WXUNUSED(size), int WXUNUSED(format) ) { return FALSE; };
+  virtual char *OnRequest    ( const wxString& WXUNUSED(topic),
+                               const wxString& WXUNUSED(item),
+                               int *WXUNUSED(size),
+                               wxIPCFormat WXUNUSED(format) )
+                             { return (char *) NULL; };
+
+  virtual bool OnPoke        ( const wxString& WXUNUSED(topic),
+                               const wxString& WXUNUSED(item),
+                               wxChar *WXUNUSED(data),
+                               int WXUNUSED(size),
+                               wxIPCFormat WXUNUSED(format) )
+                             { return FALSE; };
+
+  virtual bool OnStartAdvise ( const wxString& WXUNUSED(topic),
+                               const wxString& WXUNUSED(item) )
+                             { return FALSE; };
 
-  // Callbacks to BOTH
+  virtual bool OnStopAdvise  ( const wxString& WXUNUSED(topic),
+                               const wxString& WXUNUSED(item) )
+                             { return FALSE; };
+
+  // Callbacks to CLIENT - override at will
+  virtual bool OnAdvise      ( const wxString& WXUNUSED(topic),
+                               const wxString& WXUNUSED(item),
+                               char *WXUNUSED(data),
+                               int WXUNUSED(size),
+                               wxIPCFormat WXUNUSED(format) )
+                             { return FALSE; };
 
+  // Callbacks to BOTH - override at will
   // Default behaviour is to delete connection and return TRUE
   virtual bool OnDisconnect(void) = 0;
 };
@@ -91,28 +111,35 @@ class WXDLLEXPORT wxConnectionBase: public wxObject
 class WXDLLEXPORT 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;
 
+  // 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
 {
   DECLARE_CLASS(wxClientBase)
- public:
+
+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