synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/sckipc.h b/include/wx/sckipc.h
index 4d4164cd8c9e2762d1dc3d43c86f4b1dff8aa193..d446cc47009f09cc12d145c8ff257331fbd05c77 100644 (file)
--- a/include/wx/sckipc.h
+++ b/include/wx/sckipc.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        sckipc.h
+// Name:        wx/sckipc.h

 // Purpose:     Interprocess communication implementation (wxSocket version)
 // Author:      Julian Smart
 // Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998
 // Purpose:     Interprocess communication implementation (wxSocket version)
 // Author:      Julian Smart
 // Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998


@@ -52,90 +52,107 @@
 class WXDLLIMPEXP_FWD_NET wxTCPServer;
 class WXDLLIMPEXP_FWD_NET wxTCPClient;
 
 class WXDLLIMPEXP_FWD_NET wxTCPServer;
 class WXDLLIMPEXP_FWD_NET wxTCPClient;
 

+class wxIPCSocketStreams;
+

 class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
 {
 public:
 class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
 {
 public:

-  wxTCPConnection(void *buffer, size_t size);
-  wxTCPConnection();
-  virtual ~wxTCPConnection();
+    wxTCPConnection() { Init(); }
+    wxTCPConnection(void *buffer, size_t size)
+        : wxConnectionBase(buffer, size)
+    {
+        Init();
+    }
+
+    virtual ~wxTCPConnection();

 
 

-  // To enable the compressor (NOTE: not implemented!)
-  void Compress(bool on);
+    // implement base class pure virtual methods
+    virtual const void *Request(const wxString& item,
+                                size_t *size = NULL,
+                                wxIPCFormat format = wxIPC_TEXT);
+    virtual bool StartAdvise(const wxString& item);
+    virtual bool StopAdvise(const wxString& item);
+    virtual bool Disconnect(void);

 
 

+    // Will be used in the future to enable the compression but does nothing
+    // for now.
+    void Compress(bool on);

 
 

-  // implement base class pure virtual methods
-  virtual const void *Request(const wxString& item,
-                              size_t *size = NULL,
-                              wxIPCFormat format = wxIPC_TEXT);
-  virtual bool StartAdvise(const wxString& item);
-  virtual bool StopAdvise(const wxString& item);
-  virtual bool Disconnect(void);

 
 protected:
 
 protected:

-  virtual bool DoExecute(const void *data, size_t size, wxIPCFormat format);
-  virtual bool DoPoke(const wxString& item, const void *data, size_t size,
-                      wxIPCFormat format);
-  virtual bool DoAdvise(const wxString& item, const void *data, size_t size,
+    virtual bool DoExecute(const void *data, size_t size, wxIPCFormat format);
+    virtual bool DoPoke(const wxString& item, const void *data, size_t size,

                         wxIPCFormat format);
                         wxIPCFormat format);

+    virtual bool DoAdvise(const wxString& item, const void *data, size_t size,
+                          wxIPCFormat format);
+
+
+    // notice that all the members below are only initialized once the
+    // connection is made, i.e. in MakeConnection() for the client objects and
+    // after OnAcceptConnection() in the server ones

 
 

+    // the underlying socket (wxSocketClient for IPC client and wxSocketServer
+    // for IPC server)
+    wxSocketBase *m_sock;

 
 

-  wxSocketBase       *m_sock;
-  wxSocketStream     *m_sockstrm;
-  wxDataInputStream  *m_codeci;
-  wxDataOutputStream *m_codeco;
-  wxString            m_topic;
+    // various streams that we use
+    wxIPCSocketStreams *m_streams;

 
 

-  friend class wxTCPServer;
-  friend class wxTCPClient;
-  friend class wxTCPEventHandler;
+    // the topic of this connection
+    wxString m_topic;

 
 

-  DECLARE_NO_COPY_CLASS(wxTCPConnection)
-  DECLARE_DYNAMIC_CLASS(wxTCPConnection)
+private:
+    // common part of both ctors
+    void Init();
+
+    friend class wxTCPServer;
+    friend class wxTCPClient;
+    friend class wxTCPEventHandler;
+
+    wxDECLARE_NO_COPY_CLASS(wxTCPConnection);
+    DECLARE_DYNAMIC_CLASS(wxTCPConnection)

 };
 
 class WXDLLIMPEXP_NET wxTCPServer : public wxServerBase
 {
 public:
 };
 
 class WXDLLIMPEXP_NET wxTCPServer : public wxServerBase
 {
 public:

-  wxTCPServer();
-  virtual ~wxTCPServer();
-
-  // Returns false on error (e.g. port number is already in use)
-  virtual bool Create(const wxString& serverName);
+    wxTCPServer();
+    virtual ~wxTCPServer();

 
 

-  virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
+    // Returns false on error (e.g. port number is already in use)
+    virtual bool Create(const wxString& serverName);

 
 

-  wxTCPConnection *topLevelConnection;
+    virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);

 
 protected:
 
 protected:

-  wxSocketServer *m_server;
+    wxSocketServer *m_server;

 
 #ifdef __UNIX_LIKE__
 
 #ifdef __UNIX_LIKE__

-  // the name of the file associated to the Unix domain socket, may be empty
-  wxString m_filename;
+    // the name of the file associated to the Unix domain socket, may be empty
+    wxString m_filename;

 #endif // __UNIX_LIKE__
 
 #endif // __UNIX_LIKE__
 

-  DECLARE_NO_COPY_CLASS(wxTCPServer)
-  DECLARE_DYNAMIC_CLASS(wxTCPServer)
+    wxDECLARE_NO_COPY_CLASS(wxTCPServer);
+    DECLARE_DYNAMIC_CLASS(wxTCPServer)

 };
 
 class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase
 {
 public:
 };
 
 class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase
 {
 public:

-  wxTCPClient();
-  virtual ~wxTCPClient();
+    wxTCPClient();

 
 

-  virtual bool ValidHost(const wxString& host);
+    virtual bool ValidHost(const wxString& host);

 
 

-  // Call this to make a connection. Returns NULL if cannot.
-  virtual wxConnectionBase *MakeConnection(const wxString& host,
-                                           const wxString& server,
-                                           const wxString& topic);
+    // Call this to make a connection. Returns NULL if cannot.
+    virtual wxConnectionBase *MakeConnection(const wxString& host,
+                                             const wxString& server,
+                                             const wxString& topic);

 
 

-  // Callbacks to CLIENT - override at will
-  virtual wxConnectionBase *OnMakeConnection();
+    // Callbacks to CLIENT - override at will
+    virtual wxConnectionBase *OnMakeConnection();

 
 private:
 
 private:

-  DECLARE_DYNAMIC_CLASS(wxTCPClient)
+    DECLARE_DYNAMIC_CLASS(wxTCPClient)

 };
 
 #endif // wxUSE_SOCKETS && wxUSE_IPC
 };
 
 #endif // wxUSE_SOCKETS && wxUSE_IPC