Apache Log4cxx  Version 1.3.1
Loading...
Searching...
No Matches
log4cxx::rolling::FilterBasedTriggeringPolicy Class Reference

FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters. More...

#include <filterbasedtriggeringpolicy.h>

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

Public Member Functions

 FilterBasedTriggeringPolicy ()
 Creates a new FilterBasedTriggeringPolicy.
 
virtual ~FilterBasedTriggeringPolicy ()
 
bool isTriggeringEvent (Appender *appender, const spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength) override
 Determines if a rollover may be appropriate at this time.
 
void addFilter (const spi::FilterPtr &newFilter)
 Add a filter to end of the filter list.
 
void clearFilters ()
 Clear the filters chain.
 
spi::FilterPtrgetFilter ()
 Returns the head Filter.
 
void activateOptions (helpers::Pool &) override
 Activate the options that were previously set with calls to option setters.
 
void setOption (const LogString &option, const LogString &value) override
 Set option to value.
 
- Public Member Functions inherited from log4cxx::rolling::TriggeringPolicy
virtual ~TriggeringPolicy ()
 
virtual bool isTriggeringEvent (Appender *appender, const spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)=0
 Determines if a rollover may be appropriate at this time.
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
virtual void activateOptions (helpers::Pool &p)=0
 Activate the options that were previously set with calls to option setters.
 
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::ClassgetClass () const =0
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Detailed Description

FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters.

Unless a filter rejects a message, a rolling event will be triggered.

Constructor & Destructor Documentation

◆ FilterBasedTriggeringPolicy()

log4cxx::rolling::FilterBasedTriggeringPolicy::FilterBasedTriggeringPolicy ( )

◆ ~FilterBasedTriggeringPolicy()

virtual log4cxx::rolling::FilterBasedTriggeringPolicy::~FilterBasedTriggeringPolicy ( )
virtual

Member Function Documentation

◆ activateOptions()

void log4cxx::rolling::FilterBasedTriggeringPolicy::activateOptions ( helpers::Pool )
overridevirtual

Activate the options that were previously set with calls to option setters.

Activates all attached filters.

Implements log4cxx::spi::OptionHandler.

◆ addFilter()

void log4cxx::rolling::FilterBasedTriggeringPolicy::addFilter ( const spi::FilterPtr newFilter)

Add a filter to end of the filter list.

Parameters
newFilterfilter to add to end of list.

◆ clearFilters()

void log4cxx::rolling::FilterBasedTriggeringPolicy::clearFilters ( )

Clear the filters chain.

◆ getFilter()

spi::FilterPtr & log4cxx::rolling::FilterBasedTriggeringPolicy::getFilter ( )

Returns the head Filter.

◆ isTriggeringEvent()

bool log4cxx::rolling::FilterBasedTriggeringPolicy::isTriggeringEvent ( Appender appender,
const spi::LoggingEventPtr event,
const LogString filename,
size_t  fileLength 
)
overridevirtual

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.

Implements log4cxx::rolling::TriggeringPolicy.

◆ setOption()

void log4cxx::rolling::FilterBasedTriggeringPolicy::setOption ( const LogString option,
const LogString value 
)
overridevirtual

Set option to value.

Supported options Supported values Default value
- - -

Implements log4cxx::spi::OptionHandler.


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