]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/sckipc.h
make wxTmemchr() return (and take) char* instead of void* in ANSI build too
[wxWidgets.git] / include / wx / sckipc.h
index 9536891b3863a2288212bde3af92799c3ce14aac..e4b4064a760b9eb9dab8e8643cd1151ff6a67456 100644 (file)
@@ -4,23 +4,22 @@
 // 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>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_SCKIPC_H
 #define _WX_SCKIPC_H
 
-#ifdef __GNUG__
-#pragma interface "sckipc.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"
  *
  */
 
-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)
+
 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);
-  virtual char *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 wxChar *Request(const wxString& item, int *size = NULL, wxIPCFormat format = wxIPC_TEXT);
+  virtual bool Poke(const wxString& item, const 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
-  virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
+  virtual bool Advise(const wxString& item, const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
 
   // Calls that both can make
   virtual bool Disconnect(void);
 
-  // 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);
 
+  // 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:
-  wxSocketBase *m_sock;
-  wxSocketStream *m_sockstrm;
-  wxDataInputStream *m_codeci;
+  wxSocketBase       *m_sock;
+  wxSocketStream     *m_sockstrm;
+  wxDataInputStream  *m_codeci;
   wxDataOutputStream *m_codeco;
-  wxString m_topic;
+  wxString            m_topic;
 
   friend class wxTCPServer;
   friend class wxTCPClient;
-  friend void Client_OnRequest(wxSocketBase&,
-                               wxSocketNotify, char *);
-  friend void Server_OnRequest(wxSocketServer&,
-                               wxSocketNotify, char *);
+  friend class wxTCPEventHandler;
 
-private:
-  //
-  // We're hiding an Execute method in ConnectionBase
-  //s
-  virtual bool Execute(const wxString& str)
-  { return Execute(str, -1, wxIPC_TEXT); }
+  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();
 
-  // 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);
+
+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);
-  // 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);
 
-  // Tailor this to return own connection.
+  // 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