VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
DtSplitMessageCollector Class Reference

This class helps DtVrfMessageInterface handle big messages. More...

List of all members.

Public Types

typedef std::map
< DtSplitMessageKey, std::map
< int, DtSimInterfaceMessage > > 
DtSplitMap

Public Member Functions

 DtSplitMessageCollector ()
 Contructor.
virtual ~DtSplitMessageCollector ()
 destructor
virtual void processSplitContentTimeout (const DtSplitMessageKey &key)
virtual bool reassembleMessage (const DtSplitMessageKey &key, int nOriginalContentType, DtVrfMessageInterface &vrfMsgIf)
 Checks to see if all DtIfSplitContent chunks were received, invokes vrfMsgIf.processReassembledContent() if all chunks present.
virtual bool receiveMessage (const DtSimInterfaceMessage &msg, DtVrfMessageInterface &vrfMsgIf)
 Processes an incoming message containing DtIfSplitContent Called from DtVrfMessageInterface::receiveMessage().
virtual void timeoutOldSplits ()
 Walk through the DtSplitMap, purge any split content that has timed out.
virtual const DtSplitContentTimersplitContentTimer () const
virtual DtSplitContentTimersplitContentTimer ()

Static Public Member Functions

static void splitContentTimeoutCbk (const DtSplitMessageKey &key, void *pUsr)

Protected Member Functions

 DtSplitMessageCollector (const DtSplitMessageCollector &orig)
 these aren't used
const DtSplitMessageCollectoroperator= (const DtSplitMessageCollector &orig)
 these aren't used

Protected Attributes

DtSplitMap mySplitMessages
DtSplitContentTimer mySplitContentTimer

Detailed Description

This class helps DtVrfMessageInterface handle big messages.


Member Typedef Documentation


Constructor & Destructor Documentation

Contructor.

destructor

these aren't used


Member Function Documentation

virtual bool DtSplitMessageCollector::reassembleMessage ( const DtSplitMessageKey key,
int  nOriginalContentType,
DtVrfMessageInterface vrfMsgIf 
) [virtual]

Checks to see if all DtIfSplitContent chunks were received, invokes vrfMsgIf.processReassembledContent() if all chunks present.

virtual bool DtSplitMessageCollector::receiveMessage ( const DtSimInterfaceMessage msg,
DtVrfMessageInterface vrfMsgIf 
) [virtual]

Processes an incoming message containing DtIfSplitContent Called from DtVrfMessageInterface::receiveMessage().

Parameters:
msgA message containing DtIfSplitContent.
vrfMsgIfA reference to the calling DtVrfMessageInterface, so that a reassembled message can be further processed by calling vrfMsgIf.processReassembledContent()
Returns:
true if content was processed, false if error occurred
virtual void DtSplitMessageCollector::timeoutOldSplits ( ) [virtual]

Walk through the DtSplitMap, purge any split content that has timed out.

References mySplitContentTimer.

References mySplitContentTimer.

static void DtSplitMessageCollector::splitContentTimeoutCbk ( const DtSplitMessageKey key,
void *  pUsr 
) [static]
const DtSplitMessageCollector& DtSplitMessageCollector::operator= ( const DtSplitMessageCollector orig) [protected]

these aren't used


Member Data Documentation

Referenced by splitContentTimer().


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)