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

A TriggeringPolicy controls the conditions under which rollover occurs. More...

#include <triggeringpolicy.h>

Inheritance diagram for log4cxx::rolling::TriggeringPolicy:
log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::helpers::Object log4cxx::rolling::FilterBasedTriggeringPolicy log4cxx::rolling::ManualTriggeringPolicy log4cxx::rolling::SizeBasedTriggeringPolicy log4cxx::rolling::TimeBasedRollingPolicy

Public Member Functions

virtual ~TriggeringPolicy ()
 
virtual bool isTriggeringEvent (Appender *appender, const log4cxx::spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)=0
 Determines if a rollover may be appropriate at this time. 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 TriggeringPolicy controls the conditions under which rollover occurs.

Such conditions include time of day, file size, an external event or a combination thereof.

Constructor & Destructor Documentation

◆ ~TriggeringPolicy()

virtual log4cxx::rolling::TriggeringPolicy::~TriggeringPolicy ( )
virtual

Member Function Documentation

◆ isTriggeringEvent()

virtual bool log4cxx::rolling::TriggeringPolicy::isTriggeringEvent ( Appender appender,
const log4cxx::spi::LoggingEventPtr event,
const LogString filename,
size_t  fileLength 
)
pure virtual

Determines if a rollover may be appropriate at this time.

If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.

Parameters
appenderA reference to the appender.
eventA reference to the currently event.
filenameThe filename for the currently active log file.
fileLengthLength of the file in bytes.
Returns
true if a rollover should occur.

Implemented in log4cxx::rolling::TimeBasedRollingPolicy, log4cxx::rolling::FilterBasedTriggeringPolicy, log4cxx::rolling::SizeBasedTriggeringPolicy, and log4cxx::rolling::ManualTriggeringPolicy.


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