This class encapsulates the sending and receiving of DtVrfObjectMessages though signal interactions. More...

Classes
struct	_tSplitContentEntry
Public Types
typedef struct DtSignalMessageTransporter::_tSplitContentEntry	SplitContentEntry
typedef std::map < DtSplitMessageKey, std::map < unsigned, SplitContentEntry > >	SplitContentMap
typedef DtCallbackList < DtSignalMessageTransporterCallbackParams * >	DtMessageReceivedCallbackList
Public Member Functions
virtual	~DtSignalMessageTransporter ()
virtual void	clearSplitContent ()
	erase buffers held in split content map
virtual bool	processSplitContent (const DtSignalMessageParams &params, const DtSignalMessageHeader &msgHdr, const char *pContent)
virtual void	processSplitContentTimeout (const DtSplitMessageKey &key)
virtual bool	processVrfObjectMessageReceived (const DtSignalMessageParams &params, const char *pVrfObjectMessageBuffer)
virtual bool	reassembleVrfObjectMessage (const DtSignalMessageParams &params, const DtSignalMessageHeader &msgHdr)
virtual void	removeSplitContent (const DtSplitMessageKey &key)
virtual void	sendInteraction (const DtSignalMessageParams &params, const DtSignalMessageHeader &msgHdr, const char *pContent)
virtual void	sendMessage (const DtSignalMessageParams &params, const DtVrfObjectMessage *message)
	Sends the message, with the specified parameters, onto the network using a signal interaction.

bool	enabled () const
	accessor/mutator for enabled state
virtual void	setEnabled (bool bEnabled)
	accessor/mutator for enabled state

virtual void	addMessageReceivedCallback (DtMessageReceivedCallbackList::DtCallbackFunctionType fcn, void *usr)
	Add/remove callback that will be invoked each time a message is received by this transporter.
virtual void	removeMessageReceivedCallback (DtMessageReceivedCallbackList::DtCallbackFunctionType fcn, void *usr)
	Add/remove callback that will be invoked each time a message is received by this transporter.
Static Public Member Functions
static DtSignalMessageTransporter *	create (DtExerciseConn *exConn)
	Calls constructor and init() on the new instance before returning it.
static void	splitContentTimeoutCbk (const DtSplitMessageKey &key, void *pUsr)
Protected Member Functions
	DtSignalMessageTransporter (DtExerciseConn *exConn)
	Call create() instead of the constructor.
virtual bool	init ()
	Virtual init called from create().
virtual void	processSignalInteraction (DtSignalInteraction *inter)
virtual void	sendSignalInteraction (DtSignalInteraction &signalInteraction)
	Send the fully initialized signal interaction.
Static Protected Member Functions
static void	signalInteractionCallback (DtSignalInteraction inter, void usr)
Protected Attributes
bool	myEnabled
DtExerciseConn *	myExConn
DtMessageReceivedCallbackList	myMessageReceivedCallbacks
SplitContentMap	mySplitContentMap
DtSplitContentTimer	mySplitContentTimer
Private Member Functions

	DtSignalMessageTransporter ()
	Not implemented.
	DtSignalMessageTransporter (const DtSignalMessageTransporter &orig)
	Not implemented.
DtSignalMessageTransporter &	operator= (const DtSignalMessageTransporter &orig)
	Not implemented.

Detailed Description

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.

Member Typedef Documentation

typedef struct DtSignalMessageTransporter::_tSplitContentEntry DtSignalMessageTransporter::SplitContentEntry

typedef std::map<DtSplitMessageKey, std::map<unsigned, SplitContentEntry> > DtSignalMessageTransporter::SplitContentMap

typedef DtCallbackList<DtSignalMessageTransporterCallbackParams*> DtSignalMessageTransporter::DtMessageReceivedCallbackList

Constructor & Destructor Documentation

DtSignalMessageTransporter::DtSignalMessageTransporter ( ) [private]

Not implemented.

DtSignalMessageTransporter::DtSignalMessageTransporter ( const DtSignalMessageTransporter & orig ) [private]

Not implemented.

DtSignalMessageTransporter::DtSignalMessageTransporter ( DtExerciseConn * 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 ( ) [protected, virtual]

Virtual init called from create().

static DtSignalMessageTransporter* DtSignalMessageTransporter::create ( DtExerciseConn * exConn ) [static]

Calls constructor and init() on the new instance before returning it.

Caller is responsible for deleting returned instance.

virtual void DtSignalMessageTransporter::clearSplitContent ( ) [virtual]

erase buffers held in split content map

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::processSplitContent	(	const DtSignalMessageParams &	params,
		const DtSignalMessageHeader &	msgHdr,
		const char *	pContent
	)		`[virtual]`

virtual void DtSignalMessageTransporter::processSplitContentTimeout ( const DtSplitMessageKey & key ) [virtual]

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

virtual bool DtSignalMessageTransporter::reassembleVrfObjectMessage	(	const DtSignalMessageParams &	params,
		const DtSignalMessageHeader &	msgHdr
	)		`[virtual]`

virtual void DtSignalMessageTransporter::removeSplitContent ( const DtSplitMessageKey & key ) [virtual]

virtual void DtSignalMessageTransporter::sendInteraction	(	const DtSignalMessageParams &	params,
		const DtSignalMessageHeader &	msgHdr,
		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.