Apache log4cxx  Version 0.12.0
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. More...
 
virtual ~FilterBasedTriggeringPolicy ()
 
virtual bool isTriggeringEvent (Appender *appender, const log4cxx::spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)
 Determines if a rollover may be appropriate at this time. More...
 
void addFilter (const log4cxx::spi::FilterPtr &newFilter)
 Add a filter to end of the filter list. More...
 
void clearFilters ()
 Clear the filters chain. More...
 
log4cxx::spi::FilterPtrgetFilter ()
 Returns the head Filter. More...
 
void activateOptions (log4cxx::helpers::Pool &)
 Prepares the instance for use. More...
 
void setOption (const LogString &option, const LogString &value)
 Set option to value. More...
 
- Public Member Functions inherited from log4cxx::rolling::TriggeringPolicy
virtual ~TriggeringPolicy ()
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
- 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

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 ( log4cxx::helpers::Pool )
virtual

Prepares the instance for use.

Implements log4cxx::spi::OptionHandler.

◆ addFilter()

void log4cxx::rolling::FilterBasedTriggeringPolicy::addFilter ( const log4cxx::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()

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

Returns the head Filter.

◆ isTriggeringEvent()

virtual bool log4cxx::rolling::FilterBasedTriggeringPolicy::isTriggeringEvent ( Appender appender,
const log4cxx::spi::LoggingEventPtr event,
const LogString filename,
size_t  fileLength 
)
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.

Implements log4cxx::rolling::TriggeringPolicy.

◆ setOption()

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

Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.

Implements log4cxx::spi::OptionHandler.


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