A TriggeringPolicy controls the conditions under which rollover occurs.
More...
Inherits log4cxx::spi::OptionHandler, and log4cxx::helpers::ObjectImpl.
Inherited by FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
Classes | |
| class | ClazzTriggeringPolicy |
Public Member Functions | |
| virtual const helpers::Class & | getClass () const |
| const void * | cast (const helpers::Class &clazz) const |
| bool | instanceof (const helpers::Class &clazz) const |
| 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. | |
Static Public Member Functions | |
| static const helpers::Class & | getStaticClass () |
| static const log4cxx::helpers::ClassRegistration & | registerClass () |
A TriggeringPolicy controls the conditions under which rollover occurs.
Such conditions include time of day, file size, an external event or a combination thereof.
| virtual ~TriggeringPolicy | ( | ) | [virtual] |
| void addRef | ( | ) | const [virtual] |
Reimplemented from ObjectImpl.
Reimplemented in TimeBasedRollingPolicy.
| const void* cast | ( | const helpers::Class & | clazz | ) | const [inline, virtual] |
Implements Object.
Reimplemented in FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
| virtual const helpers::Class& getClass | ( | ) | const [virtual] |
Reimplemented from OptionHandler.
Reimplemented in FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
| static const helpers::Class& getStaticClass | ( | ) | [static] |
Reimplemented from OptionHandler.
Reimplemented in FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
| bool instanceof | ( | const helpers::Class & | clazz | ) | const [inline, virtual] |
Implements Object.
Reimplemented in FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
| 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.
| 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. |
Implemented in FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
| static const log4cxx::helpers::ClassRegistration& registerClass | ( | ) | [static] |
Reimplemented from OptionHandler.
Reimplemented in FilterBasedTriggeringPolicy, ManualTriggeringPolicy, SizeBasedTriggeringPolicy, and TimeBasedRollingPolicy.
| void releaseRef | ( | ) | const [virtual] |
Reimplemented from ObjectImpl.
Reimplemented in TimeBasedRollingPolicy.