Apache log4cxx  Version 0.12.0
log4cxx::rolling::SizeBasedTriggeringPolicy Class Reference

SizeBasedTriggeringPolicy looks at size of the file being currently written to. More...

#include <sizebasedtriggeringpolicy.h>

Inheritance diagram for log4cxx::rolling::SizeBasedTriggeringPolicy:
log4cxx::rolling::TriggeringPolicy log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::helpers::Object

Public Member Functions

 SizeBasedTriggeringPolicy ()
 
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...
 
size_t getMaxFileSize ()
 
void setMaxFileSize (size_t l)
 
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
 

Protected Attributes

size_t maxFileSize
 

Detailed Description

SizeBasedTriggeringPolicy looks at size of the file being currently written to.

Constructor & Destructor Documentation

◆ SizeBasedTriggeringPolicy()

log4cxx::rolling::SizeBasedTriggeringPolicy::SizeBasedTriggeringPolicy ( )

Member Function Documentation

◆ activateOptions()

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

◆ getMaxFileSize()

size_t log4cxx::rolling::SizeBasedTriggeringPolicy::getMaxFileSize ( )

◆ isTriggeringEvent()

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

Implements log4cxx::rolling::TriggeringPolicy.

◆ setMaxFileSize()

void log4cxx::rolling::SizeBasedTriggeringPolicy::setMaxFileSize ( size_t  l)

◆ setOption()

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

Member Data Documentation

◆ maxFileSize

size_t log4cxx::rolling::SizeBasedTriggeringPolicy::maxFileSize
protected

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