xplComms Class Reference

#include <xplComms.h>

Inherited by xplUDP.

List of all members.

---

Detailed Description

Base class for communications objects.

Public Member Functions
virtual bool	TxMsg (xplMsg *_pMsg)=0
	Sends an xPL message.
virtual xplMsg *	RxMsg (HANDLE _hInterrupt=INVALID_HANDLE_VALUE, uint32 _timeout=0)=0
	Receive an xPL message.
virtual void	SendHeartbeat (string const &_source, uint32 const _interval, string const &_version)=0
	Sends an xPL heartbeat message.
virtual void	SendConfigHeartbeat (string const &_source, uint32 const _interval, string const &_version)=0
	Sends an xPL config heartbeat message.
Static Public Member Functions
static void	Destroy (xplComms *_pComms)
	Destroys an xplComms object.
Protected Member Functions
	xplComms ()
	Constructor.
virtual	~xplComms ()
	Destructor.
virtual bool	Connect ()
	Initialises the underlying communications objects.
virtual void	Disconnect ()
	Deletes the underlying communications objects.
bool	IsConnected () const
	Tests whether communications have been initialised.
Protected Attributes
int8 *	m_pMsgBuffer
Static Protected Attributes
static uint32 const	c_msgBufferSize

---