DtSignalMessageTransporter Class Reference

This class encapsulates the sending and receiving of DtVrfObjectMessages though signal interactions. Parameters used in the sending or received with the message are passed using the DtSignalMessageParams structure.

Public Types
typedef DtCallbackList < DtSignalMessageTransporterCallbackParams * >	DtMessageReceivedCallbackList

Public Member Functions
virtual	~DtSignalMessageTransporter ()
virtual bool	processVrfObjectMessageReceived (const DtSignalMessageParams &params, const char *pVrfObjectMessageBuffer)
virtual void	sendInteraction (const DtSignalMessageParams &params, int contentSize, const char *pContent)
virtual void	sendMessage (const DtSignalMessageParams &params, const DtVrfObjectMessage *message)
virtual void	processSignalInteraction (const makVrfEvents::DtVrfSignalEvent *inter)
bool	enabled () const
virtual void	setEnabled (bool bEnabled)
virtual void	addMessageReceivedCallback (DtMessageReceivedCallbackList::DtCallbackFunctionType fcn, void *usr)
virtual void	removeMessageReceivedCallback (DtMessageReceivedCallbackList::DtCallbackFunctionType fcn, void *usr)

Static Public Member Functions
static DtSignalMessageTransporter *	create (DtCommunicationManager *exConn)

Protected Member Functions
	DtSignalMessageTransporter (DtCommunicationManager *exConn)
virtual bool	init ()
virtual void	signalInteractionCallback (const makVrfEvents::DtEvent &)
virtual void	sendSignalInteraction (const makVrfEvents::DtVrfSignalEvent &signalInteraction)

Protected Attributes
bool	myEnabled
DtMessageReceivedCallbackList	myMessageReceivedCallbacks
DtCommunicationManager *	myCommunicationManager
boost::signals2::scoped_connection	mySignalForVrfSignalEventConnection
DtClock	myClock

Private Member Functions
	DtSignalMessageTransporter ()
	DtSignalMessageTransporter (const DtSignalMessageTransporter &orig)
DtSignalMessageTransporter &	operator= (const DtSignalMessageTransporter &orig)

Member Typedef Documentation

typedef DtCallbackList<DtSignalMessageTransporterCallbackParams*> DtSignalMessageTransporter::DtMessageReceivedCallbackList

Constructor & Destructor Documentation

DtSignalMessageTransporter::DtSignalMessageTransporter ( )

private

Not implemented.

DtSignalMessageTransporter::DtSignalMessageTransporter ( const DtSignalMessageTransporter &  orig )

private

Not implemented.

DtSignalMessageTransporter::DtSignalMessageTransporter ( DtCommunicationManager *  exConn )

protected

Call create() instead of the constructor.

virtual DtSignalMessageTransporter::~DtSignalMessageTransporter ( )

virtual

Member Function Documentation

DtSignalMessageTransporter& DtSignalMessageTransporter::operator= ( const DtSignalMessageTransporter &  orig )

private

Not implemented.

virtual bool DtSignalMessageTransporter::init ( )

protectedvirtual

Virtual init called from create().

static DtSignalMessageTransporter* DtSignalMessageTransporter::create ( DtCommunicationManager *  exConn )

static

Calls constructor and init() on the new instance before returning it. Caller is responsible for deleting returned instance.

bool DtSignalMessageTransporter::enabled ( ) const

inline

accessor/mutator for enabled state

References myEnabled.

virtual void DtSignalMessageTransporter::setEnabled ( bool  bEnabled )

virtual

accessor/mutator for enabled state

virtual bool DtSignalMessageTransporter::processVrfObjectMessageReceived ( const DtSignalMessageParams &  params, const char *  pVrfObjectMessageBuffer  )

virtual

virtual void DtSignalMessageTransporter::sendInteraction ( const DtSignalMessageParams &  params, int  contentSize, const char *  pContent  )

virtual

virtual void DtSignalMessageTransporter::sendMessage ( const DtSignalMessageParams &  params, const DtVrfObjectMessage *  message  )

virtual

Sends the message, with the specified parameters, onto the network using a signal interaction.

virtual void DtSignalMessageTransporter::addMessageReceivedCallback ( DtMessageReceivedCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Add/remove callback that will be invoked each time a message is received by this transporter. Callbacks will receive a DtSignalMessageTransporterCallbackParams pointer, which contains the message as well as the message parameters that go with the message.

virtual void DtSignalMessageTransporter::removeMessageReceivedCallback ( DtMessageReceivedCallbackList::DtCallbackFunctionType  fcn, void *  usr  )

virtual

Add/remove callback that will be invoked each time a message is received by this transporter. Callbacks will receive a DtSignalMessageTransporterCallbackParams pointer, which contains the message as well as the message parameters that go with the message.

virtual void DtSignalMessageTransporter::processSignalInteraction ( const makVrfEvents::DtVrfSignalEvent *  inter )

virtual

virtual void DtSignalMessageTransporter::signalInteractionCallback ( const makVrfEvents::DtEvent &  )

protectedvirtual

virtual void DtSignalMessageTransporter::sendSignalInteraction ( const makVrfEvents::DtVrfSignalEvent &  signalInteraction )

protectedvirtual

Send the fully initialized signal interaction.

Member Data Documentation

bool DtSignalMessageTransporter::myEnabled

protected

Referenced by enabled().

DtMessageReceivedCallbackList DtSignalMessageTransporter::myMessageReceivedCallbacks

protected

DtCommunicationManager* DtSignalMessageTransporter::myCommunicationManager

protected

boost::signals2::scoped_connection DtSignalMessageTransporter::mySignalForVrfSignalEventConnection

protected

DtClock DtSignalMessageTransporter::myClock

protected

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfMsgTransport/signalMessageTransporter.h