---

Qmms::Log::RollingFileAppender Class Reference

RollingFileAppender extends FileAppender by backing up the log files when they reach a certain size. More...

#include <log.hh>

Inheritance diagram for Qmms::Log::RollingFileAppender::

List of all members.

Public Methods
	RollingFileAppender ()
	Default constructor. More...
	RollingFileAppender (const QString &name)
	Constructor. More...
	RollingFileAppender (const QString &name, Layout *lyt, QString filename, const bool append)
	Full constructor. More...
	~RollingFileAppender ()
	Destructor closes handle to logfile. More...
int	getMaxBackupIndex () const
	Accessor method. More...
void	setMaxBackupIndex (const int maxbackups)
	Accessor method. More...
uint	getMaxFileSize () const
	Accessor method. More...
void	setMaxFileSize (uint maxfilesize)
	Accessor method. More...
void	subAppend (LoggingEvent *evnt)
	Logs the event immediately with no further checks of any kind. More...
Protected Methods
void	rollOver ()
	Rolls a logfile over. More...
Protected Attributes
uint	maxFileSize
	The maximum size a log file is allowed to be. More...
int	maxBackupIndex
	The maximum number of times a log file should roll over. More...
Static Protected Attributes
const uint	DEFAULT_MAXFILESIZE
	The (default) maximum size that a log file should be. More...
const int	DEFAULT_MAXBACKUP_INDEX
	The (default) maximum number of times the log file should roll over. More...

---

Detailed Description

RollingFileAppender extends FileAppender by backing up the log files when they reach a certain size.

---

Constructor & Destructor Documentation

Qmms::Log::RollingFileAppender::RollingFileAppender (    )

Default constructor. Sets maxFileSize and maxBackupIndex to defaults.

Qmms::Log::RollingFileAppender::RollingFileAppender (  const QString &    name )

Constructor. Passes name to base class and sets defaults. Parameters: name  reference to the name of this appender

Qmms::Log::RollingFileAppender::RollingFileAppender (  const QString &    name, Layout *    lyt, QString    filename, const bool    append )

Full constructor. Sets defaults and passes name, layout, and name of logfile to base class constructor. Parameters: name  reference to name of this appender lyt  pointer to layout used in this appender filename  name of file to log to append  not used yet

Qmms::Log::RollingFileAppender::~RollingFileAppender (    )

Destructor closes handle to logfile.

---

Member Function Documentation

int Qmms::Log::RollingFileAppender::getMaxBackupIndex (    )  const

Accessor method. Returns: the maxBackupIndex, i.e., the number of times the logfile gets rolled over.

uint Qmms::Log::RollingFileAppender::getMaxFileSize (    )  const

Accessor method. Returns: the maximum size a logfile can be

void Qmms::Log::RollingFileAppender::rollOver (    )  [protected]

Rolls a logfile over. That is, it renames the current logfile to logfile.1, the old logfile.1 to logfile.2, etc. The number of files to rollover is controlled by the variable maxBackupIndex, and rollover occurs whenever the current logfile exceeds maxFileSize in size. The user need never access this method directly. It is called by subAppend().

void Qmms::Log::RollingFileAppender::setMaxBackupIndex (  const int    maxbackups )

Accessor method. Sets the maxBackupIndex. Parameters: maxbackups  the number of times to roll over the logfile

void Qmms::Log::RollingFileAppender::setMaxFileSize (  uint    maxfilesize )

Accessor method. Sets the maximum size a logfile can be. Parameters: maxfilesize  the number of bytes a file is allowed to hold

void Qmms::Log::RollingFileAppender::subAppend (  LoggingEvent *    evnt )  [virtual]

Logs the event immediately with no further checks of any kind. Recall again the order of things: logWithLevel() callAppenders() doAppend() isAsSevereAsThreshold() append() checkEntryConditions() subAppend() This method first calls the base classes's subAppend() to log the event. Then it checks whether the current logfile has exceeded its maxsize. If so, then it calls rollover(). Parameters: evnt  pointer to the LoggingEvent to log Reimplemented from Qmms::Log::FileAppender.

---

Member Data Documentation

const int Qmms::Log::RollingFileAppender::DEFAULT_MAXBACKUP_INDEX [static, protected]

The (default) maximum number of times the log file should roll over.

const uint Qmms::Log::RollingFileAppender::DEFAULT_MAXFILESIZE [static, protected]

The (default) maximum size that a log file should be.

int Qmms::Log::RollingFileAppender::maxBackupIndex [protected]

The maximum number of times a log file should roll over.

uint Qmms::Log::RollingFileAppender::maxFileSize [protected]

The maximum size a log file is allowed to be.

---

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

• log.hh

---