Apache log4cxx  Version 0.10.0
RollingPolicy Class Reference

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

Inheritance diagram for RollingPolicy:
OptionHandler Object RollingPolicyBase FixedWindowRollingPolicy TimeBasedRollingPolicy

List of all members.

Public Member Functions

virtual ~RollingPolicy ()
virtual RolloverDescriptionPtr initialize (const LogString &file, const bool append, log4cxx::helpers::Pool &p)=0
 Initialize the policy and return any initial actions for rolling file appender.
virtual RolloverDescriptionPtr rollover (const LogString &activeFile, log4cxx::helpers::Pool &p)=0
 Prepare for a rollover.

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

virtual ~RollingPolicy ( ) [inline, virtual]

Member Function Documentation

virtual RolloverDescriptionPtr initialize ( const LogString file,
const bool  append,
log4cxx::helpers::Pool p 
) [pure virtual]

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

Parameters:
filecurrent value of RollingFileAppender.getFile().
appendcurrent value of RollingFileAppender.getAppend().
ppool 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 TimeBasedRollingPolicy, and FixedWindowRollingPolicy.

virtual RolloverDescriptionPtr rollover ( const LogString activeFile,
log4cxx::helpers::Pool p 
) [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:
activeFilefile name for current active log file.
ppool 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 TimeBasedRollingPolicy, and FixedWindowRollingPolicy.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines