log4shib 2.0.1
Loading...
Searching...
No Matches
log4shib::RollingFileAppender Class Reference

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

#include <RollingFileAppender.hh>

Inheritance diagram for log4shib::RollingFileAppender:
log4shib::FileAppender log4shib::LayoutAppender log4shib::AppenderSkeleton log4shib::Appender

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 log4shib::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 log4shib::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 log4shib::AppenderSkeleton
virtual ~AppenderSkeleton ()
 Destructor for AppenderSkeleton.
 
virtual void doAppend (const LoggingEvent &event)
 Log in Appender specific way.
 
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 FiltergetFilter ()
 Get the Filter for this appender.
 
- Public Member Functions inherited from log4shib::Appender
virtual ~Appender ()
 Destructor for Appender.
 
const std::string & getName () const
 Get the name of this appender.
 

Protected Member Functions

virtual void _append (const LoggingEvent &event)
 Log in Appender specific way.
 
- Protected Member Functions inherited from log4shib::LayoutAppender
Layout_getLayout ()
 Return the layout of the appender.
 
- Protected Member Functions inherited from log4shib::AppenderSkeleton
 AppenderSkeleton (const std::string &name)
 Constructor for AppenderSkeleton.
 
- Protected Member Functions inherited from log4shib::Appender
 Appender (const std::string &name)
 Constructor for Appender.
 

Protected Attributes

unsigned int _maxBackupIndex
 
size_t _maxFileSize
 
- Protected Attributes inherited from log4shib::FileAppender
const std::string _fileName
 
int _fd
 
int _flags
 
mode_t _mode
 

Additional Inherited Members

- Public Types inherited from log4shib::LayoutAppender
typedef BasicLayout DefaultLayoutType
 
- Static Public Member Functions inherited from log4shib::Appender
static AppendergetAppender (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

◆ RollingFileAppender()

log4shib::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

◆ _append()

void log4shib::RollingFileAppender::_append ( const LoggingEvent & event)
protectedvirtual

Log in Appender specific way.

Subclasses of Appender should implement this method to perform actual logging.

Parameters
eventThe LoggingEvent to log.

Reimplemented from log4shib::FileAppender.

◆ getMaxBackupIndex()

unsigned int log4shib::RollingFileAppender::getMaxBackupIndex ( ) const
virtual

◆ getMaxFileSize()

size_t log4shib::RollingFileAppender::getMaxFileSize ( ) const
virtual

◆ rollOver()

void log4shib::RollingFileAppender::rollOver ( )
virtual

◆ setMaxBackupIndex()

void log4shib::RollingFileAppender::setMaxBackupIndex ( unsigned int maxBackups)
virtual

◆ setMaximumFileSize()

void log4shib::RollingFileAppender::setMaximumFileSize ( size_t maxFileSize)
virtual

Member Data Documentation

◆ _maxBackupIndex

unsigned int log4shib::RollingFileAppender::_maxBackupIndex
protected

◆ _maxFileSize

size_t log4shib::RollingFileAppender::_maxFileSize
protected

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