ThreadSafeLogStream.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//--------------------------------------------
// Includes
//--------------------------------------------
#include "MantidKernel/DllConfig.h"
 
#include <Poco/LogStream.h>
#include <Poco/Message.h>
#include <Poco/Thread.h>
 
#include <iosfwd>
#include <map>
#include <mutex>
#include <string>
 
// Forward Declare
namespace Poco {
class Logger;
}
 
namespace Mantid {
namespace Kernel {
class MANTID_KERNEL_DLL ThreadSafeLogStreamBuf : public Poco::LogStreamBuf {
public:
  ThreadSafeLogStreamBuf(Poco::Logger &logger, Poco::Message::Priority priority);
  int overflow(char c);
  using Poco::LogStreamBuf::overflow;
  void accumulate(const std::string &message);
  std::string flush();
 
private:
  int writeToDevice(char c) override;
 
private:
  std::map<Poco::Thread::TID, std::string> m_messages;
  std::map<Poco::Thread::TID, std::string> m_accumulator;
  std::mutex m_mutex;
};
 
class MANTID_KERNEL_DLL ThreadSafeLogIOS : public virtual std::ios {
public:
  ThreadSafeLogIOS(Poco::Logger &logger, Poco::Message::Priority priority);
  // Return a pointer to the stream buffer object
  Poco::LogStreamBuf *rdbuf();
 
protected:
  ThreadSafeLogStreamBuf m_buf;
};
 
class MANTID_KERNEL_DLL ThreadSafeLogStream : public ThreadSafeLogIOS, public std::ostream {
public:
  ThreadSafeLogStream(Poco::Logger &logger, Poco::Message::Priority priority = Poco::Message::PRIO_INFORMATION);
 
  ThreadSafeLogStream(const std::string &loggerName,
                      Poco::Message::Priority priority = Poco::Message::PRIO_INFORMATION);
  ThreadSafeLogStream &fatal();
  ThreadSafeLogStream &fatal(const std::string &message);
  ThreadSafeLogStream &critical();
  ThreadSafeLogStream &critical(const std::string &message);
  ThreadSafeLogStream &error();
  ThreadSafeLogStream &error(const std::string &message);
  ThreadSafeLogStream &warning();
  ThreadSafeLogStream &warning(const std::string &message);
  ThreadSafeLogStream &notice();
  ThreadSafeLogStream &notice(const std::string &message);
  ThreadSafeLogStream &information();
  ThreadSafeLogStream &information(const std::string &message);
  ThreadSafeLogStream &debug();
  ThreadSafeLogStream &debug(const std::string &message);
  ThreadSafeLogStream &priority(Poco::Message::Priority priority);
  ThreadSafeLogStream &accumulate(const std::string &message);
  std::string flush();
};
} // namespace Kernel
} // namespace Mantid