drama::logging::LogStreamBuf Class Reference

Detailed Description

Implement a streambuf sub-class that can write messages via the DRAMA Logger interface.

This class implements std::streambuf, which allows it to be used as an output stream buffer for character based output streams (std::ostream). Messages are output via the DRAMA Logger.

You can use this to create an std::ostream which can be used to output to the log file.

drama::logging::LogStreamBuf logBuf(&taskShrPtr->Logger(), 
                                    D2LOG_DRAMA2,
                                   "d2::SetupWaitEvent");
std::ostream slogger(&logBuf);
slogger << "Message for log file" << std::endl;

Note

A new DRAMA Log event happens sent each time the buffer is flushed, which will happen if a std::endl is output or if the number of queue characters exceeds 200. In the later case, the message will be broken between multiple log events.

Warning

Any text not flushed when the destructor is invoked will be flushed by the destructor. In some cases, this may result in messages appearing outside the expected order. It is recommended all message be terminated by a std::endl to avoid this happening.

Implementation based on code in "The C++ Standard Library", Second Edition, N.M. Josuttis, 2012. Pages 837/838.

From that:

(C) Copyright Nicolai M. Josuttis 2012. Permission to copy, use, modify, sell and distribute this software is granted provided this copyright notice appears in all copies. This software is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.

But note, most of the code copied here is very much the minimum required to use the streambuf class.

Author

Tony Farrell, AAO $Revision$ $Date$

#include "logger.hh"

Inherits std::streambuf.

Public Member Functions
	LogStreamBuf (const LogStreamBuf &source)=delete
	Copy constructor - deleted.
	LogStreamBuf (Logger *theLogger, unsigned level, const std::string &prefix)
	Construct a LogStreamBuf object.
	LogStreamBuf (LogStreamBuf &&source) noexcept
	Move copy constructor.
virtual	~LogStreamBuf ()
	Destroy the LogStreamBuf, any remaining output is sent.
LogStreamBuf &	operator= (const LogStreamBuf &rhs)=delete
	Assignment operator - deleted.
LogStreamBuf &	operator= (LogStreamBuf &&rhs) noexcept
	Move assignment operator.

---

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

• logger.hh