log4cxx::RollingFileAppender Class Reference
RollingFileAppender extends FileAppender to backup the log files when they reach a certain size. More...
#include <rollingfileappender.h>
Inheritance diagram for log4cxx::RollingFileAppender:
Public Member Functions | |
| RollingFileAppender () | |
| The default constructor simply calls its parents constructor. More... | |
| RollingFileAppender (const LayoutPtr &layout, const LogString &fileName, bool append) | |
Instantiate a RollingFileAppender and open the file designated by | |
| RollingFileAppender (const LayoutPtr &layout, const LogString &fileName) | |
Instantiate a FileAppender and open the file designated by | |
| virtual | ~RollingFileAppender () |
| int | getMaxBackupIndex () const |
| Returns the value of the MaxBackupIndex option. More... | |
| long | getMaximumFileSize () const |
| Get the maximum size that the output file is allowed to reach before being rolled over to backup files. More... | |
| void | setMaxBackupIndex (int maxBackupIndex) |
| Set the maximum number of backup files to keep around. More... | |
| void | setMaxFileSize (const LogString &value) |
| Set the maximum size that the output file is allowed to reach before being rolled over to backup files. More... | |
| void | setMaximumFileSize (int value) |
| virtual void | setOption (const LogString &option, const LogString &value) |
Set option to value. More... | |
| void | activateOptions (log4cxx::helpers::Pool &pool) |
| Prepares RollingFileAppender for use. More... | |
 Public Member Functions inherited from log4cxx::rolling::RollingFileAppenderSkeleton | |
