log4cplus::FileAppender

log4cplus::FileAppender Class Reference

Appends log events to a file. More...

Inheritance diagram for log4cplus::FileAppender:

log4cplus::Appender log4cplus::helpers::SharedObject log4cplus::helpers::LogLogUser log4cplus::DailyRollingFileAppender log4cplus::RollingFileAppender List of all members.

Public Member Functions

 FileAppender (const log4cplus::tstring &filename, LOG4CPLUS_OPEN_MODE_TYPE mode=LOG4CPLUS_FSTREAM_NAMESPACE::ios::trunc, bool immediateFlush=true)
 FileAppender (const log4cplus::helpers::Properties &properties, log4cplus::tstring &error, LOG4CPLUS_OPEN_MODE_TYPE mode=LOG4CPLUS_FSTREAM_NAMESPACE::ios::trunc)
virtual void close ()

Protected Member Functions

virtual void append (const spi::InternalLoggingEvent &event)
void open (LOG4CPLUS_OPEN_MODE_TYPE mode)
bool reopen ()

Protected Attributes

bool immediateFlush
 Immediate flush means that the underlying writer or output stream will be flushed at the end of each append operation.
int reopenDelay
 When any append operation fails, reopenDelay says for how many seconds the next attempt to re-open the log file and resume logging will be delayed.
log4cplus::tofstream out
log4cplus::tstring filename
log4cplus::helpers::Time reopen_time

Private Member Functions

void init (const log4cplus::tstring &filename, LOG4CPLUS_OPEN_MODE_TYPE mode)
 FileAppender (const FileAppender &)
FileAppender & operator= (const FileAppender &)

Detailed Description

Appends log events to a file.

Properties

File
This property specifies output file name.

ImmediateFlush
When it is set true, output stream will be flushed after each appended event.

Append
When it is set true, output file will be appended to instead of being truncated at opening.

ReopenDelay
This property sets a delay after which the appender will try to reopen log file again, after last logging failure. The default value is 1 second. Setting the delay to 0 makes the appender not to try reopening the stream.

Definition at line 64 of file fileap.h.

Member Data Documentation

bool log4cplus::FileAppender::immediateFlush [protected]

Immediate flush means that the underlying writer or output stream will be flushed at the end of each append operation.

Immediate flush is slower but ensures that each append request is actually written. If immediateFlush is set to false, then there is a good chance that the last few logs events are not actually written to persistent media if and when the application crashes.

The immediateFlush variable is set to true by default.

Definition at line 99 of file fileap.h.

int log4cplus::FileAppender::reopenDelay [protected]

When any append operation fails, reopenDelay says for how many seconds the next attempt to re-open the log file and resume logging will be delayed.

If reopenDelay is zero, each failed append operation will cause log file to be re-opened. By default, reopenDelay is 1 second.

Definition at line 108 of file fileap.h.

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

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1