BoilerPlate-LightweightLogging Service OMG Formal/03-11-03

LogBrowser Class Reference
[LWLogging Service]

#include <LogBrowser.h>

Collaboration diagram for LogBrowser:

[legend]List of all members.

---

Detailed Description

Maintains state for a LogConsumer.

Responsible for maintaining state for a LogConsumer and controlling LogConsumer queries. The state in a LogBrowser is maintained from call to call by a LogConsumer.

Author

knoxy

Revision

1.4

Date

2004/10/24 01:35:54

Public Member Functions
	LogBrowser (LogState &log_state)
	~LogBrowser ()
CosLwLog::RecordId	find_by_time (const CosLwLog::LogTime &mark)
	Find a Record Id that was recorded at or immediately after the specified LogTime.
void	prepare (const CosLwLog::RecordId &start_rec)
	Prepare the LogBrowser for queries.
CosLwLog::RecordId	load_records (std::list< CosLwLog::LogRecord > &cont, const CORBA::ULong &maximum, const LogRecordFilter &filter)

---

Constructor & Destructor Documentation

LogBrowser::LogBrowser (  LogState &  log_state  )

ctor Initializes instance members and references Parameters: log_state  - Reference to the Log's LogState

LogBrowser::~LogBrowser (   )

dtor Closes any open files

---

Member Function Documentation

CosLwLog::RecordId LogBrowser::find_by_time (  const CosLwLog::LogTime &  mark  )

Find a Record Id that was recorded at or immediately after the specified LogTime. Finds the correct archive and opens it to the record that was written at the specified time or immediately after the specified time Parameters: mark  - The Time to find Returns: The RecordId of the LogRecord recorded at the specified time or immediately after it

CosLwLog::RecordId LogBrowser::load_records (  std::list< CosLwLog::LogRecord > &  cont, const CORBA::ULong &  maximum, const LogRecordFilter &  filter )

Load the Records from the archive into a std::list Load the LogRecords that fit the constraints of a filter into a provided std:list up to a maximum number of LogRecords Parameters: cont  - The std::list to load the records into maximum  - The maximum number of records to load filter  - The constraints that the record must fit

void LogBrowser::prepare (  const CosLwLog::RecordId &  start_rec  )

Prepare the LogBrowser for queries. Finds the archive containing the specified RecordId and opens it to that position. If an archive is already opened and the RecordId is contained in it, then the archive is positioned to the specified RecordId. Parameters: start_rec  - The starting Record Id

---

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

• LogBrowser.h

---