Vault  4.1
Public Member Functions | Protected Member Functions
VStringLogAppender Class Reference

An appender that appends each emitted message to a multi-line string instance variable that can be obtained afterwards. More...

#include <vlogger.h>

Inheritance diagram for VStringLogAppender:
VLogAppender

List of all members.

Public Member Functions

 VStringLogAppender (const VString &name, bool formatOutput, const VString &formatSpec, const VString &timeFormat)
 VStringLogAppender (const VSettingsNode &settings, const VSettingsNode &defaults)
virtual void addInfo (VBentoNode &infoNode) const
 For diagnostic purposes, adds the properties/state of this appender to the supplied Bento node.
VMutexgetMutex ()
const VStringgetLines () const
const char * orphanLines ()

Protected Member Functions

virtual void _emitRawLine (const VString &line)
 This is the method that most concrete appenders must implement in order to write a message (whether it is in raw form or has already been formatted) to the output medium.

Detailed Description

An appender that appends each emitted message to a multi-line string instance variable that can be obtained afterwards.

You would not want to use such a logger indefinitely, since it would run out of memory; it's intended to capture log output emitted for a specific action of limited duration. It defines no additional settings properties.

Definition at line 1082 of file vlogger.h.


Member Function Documentation

void VStringLogAppender::addInfo ( VBentoNode infoNode) const [virtual]

For diagnostic purposes, adds the properties/state of this appender to the supplied Bento node.

Concrete classes should call inherited and then add their type-specific info.

Parameters:
infoNodethe Bento node to which to add this appender's properties

Reimplemented from VLogAppender.

Definition at line 1199 of file vlogger.cpp.

References VBentoNode::addString().

void VStringLogAppender::_emitRawLine ( const VString ) [protected, virtual]

This is the method that most concrete appenders must implement in order to write a message (whether it is in raw form or has already been formatted) to the output medium.

The reason an emty implementation is provided here, rather than it being pure virtual, is that some appenders override _emitMessage() instead because they always bypass formatting.

Parameters:
linethe actual line to be emitted as is (it has already been formatted if that was needed)

Reimplemented from VLogAppender.

Definition at line 1204 of file vlogger.cpp.

References VString::NATIVE_LINE_ENDING().


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

Copyright ©1997-2014 Trygve Isaacson. All rights reserved. This documentation was generated with Doxygen.