FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters. More...
Inherits log4cxx::rolling::TriggeringPolicy.
Classes | |
class | ClazzFilterBasedTriggeringPolicy |
Public Member Functions | |
virtual const helpers::Class & | getClass () const |
const void * | cast (const helpers::Class &clazz) const |
bool | instanceof (const helpers::Class &clazz) const |
FilterBasedTriggeringPolicy () | |
Creates a new FilterBasedTriggeringPolicy. | |
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. | |
void | addFilter (const log4cxx::spi::FilterPtr &newFilter) |
Add a filter to end of the filter list. | |
void | clearFilters () |
Clear the filters chain. | |
log4cxx::spi::FilterPtr & | getFilter () |
Returns the head Filter. | |
void | activateOptions (log4cxx::helpers::Pool &) |
Prepares the instance for use. | |
void | setOption (const LogString &option, const LogString &value) |
Set option to value . | |
Static Public Member Functions | |
static const helpers::Class & | getStaticClass () |
static const log4cxx::helpers::ClassRegistration & | registerClass () |
Public Attributes | |
log4cxx::spi::FilterPtr | headFilter |
The first filter in the filter chain. | |
log4cxx::spi::FilterPtr | tailFilter |
The last filter in the filter chain. |
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.
Creates a new FilterBasedTriggeringPolicy.
virtual ~FilterBasedTriggeringPolicy | ( | ) | [virtual] |
void activateOptions | ( | log4cxx::helpers::Pool & | ) | [virtual] |
Prepares the instance for use.
Implements OptionHandler.
void addFilter | ( | const log4cxx::spi::FilterPtr & | newFilter | ) |
const void* cast | ( | const helpers::Class & | clazz | ) | const [inline, virtual] |
Reimplemented from TriggeringPolicy.
void clearFilters | ( | ) |
Clear the filters chain.
virtual const helpers::Class& getClass | ( | ) | const [virtual] |
Reimplemented from TriggeringPolicy.
log4cxx::spi::FilterPtr& getFilter | ( | ) |
Returns the head Filter.
static const helpers::Class& getStaticClass | ( | ) | [static] |
Reimplemented from TriggeringPolicy.
bool instanceof | ( | const helpers::Class & | clazz | ) | const [inline, virtual] |
Reimplemented from TriggeringPolicy.
virtual bool 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.
appender | A reference to the appender. | |
event | A reference to the currently event. | |
filename | The filename for the currently active log file. | |
fileLength | Length of the file in bytes. |
Implements TriggeringPolicy.
static const log4cxx::helpers::ClassRegistration& registerClass | ( | ) | [static] |
Reimplemented from TriggeringPolicy.
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 OptionHandler.