logging.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_UTIL_LOGGING_HPP
#define NDN_CXX_UTIL_LOGGING_HPP
 
#include "ndn-cxx/detail/common.hpp"
 
#ifdef HAVE_NDN_CXX_CUSTOM_LOGGER
#include "ndn-cxx/util/custom-logging.hpp"
#else
 
#include <boost/log/sinks.hpp>
#include <mutex>
#include <set>
#include <unordered_map>
 
namespace ndn::util {
 
enum class LogLevel;
class Logger;
 
class Logging : noncopyable
{
public:
  [[nodiscard]] static std::set<std::string>
  getLoggerNames();
 
  static void
  setLevel(const std::string& prefix, LogLevel level);
 
  static void
  setLevel(const std::string& config);
 
  static void
  setDestination(boost::shared_ptr<boost::log::sinks::sink> destination);
 
  static void
  setDestination(std::ostream& os, bool wantAutoFlush);
 
  static void
  flush();
 
  [[nodiscard]] static boost::shared_ptr<boost::log::sinks::sink>
  makeDefaultStreamDestination(shared_ptr<std::ostream> os, bool wantAutoFlush = true);
 
private:
  Logging();
 
  void
  addLoggerImpl(Logger& logger);
 
  void
  registerLoggerNameImpl(std::string name);
 
  [[nodiscard]] std::set<std::string>
  getLoggerNamesImpl() const;
 
  LogLevel
  findLevel(std::string moduleName) const;
 
  void
  setLevelImpl(const std::string& prefix, LogLevel level);
 
  void
  setLevelImpl(const std::string& config);
 
  void
  setDestinationImpl(boost::shared_ptr<boost::log::sinks::sink> sink);
 
  void
  flushImpl();
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  static Logging&
  get();
 
#ifdef NDN_CXX_WITH_TESTS
  bool
  removeLogger(Logger& logger);
 
  void
  resetLevels();
 
  boost::shared_ptr<boost::log::sinks::sink>
  getDestination() const;
 
  void
  setLevelImpl(const std::unordered_map<std::string, LogLevel>& prefixRules);
 
  const std::unordered_map<std::string, LogLevel>&
  getLevels() const;
#endif // NDN_CXX_WITH_TESTS
 
private:
  friend Logger;
 
  mutable std::mutex m_mutex;
  std::unordered_map<std::string, LogLevel> m_enabledLevel; 
  std::unordered_multimap<std::string, Logger*> m_loggers; 
 
  boost::shared_ptr<boost::log::sinks::sink> m_destination;
};
 
inline std::set<std::string>
Logging::getLoggerNames()
{
  return get().getLoggerNamesImpl();
}
 
inline void
Logging::setLevel(const std::string& prefix, LogLevel level)
{
  get().setLevelImpl(prefix, level);
}
 
inline void
Logging::setLevel(const std::string& config)
{
  get().setLevelImpl(config);
}
 
inline void
Logging::setDestination(boost::shared_ptr<boost::log::sinks::sink> destination)
{
  get().setDestinationImpl(std::move(destination));
}
 
inline void
Logging::flush()
{
  get().flushImpl();
}
 
} // namespace ndn::util
 
#endif // HAVE_NDN_CXX_CUSTOM_LOGGER
 
#endif // NDN_CXX_UTIL_LOGGING_HPP