Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
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 RollingFileAppender:
Inheritance graph
[legend]

Public Member Functions

virtual unsigned int getMaxBackupIndex () const
 
virtual size_t getMaxFileSize () const
 
 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 rollOver ()
 
virtual void setMaxBackupIndex (unsigned int maxBackups)
 
virtual void setMaximumFileSize (size_t maxFileSize)
 
- Public Member Functions inherited from FileAppender
virtual void close ()
 Closes the logfile. More...
 
 FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)
 Constructs a FileAppender. More...
 
 FileAppender (const std::string &name, int fd)
 Constructs a FileAppender to an already open file descriptor. More...
 
virtual bool getAppend () const
 Gets the value of the 'append' option. More...
 
virtual mode_t getMode () const
 Gets the file open mode. More...
 
virtual bool reopen ()
 Reopens the logfile. More...
 
virtual void setAppend (bool append)
 Sets the append vs truncate flag. More...
 
virtual void setMode (mode_t mode)
 Sets the file open mode. More...
 
virtual ~FileAppender ()
 
- Public Member Functions inherited from LayoutAppender
 LayoutAppender (const std::string &name)
 
virtual bool requiresLayout () const
 Check if the appender requires a layout. More...
 
virtual void setLayout (Layout *layout=NULL)
 Set the Layout for this appender. More...
 
virtual ~LayoutAppender ()
 
- Public Member Functions inherited from AppenderSkeleton
virtual void doAppend (const LoggingEvent &event)
 Log in Appender specific way. More...
 
virtual FiltergetFilter ()
 Get the Filter for this appender. More...
 
virtual Priority::Value getThreshold ()
 Get the threshold priority of this Appender. More...
 
virtual void setFilter (Filter *filter)
 Set a Filter for this appender. More...
 
virtual void setThreshold (Priority::Value priority)
 Set the threshold priority of this Appender. More...
 
virtual ~AppenderSkeleton ()
 Destructor for AppenderSkeleton. More...
 
- Public Member Functions inherited from Appender
const std::string & getName () const
 Get the name of this appender. More...
 
virtual ~Appender ()
 Destructor for Appender. More...
 

Protected Member Functions

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

Protected Attributes

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

Private Member Functions

RollingFileAppenderoperator= (const RollingFileAppender &)
 

Additional Inherited Members

- Public Types inherited from LayoutAppender
typedef BasicLayout DefaultLayoutType
 
- Static Public Member Functions inherited from Appender
static void closeAll ()
 Call reopen() on all existing Appenders. More...
 
static AppendergetAppender (const std::string &name)
 Get a pointer to an existing Appender. More...
 
static bool reopenAll ()
 Call reopen() on all existing Appenders. More...
 

Detailed Description

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

Since
0.3.1

Definition at line 22 of file RollingFileAppender.hh.

Constructor & Destructor Documentation

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

virtual void 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 FileAppender.

virtual unsigned int RollingFileAppender::getMaxBackupIndex ( ) const
virtual
virtual size_t RollingFileAppender::getMaxFileSize ( ) const
virtual
RollingFileAppender& RollingFileAppender::operator= ( const RollingFileAppender )
private
virtual void RollingFileAppender::rollOver ( )
virtual
virtual void RollingFileAppender::setMaxBackupIndex ( unsigned int  maxBackups)
virtual
virtual void RollingFileAppender::setMaximumFileSize ( size_t  maxFileSize)
virtual

Member Data Documentation

unsigned int RollingFileAppender::_maxBackupIndex
protected

Definition at line 41 of file RollingFileAppender.hh.

unsigned short int RollingFileAppender::_maxBackupIndexWidth
protected

Definition at line 42 of file RollingFileAppender.hh.

size_t RollingFileAppender::_maxFileSize
protected

Definition at line 44 of file RollingFileAppender.hh.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:41