xplUDP Class Reference

#include <xplUDP.h>

Inherits xplComms.

List of all members.

---

Detailed Description

xPL communications over a LAN or the Internet.

This class enables xPL messages to be sent and recieved over a LAN or Internet connection.

The only method of any real interest to the xPL developer will be xplUDP::Create. The Destroy method is implemented in the base class, xplComms. All the other public methods exist to enable other xPL classes to carry out their work, and should not need to be called directly by the application.

Public Member Functions
bool	IsLocalIP (uint32 const _ip) const
	Checks an IP address to see if it is local.
void	SetTxPort (uint16 _port)
	Sets the port used for sending messages.
void	SetTxAddr (uint32 _addr)
	Sets the ip address used as the message destination.
string	GetHeartbeatIP () const
	Gets the local IP address that is used in xPL heartbeat messages.
virtual bool	TxMsg (xplMsg *_pMsg)
	Sends an xPL message.
virtual xplMsg *	RxMsg (HANDLE _hInterrupt=INVALID_HANDLE_VALUE, uint32 _timeout=0)
	Receive an xPL message.
virtual void	SendHeartbeat (string const &_source, uint32 const _interval, string const &_version)
	Sends an xPL heartbeat message.
Static Public Member Functions
static xplUDP *	Create (bool const _bViaHub=true)
	Creates a UDP communications object.
static void	Destroy (xplComms *_pComms)
	Destroys an xplComms object.
Protected Member Functions
	xplUDP (bool const _bViaHub)
	Constructor.
virtual	~xplUDP ()
	Destructor.
virtual void	SendConfigHeartbeat (string const &_source, uint32 const _interval, string const &_version)
	Sends an xPL config heartbeat message.
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

---