AthMessaging.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// AthMessaging.h 
// Header file for class AthMessaging
// Author: S.Binet<binet@cern.ch>, Frank Winklmeier
#ifndef ATHENABASECOMPS_ATHMESSAGING_H
#define ATHENABASECOMPS_ATHMESSAGING_H 1
 
// STL includes
#include <iosfwd>
#include <string>
#include <atomic>
 
// framework includes
#include "GaudiKernel/IMessageSvc.h"
#include "GaudiKernel/MsgStream.h"
#include "Gaudi/Property.h"
#include "AthenaBaseComps/AthMsgStreamMacros.h"
#include "CxxUtils/checker_macros.h"
 
#include <boost/thread/tss.hpp>
 

class AthMessaging
{ 

  // Public methods: 
 public: 

  AthMessaging (IMessageSvc* msgSvc, const std::string& name);

  AthMessaging (const std::string& name);

  virtual ~AthMessaging(); 

  // Const methods: 

  bool 
  msgLvl (const MSG::Level lvl) const;

  MsgStream& msg() const;

  MsgStream& 
  msg (const MSG::Level lvl) const;

  // Non-const methods: 

  void setLevel (MSG::Level lvl);

  // Private methods: 
 private: 

  AthMessaging(); //> not implemented
  AthMessaging( const AthMessaging& rhs ); //> not implemented
  AthMessaging& operator=( const AthMessaging& rhs ); //> not implemented

  void initMessaging() const;

  // Private data: 
 private: 

  std::string m_nm;

  mutable boost::thread_specific_ptr<MsgStream> m_msg_tls;

  mutable std::atomic<IMessageSvc*> m_imsg{ nullptr };

  mutable std::atomic<MSG::Level> m_lvl{ MSG::NIL };

  mutable std::atomic_flag m_initialized ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT;
 
}; 

// Inline methods: 
 
inline
bool
AthMessaging::msgLvl (const MSG::Level lvl) const
{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}
 
inline
MsgStream&
AthMessaging::msg() const 
{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}
 
inline
MsgStream&
AthMessaging::msg (const MSG::Level lvl) const 
{ return msg() << lvl; }
 
 
#endif //> !ATHENABASECOMPS_ATHMESSAGING_H