Appends log events to a file. More...
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 () |
 Public Member Functions inherited from log4cplus::Appender | |
| Appender (const log4cplus::helpers::Properties properties) | |
| void | destructorImpl () |
| void | doAppend (const log4cplus::spi::InternalLoggingEvent &event) |
| This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append method. | |
| virtual log4cplus::tstring | getName () |
| Get the name of this appender. | |
| virtual void | setName (const log4cplus::tstring &name) |
| Set the name of this appender. | |
| virtual void | setErrorHandler (OFauto_ptr< ErrorHandler > eh) |
| Set the ErrorHandler for this Appender. | |
| virtual ErrorHandler * | getErrorHandler () |
| Return the currently set ErrorHandler for this Appender. | |
| virtual void | setLayout (OFauto_ptr< Layout > layout) |
| Set the layout for this appender. | |
| virtual Layout * | getLayout () |
| Returns the layout of this appender. | |
| void | setFilter (log4cplus::spi::FilterPtr f) |
| Set the filter chain on this Appender. | |
| log4cplus::spi::FilterPtr | getFilter () const |
| Get the filter chain on this Appender. | |
| LogLevel | getThreshold () const |
| Returns this appenders threshold LogLevel. | |
| void | setThreshold (LogLevel th) |
| Set the threshold LogLevel. | |
| bool | isAsSevereAsThreshold (LogLevel ll) const |
| Check whether the message LogLevel is below the appender's threshold. | |
| Public Member Functions inherited from log4cplus::helpers::SharedObject | |
| void | addReference () const |
| void | removeReference () const |
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 |
| Protected Attributes inherited from log4cplus::Appender | |
| OFauto_ptr< Layout > | layout |
| The layout variable does not need to be set if the appender implementation has its own layout. | |
| log4cplus::tstring | name |
| Appenders are named. | |
| LogLevel | threshold |
| There is no LogLevel threshold filtering by default. | |
| log4cplus::spi::FilterPtr | filter |
| The first filter in the filter chain. | |
| OFauto_ptr< ErrorHandler > | errorHandler |
| It is assumed and enforced that errorHandler is never null. | |
| bool | closed |
| Is this appender closed? | |
Private Member Functions | |
| void | init (const log4cplus::tstring &filename, LOG4CPLUS_OPEN_MODE_TYPE mode) |
| FileAppender (const FileAppender &) | |
| FileAppender & | operator= (const FileAppender &) |
Additional Inherited Members | |
| Public Attributes inherited from log4cplus::helpers::SharedObject | |
| LOG4CPLUS_MUTEX_PTR_DECLARE | access_mutex |
Detailed Description
Appends log events to a file.
Properties
FileThis property specifies output file name.
ImmediateFlushWhen it is set true, output stream will be flushed after each appended event.
AppendWhen 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.
Member Data Documentation
|
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.
|
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.
The documentation for this class was generated from the following file:
- oflog/include/dcmtk/oflog/fileap.h