Apache Log4cxx  Version 1.5.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
log4cxx::rolling::TriggeringPolicy Class Referenceabstract

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

#include <triggeringpolicy.h>

Inheritance diagram for log4cxx::rolling::TriggeringPolicy:

Public Member Functions

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

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 ( Appenderappender,
const spi::LoggingEventPtrevent,
const LogStringfilename,
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
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.
Returns
true if a rollover should occur.

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


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

AltStyle によって変換されたページ (->オリジナル) /