log4cpp::RollingFileAppender - Man Page

RollingFileAppender is a FileAppender that rolls over the logfile once it has reached a certain size limit.

Synopsis

#include <RollingFileAppender.hh>

Inherits log4cpp::FileAppender.

Public Member Functions

RollingFileAppender (const std::string &name, const std::string &fileName, size_t maxFileSize=10 *1024 *1024, unsigned int maxBackupIndex=1, bool append=true, mode_t mode=00644)
virtual void setMaxBackupIndex (unsigned int maxBackups)
virtual unsigned int getMaxBackupIndex () const
virtual void setMaximumFileSize (size_t maxFileSize)
virtual size_t getMaxFileSize () const
virtual void rollOver ()

Public Member Functions inherited from log4cpp::FileAppender
FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)
Constructs a FileAppender.
FileAppender (const std::string &name, int fd)
Constructs a FileAppender to an already open file descriptor.
virtual ~FileAppender ()
virtual bool reopen ()
Reopens the logfile.
virtual void close ()
Closes the logfile.
virtual void setAppend (bool append)
Sets the append vs truncate flag.
virtual bool getAppend () const
Gets the value of the 'append' option.
virtual void setMode (mode_t mode)
Sets the file open mode.
virtual mode_t getMode () const
Gets the file open mode.

Public Member Functions inherited from log4cpp::LayoutAppender
LayoutAppender (const std::string &name)
virtual ~LayoutAppender ()
virtual bool requiresLayout () const
Check if the appender requires a layout.
virtual void setLayout (Layout *layout=NULL)
Set the Layout for this appender.

Public Member Functions inherited from log4cpp::AppenderSkeleton
virtual ~AppenderSkeleton ()
Destructor for AppenderSkeleton.
virtual void doAppend (const LoggingEvent &event)
Log in Appender specific way.
virtual bool reopen ()
Reopens the output destination of this Appender, e.g.
virtual void close ()=0
Release any resources allocated within the appender such as file handles, network connections, etc.
virtual bool requiresLayout () const =0
Check if the appender uses a layout.
virtual void setLayout (Layout *layout)=0
Set the Layout for this appender.
virtual void setThreshold (Priority::Value priority)
Set the threshold priority of this Appender.
virtual Priority::Value getThreshold ()
Get the threshold priority of this Appender.
virtual void setFilter (Filter *filter)
Set a Filter for this appender.
virtual Filter * getFilter ()
Get the Filter for this appender.

Public Member Functions inherited from log4cpp::Appender
virtual ~Appender ()
Destructor for Appender.
virtual void doAppend (const LoggingEvent &event)=0
Log in Appender specific way.
virtual bool reopen ()=0
Reopens the output destination of this Appender, e.g.
virtual void close ()=0
Release any resources allocated within the appender such as file handles, network connections, etc.
virtual bool requiresLayout () const =0
Check if the appender uses a layout.
virtual void setLayout (Layout *layout)=0
Set the Layout for this appender.
const std::string & getName () const
Get the name of this appender.
virtual void setThreshold (Priority::Value priority)=0
Set the threshold priority of this Appender.
virtual Priority::Value getThreshold ()=0
Get the threshold priority of this Appender.
virtual void setFilter (Filter *filter)=0
Set a Filter for this appender.
virtual Filter * getFilter ()=0
Get the Filter for this appender.

Protected Member Functions

virtual void _append (const LoggingEvent &event)
Log in Appender specific way.
virtual void _append (const LoggingEvent &event)
Log in Appender specific way.

Protected Member Functions inherited from log4cpp::LayoutAppender
Layout & _getLayout ()
Return the layout of the appender.

Protected Member Functions inherited from log4cpp::AppenderSkeleton
AppenderSkeleton (const std::string &name)
Constructor for AppenderSkeleton.
virtual void _append (const LoggingEvent &event)=0
Log in Appender specific way.

Protected Member Functions inherited from log4cpp::Appender
Appender (const std::string &name)
Constructor for Appender.

Protected Attributes

unsigned int _maxBackupIndex
unsigned short int _maxBackupIndexWidth
size_t _maxFileSize

Protected Attributes inherited from log4cpp::FileAppender
const std::string _fileName
int _fd
int _flags
mode_t _mode

Additional Inherited Members

Public Types inherited from log4cpp::LayoutAppender

typedef BasicLayout DefaultLayoutType

Static Public Member Functions inherited from log4cpp::Appender
static Appender * getAppender (const std::string &name)
Get a pointer to an exitsing Appender.
static bool reopenAll ()
Call reopen() on all existing Appenders.
static void closeAll ()
Call reopen() on all existing Appenders.

Detailed Description

RollingFileAppender is a FileAppender that rolls over the logfile once it has reached a certain size limit.

Since

0.3.1

Constructor & Destructor Documentation

log4cpp::RollingFileAppender::RollingFileAppender (const std::string & name, const std::string & fileName, size_t maxFileSize = 10*1024*1024, unsigned int maxBackupIndex = 1, bool append = true, mode_t mode = 00644)

Member Function Documentation

void log4cpp::RollingFileAppender::_append (const LoggingEvent & event) [protected], [virtual]

Log in Appender specific way. Subclasses of Appender should implement this method to perform actual logging.

Parameters

event The LoggingEvent to log.

Reimplemented from log4cpp::FileAppender.

unsigned int log4cpp::RollingFileAppender::getMaxBackupIndex () const [virtual]

size_t log4cpp::RollingFileAppender::getMaxFileSize () const [virtual]

void log4cpp::RollingFileAppender::rollOver () [virtual]

void log4cpp::RollingFileAppender::setMaxBackupIndex (unsigned int maxBackups) [virtual]

void log4cpp::RollingFileAppender::setMaximumFileSize (size_t maxFileSize) [virtual]

Member Data Documentation

unsigned int log4cpp::RollingFileAppender::_maxBackupIndex [protected]

unsigned short int log4cpp::RollingFileAppender::_maxBackupIndexWidth [protected]

size_t log4cpp::RollingFileAppender::_maxFileSize [protected]

Author

Generated automatically by Doxygen for log4cpp from the source code.

Info

Thu Jan 19 2023 Version 1.1.3 log4cpp