log4cxx::rolling::ManualTriggeringPolicy Class Reference

ManualTriggeringPolicy only rolls over on explicit calls to RollingFileAppender.rollover(). More...

#include <manualtriggeringpolicy.h>

Inheritance diagram for log4cxx::rolling::ManualTriggeringPolicy:

Public Member Functions
	ManualTriggeringPolicy ()
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	activateOptions (log4cxx::helpers::Pool &)
	Activate the options that were previously set with calls to option setters. 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

ManualTriggeringPolicy only rolls over on explicit calls to RollingFileAppender.rollover().

Constructor & Destructor Documentation

ManualTriggeringPolicy()

log4cxx::rolling::ManualTriggeringPolicy::ManualTriggeringPolicy

(

)

Member Function Documentation

activateOptions()

void log4cxx::rolling::ManualTriggeringPolicy::activateOptions ( log4cxx::helpers::Pool &  p )

virtual

Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

Implements log4cxx::spi::OptionHandler.

isTriggeringEvent()

virtual bool log4cxx::rolling::ManualTriggeringPolicy::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

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.

Implements log4cxx::rolling::TriggeringPolicy.

setOption()

void log4cxx::rolling::ManualTriggeringPolicy::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:

• manualtriggeringpolicy.h