include/wx/sckipc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        sckipc.h
   3 // Purpose:     Interprocess communication implementation (wxSocket version)
   4 // Author:      Julian Smart
   5 // Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998
   6 //              Guillermo Rodriguez (updated for wxSocket v2) Jan 2000
   7 //                                  (callbacks deprecated)    Mar 2000
   8 // Created:     1993
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) Julian Smart 1993
  11 //              (c) Guilhem Lavaux 1997, 1998
  12 //              (c) 2000 Guillermo Rodriguez <guille@iies.es>
  13 // Licence:     wxWindows licence
  14 /////////////////////////////////////////////////////////////////////////////
  15
  16 #ifndef _WX_SCKIPC_H
  17 #define _WX_SCKIPC_H
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_SOCKETS && wxUSE_IPC
  22
  23 #include "wx/ipcbase.h"
  24 #include "wx/socket.h"
  25 #include "wx/sckstrm.h"
  26 #include "wx/datstrm.h"
  27
  28 /*
  29  * Mini-DDE implementation
  30
  31    Most transactions involve a topic name and an item name (choose these
  32    as befits your application).
  33
  34    A client can:
  35
  36    - ask the server to execute commands (data) associated with a topic
  37    - request data from server by topic and item
  38    - poke data into the server
  39    - ask the server to start an advice loop on topic/item
  40    - ask the server to stop an advice loop
  41
  42    A server can:
  43
  44    - respond to execute, request, poke and advice start/stop
  45    - send advise data to client
  46
  47    Note that this limits the server in the ways it can send data to the
  48    client, i.e. it can't send unsolicited information.
  49  *
  50  */
  51
  52 class WXDLLIMPEXP_FWD_NET wxTCPServer;
  53 class WXDLLIMPEXP_FWD_NET wxTCPClient;
  54
  55 class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
  56 {
  57 public:
  58   wxTCPConnection(void *buffer, size_t size);
  59   wxTCPConnection();
  60   virtual ~wxTCPConnection();
  61
  62   // To enable the compressor (NOTE: not implemented!)
  63   void Compress(bool on);
  64
  65
  66   // implement base class pure virtual methods
  67   virtual const void *Request(const wxString& item,
  68                               size_t *size = NULL,
  69                               wxIPCFormat format = wxIPC_TEXT);
  70   virtual bool StartAdvise(const wxString& item);
  71   virtual bool StopAdvise(const wxString& item);
  72   virtual bool Disconnect(void);
  73
  74 protected:
  75   virtual bool DoExecute(const void *data, size_t size, wxIPCFormat format);
  76   virtual bool DoPoke(const wxString& item, const void *data, size_t size,
  77                       wxIPCFormat format);
  78   virtual bool DoAdvise(const wxString& item, const void *data, size_t size,
  79                         wxIPCFormat format);
  80
  81
  82   wxSocketBase       *m_sock;
  83   wxSocketStream     *m_sockstrm;
  84   wxDataInputStream  *m_codeci;
  85   wxDataOutputStream *m_codeco;
  86   wxString            m_topic;
  87
  88   friend class wxTCPServer;
  89   friend class wxTCPClient;
  90   friend class wxTCPEventHandler;
  91
  92   DECLARE_NO_COPY_CLASS(wxTCPConnection)
  93   DECLARE_DYNAMIC_CLASS(wxTCPConnection)
  94 };
  95
  96 class WXDLLIMPEXP_NET wxTCPServer : public wxServerBase
  97 {
  98 public:
  99   wxTCPServer();
 100   virtual ~wxTCPServer();
 101
 102   // Returns false on error (e.g. port number is already in use)
 103   virtual bool Create(const wxString& serverName);
 104
 105   virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
 106
 107   wxTCPConnection *topLevelConnection;
 108
 109 protected:
 110   wxSocketServer *m_server;
 111
 112 #ifdef __UNIX_LIKE__
 113   // the name of the file associated to the Unix domain socket, may be empty
 114   wxString m_filename;
 115 #endif // __UNIX_LIKE__
 116
 117   DECLARE_NO_COPY_CLASS(wxTCPServer)
 118   DECLARE_DYNAMIC_CLASS(wxTCPServer)
 119 };
 120
 121 class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase
 122 {
 123 public:
 124   wxTCPClient();
 125   virtual ~wxTCPClient();
 126
 127   virtual bool ValidHost(const wxString& host);
 128
 129   // Call this to make a connection. Returns NULL if cannot.
 130   virtual wxConnectionBase *MakeConnection(const wxString& host,
 131                                            const wxString& server,
 132                                            const wxString& topic);
 133
 134   // Callbacks to CLIENT - override at will
 135   virtual wxConnectionBase *OnMakeConnection();
 136
 137 private:
 138   DECLARE_DYNAMIC_CLASS(wxTCPClient)
 139 };
 140
 141 #endif // wxUSE_SOCKETS && wxUSE_IPC
 142
 143 #endif // _WX_SCKIPC_H