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 license
  14 /////////////////////////////////////////////////////////////////////////////
  15
  16 #ifndef _WX_SCKIPC_H
  17 #define _WX_SCKIPC_H
  18
  19 #if defined(__GNUG__) && !defined(__APPLE__)
  20 #pragma interface "sckipc.h"
  21 #endif
  22
  23 #include "wx/defs.h"
  24
  25 #if wxUSE_SOCKETS && wxUSE_IPC
  26
  27 #include "wx/ipcbase.h"
  28 #include "wx/socket.h"
  29 #include "wx/sckstrm.h"
  30 #include "wx/datstrm.h"
  31
  32 /*
  33  * Mini-DDE implementation
  34
  35    Most transactions involve a topic name and an item name (choose these
  36    as befits your application).
  37
  38    A client can:
  39
  40    - ask the server to execute commands (data) associated with a topic
  41    - request data from server by topic and item
  42    - poke data into the server
  43    - ask the server to start an advice loop on topic/item
  44    - ask the server to stop an advice loop
  45
  46    A server can:
  47
  48    - respond to execute, request, poke and advice start/stop
  49    - send advise data to client
  50
  51    Note that this limits the server in the ways it can send data to the
  52    client, i.e. it can't send unsolicited information.
  53  *
  54  */
  55
  56 class WXDLLEXPORT wxTCPServer;
  57 class WXDLLEXPORT wxTCPClient;
  58
  59 class WXDLLEXPORT wxTCPConnection: public wxConnectionBase
  60 {
  61   DECLARE_DYNAMIC_CLASS(wxTCPConnection)
  62
  63 public:
  64   wxTCPConnection(wxChar *buffer, int size);
  65   wxTCPConnection();
  66   virtual ~wxTCPConnection();
  67
  68   // Calls that CLIENT can make
  69   virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
  70   virtual wxChar *Request(const wxString& item, int *size = NULL, wxIPCFormat format = wxIPC_TEXT);
  71   virtual bool Poke(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
  72   virtual bool StartAdvise(const wxString& item);
  73   virtual bool StopAdvise(const wxString& item);
  74
  75   // Calls that SERVER can make
  76   virtual bool Advise(const wxString& item, wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
  77
  78   // Calls that both can make
  79   virtual bool Disconnect(void);
  80
  81   // Callbacks to BOTH - override at will
  82   // Default behaviour is to delete connection and return TRUE
  83   virtual bool OnDisconnect(void) { delete this; return TRUE; }
  84
  85   // To enable the compressor (NOTE: not implemented!)
  86   void Compress(bool on);
  87
  88 protected:
  89   wxSocketBase       *m_sock;
  90   wxSocketStream     *m_sockstrm;
  91   wxDataInputStream  *m_codeci;
  92   wxDataOutputStream *m_codeco;
  93   wxString            m_topic;
  94
  95   friend class wxTCPServer;
  96   friend class wxTCPClient;
  97   friend class wxTCPEventHandler;
  98
  99 private:
 100   //
 101   // We're hiding an Execute method in ConnectionBase
 102   //
 103   virtual bool Execute(const wxString& str)
 104     { return Execute(str, -1, wxIPC_TEXT); }
 105 };
 106
 107 class wxTCPServer: public wxServerBase
 108 {
 109   DECLARE_DYNAMIC_CLASS(wxTCPServer)
 110
 111 public:
 112   wxTCPConnection *topLevelConnection;
 113
 114   wxTCPServer();
 115   virtual ~wxTCPServer();
 116
 117   // Returns FALSE on error (e.g. port number is already in use)
 118   virtual bool Create(const wxString& serverName);
 119
 120   // Callbacks to SERVER - override at will
 121   virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
 122
 123 protected:
 124   wxSocketServer *m_server;
 125
 126 #ifdef __UNIX_LIKE__
 127   // the name of the file associated to the Unix domain socket, may be empty
 128   wxString m_filename;
 129 #endif // __UNIX_LIKE__
 130 };
 131
 132 class wxTCPClient: public wxClientBase
 133 {
 134   DECLARE_DYNAMIC_CLASS(wxTCPClient)
 135
 136 public:
 137   wxTCPClient();
 138   virtual ~wxTCPClient();
 139
 140   virtual bool ValidHost(const wxString& host);
 141
 142   // Call this to make a connection. Returns NULL if cannot.
 143   virtual wxConnectionBase *MakeConnection(const wxString& host,
 144                                            const wxString& server,
 145                                            const wxString& topic);
 146
 147   // Callbacks to CLIENT - override at will
 148   virtual wxConnectionBase *OnMakeConnection();
 149 };
 150
 151 #endif // wxUSE_SOCKETS && wxUSE_IPC
 152
 153 #endif // _WX_SCKIPC_H