DtLrcEventLog Class Reference

The DtLrcEventLog stores log events passed to the WWW server from an LRC Log state messages are cached by index for easy retrieval. More...

Collaboration diagram for DtLrcEventLog:

List of all members.

Classes
struct	LogEvent
Public Member Functions
	DtLrcEventLog ()
	Default CTOR.
virtual	~DtLrcEventLog ()
virtual void	pushLogEvent (unsigned long componentId, DtTime time, bool isRtiAmbCall, bool isException, const DtString &description)
	Push a new log event onto the end of the log.
virtual void	appendLogSegment (unsigned long componentId, DtLrcConsoleLogXmlBlockSP logSegmentSP)
	Append a new segment of log events to the specified component's connection log.
virtual DtLrcConsoleLogXmlBlockSP	getLogSegment (DtEnvValueSP parentNode, unsigned long componentId, unsigned int startIndex, unsigned int stopIndex)
	Get the events starting from startIndex from the component's log.
virtual DtTime	timeOfLastUpdate (unsigned long componentId) const
	Get the time of the last update to a component's log (useful for determining whether update requests have been satisfied)
Protected Types
typedef std::vector< LogEvent >	LogEventsList
typedef std::map< unsigned long, LogEventsList >	LogsByComponentIdMap
typedef std::map< unsigned long, DtTime >	UpdateAgeByComponentIdMap
Protected Attributes
DtClock	myClock
LogsByComponentIdMap	myEvents
UpdateAgeByComponentIdMap	myTimesOfLastUpdates

---

Detailed Description

The DtLrcEventLog stores log events passed to the WWW server from an LRC Log state messages are cached by index for easy retrieval.

---

Member Typedef Documentation

typedef std::vector< LogEvent > DtLrcEventLog::LogEventsList [protected]

typedef std::map< unsigned long, LogEventsList > DtLrcEventLog::LogsByComponentIdMap [protected]

typedef std::map< unsigned long, DtTime > DtLrcEventLog::UpdateAgeByComponentIdMap [protected]

---

Constructor & Destructor Documentation

DtLrcEventLog::DtLrcEventLog

(

)

Default CTOR.

DtLrcEventLog::~DtLrcEventLog

(

)

[virtual]

---

Member Function Documentation

void DtLrcEventLog::appendLogSegment	(	unsigned long	componentId,
		DtLrcConsoleLogXmlBlockSP	logSegmentSP
	)		[virtual]

Append a new segment of log events to the specified component's connection log.

References myClock, myEvents, and myTimesOfLastUpdates.

DtLrcConsoleLogXmlBlockSP DtLrcEventLog::getLogSegment	(	DtEnvValueSP	parentNode,
		unsigned long	componentId,
		unsigned int	startIndex,
		unsigned int	stopIndex
	)		[virtual]

Get the events starting from startIndex from the component's log.

If startIndex > last cache index, then return empty list If stopIndex > last cache index, then return startIndex to last cache index If startIndex < last cached index, but is not up to date, return an empty list If stopIndex < last cached index but is not up to data, return the up-to-date set in the range Returned log segment indicates contained indices

References myEvents.

void DtLrcEventLog::pushLogEvent	(	unsigned long	componentId,
		DtTime	time,
		bool	isRtiAmbCall,
		bool	isException,
		const DtString &	description
	)		[virtual]

Push a new log event onto the end of the log.

• used by the LRC to store log events in order (so componentId generally == 0)

References myEvents.

DtTime DtLrcEventLog::timeOfLastUpdate

(

unsigned long

componentId

)

const [virtual]

Get the time of the last update to a component's log (useful for determining whether update requests have been satisfied)

References myTimesOfLastUpdates.

---

Member Data Documentation

DtClock DtLrcEventLog::myClock [protected]

Referenced by appendLogSegment().

LogsByComponentIdMap DtLrcEventLog::myEvents [protected]

Referenced by appendLogSegment(), getLogSegment(), and pushLogEvent().

UpdateAgeByComponentIdMap DtLrcEventLog::myTimesOfLastUpdates [protected]

Referenced by appendLogSegment(), and timeOfLastUpdate().

---

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

• lrcEventLog.h
• lrcEventLog.cxx