Apache log4cxx  Version 0.10.0
TriggeringPolicy Class Referenceabstract

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

Inheritance diagram for TriggeringPolicy:
OptionHandler ObjectImpl Object Object FilterBasedTriggeringPolicy ManualTriggeringPolicy SizeBasedTriggeringPolicy TimeBasedRollingPolicy

Public Member Functions

virtual ~TriggeringPolicy ()
 
void addRef () const
 
void releaseRef () const
 
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 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 Object
virtual const helpers::ClassgetClass () const
 
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 
- Public Member Functions inherited from ObjectImpl
 ObjectImpl ()
 
virtual ~ObjectImpl ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static const helpers::ClassgetStaticClass ()
 
static const log4cxx::helpers::ClassRegistrationregisterClass ()
 
- Protected Attributes inherited from ObjectImpl
unsigned int volatile ref
 

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

virtual ~TriggeringPolicy ( )
virtual

Member Function Documentation

void addRef ( ) const
virtual

Reimplemented from ObjectImpl.

virtual bool 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 TimeBasedRollingPolicy, FilterBasedTriggeringPolicy, SizeBasedTriggeringPolicy, and ManualTriggeringPolicy.

void releaseRef ( ) const
virtual

Reimplemented from ObjectImpl.


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