| RollingFileAppenderSkeleton () | |
| The default constructor simply calls its parents constructor. More... | |
| bool | rollover (log4cxx::helpers::Pool &p) |
| Implements the usual roll over behaviour. More... | |
| void | close () |
| Close appender. More... | |
| size_t | getFileLength () const |
| Get byte length of current active log file. More... | |
| void | incrementFileLength (size_t increment) |
| Increments estimated byte length of current active log file. More... | |
| Public Member Functions inherited from log4cxx::FileAppender | |
| FileAppender () | |
| The default constructor does not do anything. More... | |
| FileAppender (const LayoutPtr &layout, const LogString &filename, bool append, bool bufferedIO, int bufferSize) | |
Instantiate a FileAppender and open the file designated by filename. More... | |
| FileAppender (const LayoutPtr &layout, const LogString &filename, bool append) | |
Instantiate a FileAppender and open the file designated by filename. More... | |
| FileAppender (const LayoutPtr &layout, const LogString &filename) | |
Instantiate a FileAppender and open the file designated by filename. More... | |
| ~FileAppender () | |
| virtual void | setFile (const LogString &file) |
| The File property takes a string value which should be the name of the file to append to. More... | |
| bool | getAppend () const |
| Returns the value of the Append option. More... | |
| LogString | getFile () const |
| Returns the value of the File option. More... | |
| bool | getBufferedIO () const |
| Get the value of the BufferedIO option. More... | |
| int | getBufferSize () const |
| Get the size of the IO buffer. More... | |
| void | setAppend (bool fileAppend1) |
| The Append option takes a boolean value. More... | |
| void | setBufferedIO (bool bufferedIO) |
| The BufferedIO option takes a boolean value. More... | |
| void | setBufferSize (int bufferSize1) |
| Set the size of the IO buffer. More... | |
| Public Member Functions inherited from log4cxx::WriterAppender | |
| WriterAppender () | |
| This default constructor does nothing. More... | |
| ~WriterAppender () | |
| void | setImmediateFlush (bool value) |
If the ImmediateFlush option is set to true, the appender will flush at the end of each write. More... | |
| bool | getImmediateFlush () const |
| Returns value of the ImmediateFlush option. More... | |
| virtual void | append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) |
| This method is called by the AppenderSkeleton::doAppend method. More... | |
| LogString | getEncoding () const |
| void | setEncoding (const LogString &value) |
| void | setOption (const LogString &option, const LogString &value) |
Set option to value. More... | |
| void | setWriter (const log4cxx::helpers::WriterPtr &writer) |
| virtual bool | requiresLayout () const |
| Configurators call this method to determine if the appender requires a layout. More... | |
| Public Member Functions inherited from log4cxx::AppenderSkeleton | |
| AppenderSkeleton () | |
| AppenderSkeleton (const LayoutPtr &layout) | |
| void | finalize () |
Finalize this appender by calling the derived class' close method. More... | |
| void | addFilter (const spi::FilterPtr &newFilter) |
| Add a filter to end of the filter list. More... | |
| void | clearFilters () |
| Clear the filters chain. More... | |
| const spi::ErrorHandlerPtr & | getErrorHandler () const |
| Return the currently set spi::ErrorHandler for this Appender. More... | |
| spi::FilterPtr | getFilter () const |
| Returns the head Filter. More... | |
| const spi::FilterPtr & | getFirstFilter () const |
| Return the first filter in the filter chain for this Appender. More... | |
| LayoutPtr | getLayout () const |
| Returns the layout of this appender. More... | |
| LogString | getName () const |
| Returns the name of this Appender. More... | |
| const LevelPtr & | getThreshold () const |
| Returns this appenders threshold level. More... | |
| bool | isAsSevereAsThreshold (const LevelPtr &level) const |
| Check whether the message level is below the appender's threshold. More... | |
| virtual void | doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) |
| This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method. More... | |
| void | setErrorHandler (const spi::ErrorHandlerPtr eh) |
| Set the ErrorHandler for this Appender. More... | |
| void | setLayout (const LayoutPtr &layout1) |
| Set the layout for this appender. More... | |
| void | setName (const LogString &name1) |
| Set the name of this Appender. More... | |
| void | setThreshold (const LevelPtr &threshold) |
| Set the threshold level. More... | |
| Public Member Functions inherited from log4cxx::Appender | |
| virtual | ~Appender () |
| void | asdf () |
| Public Member Functions inherited from log4cxx::spi::OptionHandler | |
| virtual | ~OptionHandler () |
| Public Member Functions inherited from log4cxx::helpers::Object | |
| virtual | ~Object () |
| virtual bool | instanceof (const Class &clazz) const =0 |
| virtual const void * | cast (const Class &clazz) const =0 |
Additional Inherited Members | |
| Static Public Member Functions inherited from log4cxx::FileAppender | |
| static LogString | stripDuplicateBackslashes (const LogString &name) |
| Replaces double backslashes with single backslashes for compatibility with paths from earlier XML configurations files. More... | |
| Protected Member Functions inherited from log4cxx::rolling::RollingFileAppenderSkeleton | |
| virtual void | subAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) |
| Actual writing occurs here. More... | |
| bool | rolloverInternal (log4cxx::helpers::Pool &p) |
| RollingPolicyPtr | getRollingPolicy () const |
| TriggeringPolicyPtr | getTriggeringPolicy () const |
| void | setRollingPolicy (const RollingPolicyPtr &policy) |
| Sets the rolling policy. More... | |
| void | setTriggeringPolicy (const TriggeringPolicyPtr &policy) |
| log4cxx::helpers::WriterPtr | createWriter (log4cxx::helpers::OutputStreamPtr &os) |
| Returns an OutputStreamWriter when passed an OutputStream. More... | |
| Protected Member Functions inherited from log4cxx::FileAppender | |
| void | activateOptionsInternal (log4cxx::helpers::Pool &p) |
| void | setFileInternal (const LogString &file, bool append, bool bufferedIO, size_t bufferSize, log4cxx::helpers::Pool &p) |
| Sets and opens the file where the log output will go. More... | |
| void | setFileInternal (const LogString &file) |
| Protected Member Functions inherited from log4cxx::WriterAppender | |
| WriterAppender (const LayoutPtr &layout, log4cxx::helpers::WriterPtr &writer) | |
| WriterAppender (const LayoutPtr &layout) | |
| virtual bool | checkEntryConditions () const |
| This method determines if there is a sense in attempting to append. More... | |
| void | closeWriter () |
| Close the underlying log4cxx::helpers::Writer. More... | |
| virtual void | writeFooter (log4cxx::helpers::Pool &p) |
| Write a footer as produced by the embedded layout's Layout::appendFooter method. More... | |
| virtual void | writeHeader (log4cxx::helpers::Pool &p) |
| Write a header as produced by the embedded layout's Layout::appendHeader method. More... | |
| void | setWriterInternal (const log4cxx::helpers::WriterPtr &writer) |
| Set the writer. More... | |
| Protected Member Functions inherited from log4cxx::AppenderSkeleton | |
| void | doAppendImpl (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) |
| Protected Attributes inherited from log4cxx::FileAppender | |
| bool | fileAppend |
Append to or truncate the file? The default value for this variable is true, meaning that by default a FileAppender will append to an existing file and not truncate it. More... | |
| LogString | fileName |
| The name of the log file. More... | |
| bool | bufferedIO |
| Do we do bufferedIO? More... | |
| int | bufferSize |
| How big should the IO buffer be? Default is 8K. More... | |
| Protected Attributes inherited from log4cxx::AppenderSkeleton | |
| LayoutPtr | layout |
| The layout variable does not need to be set if the appender implementation has its own layout. More... | |
| LogString | name |
| Appenders are named. More... | |
| LevelPtr | threshold |
| There is no level threshold filtering by default. More... | |
| spi::ErrorHandlerPtr | errorHandler |
| It is assumed and enforced that errorHandler is never null. More... | |
| spi::FilterPtr | headFilter |
| The first filter in the filter chain. More... | |
| spi::FilterPtr | tailFilter |
| The last filter in the filter chain. More... | |
| bool | closed |
| Is this appender closed? More... | |
| log4cxx::helpers::Pool | pool |
| log4cxx::shared_mutex | mutex |
Detailed Description
RollingFileAppender extends FileAppender to backup the log files when they reach a certain size.
Constructor & Destructor Documentation
◆ RollingFileAppender() [1/3]
| log4cxx::RollingFileAppender::RollingFileAppender | ( | ) |
The default constructor simply calls its parents constructor.
◆ RollingFileAppender() [2/3]
| log4cxx::RollingFileAppender::RollingFileAppender | ( | const LayoutPtr & | layout, |
| const LogString & | fileName, | ||
| bool | append | ||
| ) |
Instantiate a RollingFileAppender and open the file designated by
filename.
The opened filename will become the ouput destination for this appender.
If the append parameter is true, the file will be appended to. Otherwise, the file desginated by filename will be truncated before being opened.
◆ RollingFileAppender() [3/3]
| log4cxx::RollingFileAppender::RollingFileAppender | ( | const LayoutPtr & | layout, |
| const LogString & | fileName | ||
| ) |
Instantiate a FileAppender and open the file designated by
filename.
The opened filename will become the output destination for this appender.
The file will be appended to.
◆ ~RollingFileAppender()
|
virtual |
Member Function Documentation
◆ activateOptions()
|
virtual |
Prepares RollingFileAppender for use.
Reimplemented from log4cxx::rolling::RollingFileAppenderSkeleton.
◆ getMaxBackupIndex()
| int log4cxx::RollingFileAppender::getMaxBackupIndex | ( | ) | const |
Returns the value of the MaxBackupIndex option.
◆ getMaximumFileSize()
| long log4cxx::RollingFileAppender::getMaximumFileSize | ( | ) | const |
Get the maximum size that the output file is allowed to reach before being rolled over to backup files.
◆ setMaxBackupIndex()
| void log4cxx::RollingFileAppender::setMaxBackupIndex | ( | int | maxBackupIndex | ) |
Set the maximum number of backup files to keep around.
The MaxBackupIndex option determines how many backup files are kept before the oldest is erased. This option takes a positive integer value. If set to zero, then there will be no backup files and the log file will be truncated when it reaches MaxFileSize.
◆ setMaxFileSize()
| void log4cxx::RollingFileAppender::setMaxFileSize | ( | const LogString & | value | ) |
Set the maximum size that the output file is allowed to reach before being rolled over to backup files.
In configuration files, the MaxFileSize option takes an long integer in the range 0 - 2^63. You can specify the value with the suffixes "KB", "MB" or "GB" so that the integer is interpreted being expressed respectively in kilobytes, megabytes or gigabytes. For example, the value "10KB" will be interpreted as 10240.
◆ setMaximumFileSize()
| void log4cxx::RollingFileAppender::setMaximumFileSize | ( | int | value | ) |
◆ setOption()
|
virtual |
Set option to value.
The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.
Reimplemented from log4cxx::FileAppender.
The documentation for this class was generated from the following file:
