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

#include <rollingpolicy.h>

Inheritance diagram for log4cxx::rolling::RollingPolicy:

Public Member Functions
virtual	~RollingPolicy ()
RolloverDescriptionPtr	initialize (const LogString &currentActiveFile, bool append)
	Initialize the policy and return any initial actions for rolling file appender.
virtual RolloverDescriptionPtr	initialize (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
RolloverDescriptionPtr	rollover (const LogString &currentActiveFile, bool append)
	Prepare for a rollover.
virtual RolloverDescriptionPtr	rollover (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()
void	activateOptions ()
virtual void	activateOptions (helpers::Pool &)=0
virtual void	setOption (const LogString &option, const LogString &value)=0
	Set `option` to `value`.
Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()
virtual const helpers::Class &	getClass () const =0
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() [1/2]

RolloverDescriptionPtr log4cxx::rolling::RollingPolicy::initialize	(	const LogString &	currentActiveFile,
		bool	append )

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

Parameters

currentActiveFile	current value of RollingFileAppender.getFile().
append	current value of RollingFileAppender.getAppend().

Returns: Description of the initialization, may be null to indicate no initialization needed.

◆ initialize() [2/2]

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

pure virtual

Deprecated: The pool parameter is not used and will be removed in a future version. Implement this method for now, but plan to migrate to initialize() without a helpers::Pool parameter.

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

◆ rollover() [1/2]

RolloverDescriptionPtr log4cxx::rolling::RollingPolicy::rollover	(	const LogString &	currentActiveFile,
		bool	append )

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.