145 lines
4.5 KiB
C++
145 lines
4.5 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: dde.h
|
|
// Purpose: DDE class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// RCS-ID: $Id: dde.h 53135 2008-04-12 02:31:04Z VZ $
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_DDE_H_
|
|
#define _WX_DDE_H_
|
|
|
|
#include "wx/ipcbase.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.
|
|
*
|
|
*/
|
|
|
|
class WXDLLIMPEXP_FWD_BASE wxDDEServer;
|
|
class WXDLLIMPEXP_FWD_BASE wxDDEClient;
|
|
|
|
class WXDLLIMPEXP_BASE wxDDEConnection: public wxConnectionBase
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxDDEConnection)
|
|
public:
|
|
wxDDEConnection(wxChar *buffer, int size); // use external buffer
|
|
wxDDEConnection(); // use internal buffer
|
|
virtual ~wxDDEConnection(void);
|
|
|
|
// Calls that CLIENT can make
|
|
virtual bool Execute(const wxChar *data, int size = -1, wxIPCFormat format = wxIPC_TEXT);
|
|
virtual bool Execute(const wxString& str) { return Execute(str, -1, wxIPC_TEXT); }
|
|
virtual wxChar *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 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);
|
|
|
|
// Calls that both can make
|
|
virtual bool Disconnect(void);
|
|
|
|
// Default behaviour is to delete connection and return true
|
|
virtual bool OnDisconnect(void);
|
|
|
|
public:
|
|
wxString m_topicName;
|
|
wxDDEServer* m_server;
|
|
wxDDEClient* m_client;
|
|
|
|
WXHCONV m_hConv;
|
|
wxChar* m_sendingData;
|
|
int m_dataSize;
|
|
wxIPCFormat m_dataType;
|
|
|
|
DECLARE_NO_COPY_CLASS(wxDDEConnection)
|
|
};
|
|
|
|
class WXDLLIMPEXP_BASE wxDDEServer: public wxServerBase
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxDDEServer)
|
|
public:
|
|
|
|
wxDDEServer(void);
|
|
virtual ~wxDDEServer(void);
|
|
bool Create(const wxString& server_name); // Returns false if can't create server (e.g. port
|
|
// number is already in use)
|
|
virtual wxConnectionBase *OnAcceptConnection(const wxString& topic);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Implementation
|
|
|
|
// Find/delete wxDDEConnection corresponding to the HCONV
|
|
wxDDEConnection *FindConnection(WXHCONV conv);
|
|
bool DeleteConnection(WXHCONV conv);
|
|
inline wxString& GetServiceName(void) const { return (wxString&) m_serviceName; }
|
|
inline wxDDEConnectionList& GetConnections(void) const
|
|
{
|
|
return (wxDDEConnectionList&) m_connections;
|
|
}
|
|
|
|
protected:
|
|
int m_lastError;
|
|
wxString m_serviceName;
|
|
wxDDEConnectionList m_connections;
|
|
};
|
|
|
|
class WXDLLIMPEXP_BASE wxDDEClient: public wxClientBase
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxDDEClient)
|
|
public:
|
|
wxDDEClient(void);
|
|
virtual ~wxDDEClient(void);
|
|
bool ValidHost(const wxString& host);
|
|
virtual wxConnectionBase *MakeConnection(const wxString& host, const wxString& server, const wxString& topic);
|
|
// Call this to make a connection.
|
|
// Returns NULL if cannot.
|
|
virtual wxConnectionBase *OnMakeConnection(void); // Tailor this to return own connection.
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Implementation
|
|
|
|
// Find/delete wxDDEConnection corresponding to the HCONV
|
|
wxDDEConnection *FindConnection(WXHCONV conv);
|
|
bool DeleteConnection(WXHCONV conv);
|
|
|
|
inline wxDDEConnectionList& GetConnections(void) const
|
|
{
|
|
return (wxDDEConnectionList&) m_connections;
|
|
}
|
|
|
|
protected:
|
|
int m_lastError;
|
|
wxDDEConnectionList m_connections;
|
|
};
|
|
|
|
void WXDLLIMPEXP_BASE wxDDEInitialize();
|
|
void WXDLLIMPEXP_BASE wxDDECleanUp();
|
|
|
|
#endif
|
|
// _WX_DDE_H_
|