Apache log4cxx  Version 0.12.0
log4cxx::rolling::RollingPolicy Class Referenceabstract

A RollingPolicy is responsible for performing the rolling over of the active log file. More...

#include <rollingpolicy.h>

Inheritance diagram for log4cxx::rolling::RollingPolicy:
log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::rolling::RollingPolicyBase log4cxx::rolling::FixedWindowRollingPolicy log4cxx::rolling::TimeBasedRollingPolicy

Public Member Functions

virtual ~RollingPolicy ()
 
virtual RolloverDescriptionPtr initialize (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
 Initialize the policy and return any initial actions for rolling file appender. More...
 
virtual RolloverDescriptionPtr rollover (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
 Prepare for a rollover. More...
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
virtual void activateOptions (log4cxx::helpers::Pool &p)=0
 Activate the options that were previously set with calls to option setters. More...
 
virtual void setOption (const LogString &option, const LogString &value)=0
 Set option to value. More...
 
- 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
 

Detailed Description

A RollingPolicy is responsible for performing the rolling over of the active log file.

The RollingPolicy is also responsible for providing the active log file, that is the live file where logging output will be directed.

Constructor & Destructor Documentation

◆ ~RollingPolicy()

virtual log4cxx::rolling::RollingPolicy::~RollingPolicy ( )
inlinevirtual

Member Function Documentation

◆ initialize()

virtual RolloverDescriptionPtr log4cxx::rolling::RollingPolicy::initialize ( const LogString currentActiveFile,
const bool  append,
log4cxx::helpers::Pool pool 
)
pure virtual

Initialize the policy and return any initial actions for rolling file appender.

Parameters
currentActiveFilecurrent value of RollingFileAppender.getFile().
appendcurrent value of RollingFileAppender.getAppend().
poolpool for memory allocations during call.
Returns
Description of the initialization, may be null to indicate no initialization needed.
Exceptions
SecurityExceptionif denied access to log files.

Implemented in log4cxx::rolling::TimeBasedRollingPolicy, and log4cxx::rolling::FixedWindowRollingPolicy.

◆ rollover()

virtual RolloverDescriptionPtr log4cxx::rolling::RollingPolicy::rollover ( const LogString currentActiveFile,
const bool  append,
log4cxx::helpers::Pool pool 
)
pure virtual

Prepare for a rollover.

This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.

Parameters
currentActiveFilefile name for current active log file.
appendcurrent value of the parent FileAppender.getAppend().
poolpool for memory allocations during call.
Returns
Description of pending rollover, may be null to indicate no rollover at this time.
Exceptions
SecurityExceptionif denied access to log files.

Implemented in log4cxx::rolling::TimeBasedRollingPolicy, and log4cxx::rolling::FixedWindowRollingPolicy.


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