poco/Foundation/include/Poco/LogStream.h

208 lines
6.1 KiB
C
Raw Normal View History

2006-10-23 17:48:43 +02:00
//
// LogStream.h
//
2008-01-28 18:23:19 +01:00
// $Id: //poco/svn/Foundation/include/Poco/LogStream.h#2 $
2006-10-23 17:48:43 +02:00
//
// Library: Foundation
// Package: Logging
// Module: LogStream
//
// Definition of the LogStream class.
//
// Copyright (c) 2006-2007, Applied Informatics Software Engineering GmbH.
2006-10-23 17:48:43 +02:00
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
#ifndef Foundation_LogStream_INCLUDED
#define Foundation_LogStream_INCLUDED
#include "Poco/Foundation.h"
#include "Poco/Logger.h"
#include "Poco/UnbufferedStreamBuf.h"
#include <istream>
namespace Poco {
class Foundation_API LogStreamBuf: public UnbufferedStreamBuf
/// This class implements a streambuf interface
/// to a Logger.
///
/// The streambuf appends all characters written to it
/// to a string. As soon as a CR or LF (std::endl) is written,
/// the string is sent to the Logger, with the set
/// priority.
{
public:
LogStreamBuf(Logger& logger, Message::Priority priority);
/// Creates the LogStream.
~LogStreamBuf();
/// Destroys the LogStream.
void setPriority(Message::Priority priority);
/// Sets the priority for log messages.
Message::Priority getPriority() const;
/// Returns the priority for log messages.
Logger& logger() const;
/// Returns a reference to the Logger.
2006-10-23 17:48:43 +02:00
private:
int writeToDevice(char c);
private:
Logger& _logger;
Message::Priority _priority;
std::string _message;
};
class Foundation_API LogIOS: public virtual std::ios
/// The base class for LogStream.
///
/// This class is needed to ensure the correct initialization
/// order of the stream buffer and base classes.
{
public:
LogIOS(Logger& logger, Message::Priority priority);
~LogIOS();
LogStreamBuf* rdbuf();
protected:
LogStreamBuf _buf;
};
class Foundation_API LogStream: public LogIOS, public std::ostream
/// This class implements an ostream interface
/// to a Logger.
///
/// The stream's buffer appends all characters written to it
/// to a string. As soon as a CR or LF (std::endl) is written,
/// the string is sent to the Logger, with the current
/// priority.
///
/// Usage example:
/// LogStream ls(someLogger);
/// ls << "Some informational message" << std::endl;
/// ls.error() << "Some error message" << std::endl;
{
public:
LogStream(Logger& logger, Message::Priority priority = Message::PRIO_INFORMATION);
/// Creates the LogStream, using the given logger and priority.
LogStream(const std::string& loggerName, Message::Priority priority = Message::PRIO_INFORMATION);
/// Creates the LogStream, using the logger identified
/// by loggerName, and sets the priority.
~LogStream();
/// Destroys the LogStream.
LogStream& fatal();
/// Sets the priority for log messages to Message::PRIO_FATAL.
LogStream& fatal(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_FATAL
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& critical();
/// Sets the priority for log messages to Message::PRIO_CRITICAL.
LogStream& critical(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_CRITICAL
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& error();
/// Sets the priority for log messages to Message::PRIO_ERROR.
LogStream& error(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_ERROR
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& warning();
/// Sets the priority for log messages to Message::PRIO_WARNING.
LogStream& warning(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_WARNING
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& notice();
/// Sets the priority for log messages to Message::PRIO_NOTICE.
LogStream& notice(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_NOTICE
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& information();
/// Sets the priority for log messages to Message::PRIO_INFORMATION.
LogStream& information(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_INFORMATION
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& debug();
/// Sets the priority for log messages to Message::PRIO_DEBUG.
LogStream& debug(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_DEBUG
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& trace();
/// Sets the priority for log messages to Message::PRIO_TRACE.
LogStream& trace(const std::string& message);
/// Sets the priority for log messages to Message::PRIO_TRACE
/// and writes the given message.
2006-10-23 17:48:43 +02:00
LogStream& priority(Message::Priority priority);
/// Sets the priority for log messages.
};
//
// inlines
//
inline Message::Priority LogStreamBuf::getPriority() const
{
return _priority;
}
inline Logger& LogStreamBuf::logger() const
{
return _logger;
}
2006-10-23 17:48:43 +02:00
} // namespace Poco
#endif // Foundation_LogStream_INCLUDED