LoggerStream Class Reference

LoggerStream class that is a std::ostream replacement that will log each line. More...

#include <ored/utilities/log.hpp>

Collaboration diagram for LoggerStream:

Public Member Functions
	LoggerStream (unsigned mask, const char *filename, unsigned lineNo)
	~LoggerStream ()
	destructor - this is when the logging takes place. More...
	operator std::ostream & ()
	cast this LoggerStream as a ostream& More...

Private Attributes
unsigned	mask_
const char *	filename_
unsigned	lineNo_
std::stringstream	ss_

Detailed Description

LoggerStream class that is a std::ostream replacement that will log each line.

LoggerStream is a simple wrapper around a std::string stream, it has an explicit cast std::ostream& method so it can be used in place of any std::ostream, this can be used with QuantExt methods that take a std::ostream& for logging purposes.

Once the stream falls out of focus, it's destructor will take the buffered log messages and pass them the main ore::data::Log::instance().

Note the following

• The timestamps for each log message will correspond to when the LoggerStream destructor has been called, this may not correspond to the actual time the event occurred.
• The filename and linenumber in the ore::data::Log() have to be explicitly passed to the LoggerStream, as such the log messages will not correspond to any references in QuantExt (or any other library).

The LoggerStream relies on falling out of scope to trigger the logging, as such they should not be created using the new operator.

The proper usage is to use the macro LOGGERSTREAM and DLOGGERSTREAM, if a function takes a std::ostream& as a parameter, use the macro instead.

void function(int x, int y, std::ostream& out);
 
void main () {
 
  // call function
  function (3, 4, LOGGERSTREAM);
  // All logging will be completed before this line
}

Definition at line 605 of file log.hpp.

Constructor & Destructor Documentation

LoggerStream()

LoggerStream	(	unsigned	mask,
		const char *	filename,
		unsigned	lineNo
	)

Definition at line 471 of file log.cpp.

    : mask_(mask), filename_(filename), lineNo_(lineNo), ss_() {
    QL_REQUIRE(mask == ORE_ALERT || mask == ORE_CRITICAL || mask == ORE_ERROR || mask == ORE_WARNING ||
                   mask == ORE_NOTICE || mask == ORE_DEBUG || mask == ORE_DATA,
               "Invalid log mask " << mask);
}

~LoggerStream()

~LoggerStream

(

)

destructor - this is when the logging takes place.

Definition at line 478 of file log.cpp.

                            {
    string text;
    while (getline(ss_, text)) {
        // we expand the MLOG macro here so we can overwrite __FILE__ and __LINE__
        if (ore::data::Log::instance().enabled() && ore::data::Log::instance().filter(mask_)) {
            boost::unique_lock<boost::shared_mutex> lock(ore::data::Log::instance().mutex());
            ore::data::Log::instance().header(mask_, filename_, lineNo_);
            ore::data::Log::instance().logStream() << text;
            ore::data::Log::instance().log(mask_);
        }
    }
}

Member Function Documentation

operator std::ostream &()

operator std::ostream &

(

)

cast this LoggerStream as a ostream&

Definition at line 613 of file log.hpp.

{ return ss_; }

Member Data Documentation

mask_

unsigned mask_

private

Definition at line 616 of file log.hpp.

filename_

const char* filename_

private

Definition at line 617 of file log.hpp.

lineNo_

unsigned lineNo_

private

Definition at line 618 of file log.hpp.

ss_

std::stringstream ss_

private

Definition at line 619 of file log.hpp.