1998-09-06 14:28:00 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2011-03-19 20:14:35 -04:00
|
|
|
// Name: wx/sckipc.h
|
2000-01-05 20:07:06 -05:00
|
|
|
// Purpose: Interprocess communication implementation (wxSocket version)
|
|
|
|
// Author: Julian Smart
|
|
|
|
// Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998
|
|
|
|
// Guillermo Rodriguez (updated for wxSocket v2) Jan 2000
|
2000-03-10 00:30:53 -05:00
|
|
|
// (callbacks deprecated) Mar 2000
|
1998-09-06 14:28:00 -04:00
|
|
|
// Created: 1993
|
2000-01-05 20:07:06 -05:00
|
|
|
// Copyright: (c) Julian Smart 1993
|
|
|
|
// (c) Guilhem Lavaux 1997, 1998
|
|
|
|
// (c) 2000 Guillermo Rodriguez <guille@iies.es>
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
1998-09-06 14:28:00 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2000-01-06 11:57:30 -05:00
|
|
|
|
1998-09-06 14:28:00 -04:00
|
|
|
#ifndef _WX_SCKIPC_H
|
|
|
|
#define _WX_SCKIPC_H
|
|
|
|
|
|
|
|
#include "wx/defs.h"
|
2000-02-09 12:53:42 -05:00
|
|
|
|
2000-03-10 00:30:53 -05:00
|
|
|
#if wxUSE_SOCKETS && wxUSE_IPC
|
2000-02-09 12:53:42 -05:00
|
|
|
|
1998-09-06 14:28:00 -04:00
|
|
|
#include "wx/ipcbase.h"
|
|
|
|
#include "wx/socket.h"
|
|
|
|
#include "wx/sckstrm.h"
|
|
|
|
#include "wx/datstrm.h"
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Mini-DDE implementation
|
|
|
|
|
|
|
|
Most transactions involve a topic name and an item name (choose these
|
|
|
|
as befits your application).
|
|
|
|
|
|
|
|
A client can:
|
|
|
|
|
|
|
|
- ask the server to execute commands (data) associated with a topic
|
|
|
|
- request data from server by topic and item
|
|
|
|
- poke data into the server
|
|
|
|
- ask the server to start an advice loop on topic/item
|
|
|
|
- ask the server to stop an advice loop
|
|
|
|
|
|
|
|
A server can:
|
|
|
|
|
|
|
|
- respond to execute, request, poke and advice start/stop
|
|
|
|
- send advise data to client
|
|
|
|
|
|
|
|
Note that this limits the server in the ways it can send data to the
|
|
|
|
client, i.e. it can't send unsolicited information.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2007-07-09 06:09:52 -04:00
|
|
|
class WXDLLIMPEXP_FWD_NET wxTCPServer;
|
|
|
|
class WXDLLIMPEXP_FWD_NET wxTCPClient;
|
2000-01-06 11:57:30 -05:00
|
|
|
|
2008-10-29 12:45:55 -04:00
|
|
|
class wxIPCSocketStreams;
|
|
|
|
|
2007-10-20 18:54:26 -04:00
|
|
|
class WXDLLIMPEXP_NET wxTCPConnection : public wxConnectionBase
|
1998-09-06 14:28:00 -04:00
|
|
|
{
|
|
|
|
public:
|
2008-10-27 20:02:38 -04:00
|
|
|
wxTCPConnection() { Init(); }
|
|
|
|
wxTCPConnection(void *buffer, size_t size)
|
|
|
|
: wxConnectionBase(buffer, size)
|
|
|
|
{
|
|
|
|
Init();
|
|
|
|
}
|
1998-09-06 14:28:00 -04:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
virtual ~wxTCPConnection();
|
1998-09-06 14:28:00 -04:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
// implement base class pure virtual methods
|
|
|
|
virtual const void *Request(const wxString& item,
|
|
|
|
size_t *size = NULL,
|
2014-03-29 20:02:23 -04:00
|
|
|
wxIPCFormat format = wxIPC_TEXT) wxOVERRIDE;
|
|
|
|
virtual bool StartAdvise(const wxString& item) wxOVERRIDE;
|
|
|
|
virtual bool StopAdvise(const wxString& item) wxOVERRIDE;
|
|
|
|
virtual bool Disconnect(void) wxOVERRIDE;
|
2008-10-27 20:02:38 -04:00
|
|
|
|
|
|
|
// Will be used in the future to enable the compression but does nothing
|
|
|
|
// for now.
|
|
|
|
void Compress(bool on);
|
1998-09-06 14:28:00 -04:00
|
|
|
|
|
|
|
|
2007-10-20 18:54:26 -04:00
|
|
|
protected:
|
2014-03-29 20:02:23 -04:00
|
|
|
virtual bool DoExecute(const void *data, size_t size, wxIPCFormat format) wxOVERRIDE;
|
2008-10-27 20:02:38 -04:00
|
|
|
virtual bool DoPoke(const wxString& item, const void *data, size_t size,
|
2014-03-29 20:02:23 -04:00
|
|
|
wxIPCFormat format) wxOVERRIDE;
|
2008-10-27 20:02:38 -04:00
|
|
|
virtual bool DoAdvise(const wxString& item, const void *data, size_t size,
|
2014-03-29 20:02:23 -04:00
|
|
|
wxIPCFormat format) wxOVERRIDE;
|
2008-10-27 20:02:38 -04:00
|
|
|
|
2000-01-05 20:07:06 -05:00
|
|
|
|
2008-10-29 12:45:55 -04:00
|
|
|
// 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;
|
|
|
|
|
|
|
|
// various streams that we use
|
|
|
|
wxIPCSocketStreams *m_streams;
|
|
|
|
|
|
|
|
// the topic of this connection
|
|
|
|
wxString m_topic;
|
2005-11-15 13:05:48 -05:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
private:
|
|
|
|
// common part of both ctors
|
|
|
|
void Init();
|
2000-01-06 11:57:30 -05:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
friend class wxTCPServer;
|
|
|
|
friend class wxTCPClient;
|
|
|
|
friend class wxTCPEventHandler;
|
2000-01-06 11:57:30 -05:00
|
|
|
|
2009-02-08 06:45:59 -05:00
|
|
|
wxDECLARE_NO_COPY_CLASS(wxTCPConnection);
|
2015-04-23 07:49:01 -04:00
|
|
|
wxDECLARE_DYNAMIC_CLASS(wxTCPConnection);
|
1998-09-06 14:28:00 -04:00
|
|
|
};
|
|
|
|
|
2007-10-20 18:54:26 -04:00
|
|
|
class WXDLLIMPEXP_NET wxTCPServer : public wxServerBase
|
1998-09-06 14:28:00 -04:00
|
|
|
{
|
|
|
|
public:
|
2008-10-27 20:02:38 -04:00
|
|
|
wxTCPServer();
|
|
|
|
virtual ~wxTCPServer();
|
2000-07-15 15:51:35 -04:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
// Returns false on error (e.g. port number is already in use)
|
2014-03-29 20:02:23 -04:00
|
|
|
virtual bool Create(const wxString& serverName) wxOVERRIDE;
|
2000-07-15 15:51:35 -04:00
|
|
|
|
2014-03-29 20:02:23 -04:00
|
|
|
virtual wxConnectionBase *OnAcceptConnection(const wxString& topic) wxOVERRIDE;
|
2007-10-20 18:54:26 -04:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
protected:
|
2008-10-27 20:02:38 -04:00
|
|
|
wxSocketServer *m_server;
|
2002-04-12 11:13:53 -04:00
|
|
|
|
|
|
|
#ifdef __UNIX_LIKE__
|
2008-10-27 20:02:38 -04:00
|
|
|
// the name of the file associated to the Unix domain socket, may be empty
|
|
|
|
wxString m_filename;
|
2002-04-12 11:13:53 -04:00
|
|
|
#endif // __UNIX_LIKE__
|
2003-01-02 18:38:11 -05:00
|
|
|
|
2009-02-08 06:45:59 -05:00
|
|
|
wxDECLARE_NO_COPY_CLASS(wxTCPServer);
|
2015-04-23 07:49:01 -04:00
|
|
|
wxDECLARE_DYNAMIC_CLASS(wxTCPServer);
|
1998-09-06 14:28:00 -04:00
|
|
|
};
|
|
|
|
|
2007-10-20 18:54:26 -04:00
|
|
|
class WXDLLIMPEXP_NET wxTCPClient : public wxClientBase
|
1998-09-06 14:28:00 -04:00
|
|
|
{
|
1999-08-02 00:44:01 -04:00
|
|
|
public:
|
2008-10-27 20:02:38 -04:00
|
|
|
wxTCPClient();
|
1998-09-06 14:28:00 -04:00
|
|
|
|
2014-03-29 20:02:23 -04:00
|
|
|
virtual bool ValidHost(const wxString& host) wxOVERRIDE;
|
2000-07-15 15:51:35 -04:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
// Call this to make a connection. Returns NULL if cannot.
|
|
|
|
virtual wxConnectionBase *MakeConnection(const wxString& host,
|
|
|
|
const wxString& server,
|
2014-03-29 20:02:23 -04:00
|
|
|
const wxString& topic) wxOVERRIDE;
|
1999-08-02 00:44:01 -04:00
|
|
|
|
2008-10-27 20:02:38 -04:00
|
|
|
// Callbacks to CLIENT - override at will
|
2014-03-29 20:02:23 -04:00
|
|
|
virtual wxConnectionBase *OnMakeConnection() wxOVERRIDE;
|
2005-11-15 13:05:48 -05:00
|
|
|
|
|
|
|
private:
|
2015-04-23 07:49:01 -04:00
|
|
|
wxDECLARE_DYNAMIC_CLASS(wxTCPClient);
|
1998-09-06 14:28:00 -04:00
|
|
|
};
|
|
|
|
|
2000-03-10 00:30:53 -05:00
|
|
|
#endif // wxUSE_SOCKETS && wxUSE_IPC
|
2000-02-09 12:53:42 -05:00
|
|
|
|
2000-03-10 00:30:53 -05:00
|
|
|
#endif // _WX_SCKIPC_H
|