edm::MessageLoggerQ Class Reference

#include <MessageLoggerQ.h>

Public Types
enum	OpCode {   END_THREAD, LOG_A_MESSAGE, CONFIGURE, EXTERN_DEST,   SUMMARIZE, JOBMODE, SHUT_UP, FLUSH_LOG_Q,   GROUP_STATS, FJR_SUMMARY }

Static Public Member Functions
static bool	handshaked (const OpCode &op)
static bool	ignore (edm::ELseverityLevel const &severity, std::string const &category)
static MessageLoggerQ *	instance ()
static void	MLqCFG (ParameterSet *p)
static void	MLqEND ()
static void	MLqFLS ()
static void	MLqGRP (std::string *cat_p)
static void	MLqJRS (std::map< std::string, double > *sum_p)
static void	MLqLOG (ErrorObj *p)
static void	MLqMOD (std::string *jm)
static void	MLqSHT ()
static void	MLqSUM ()
static void	setMLscribe_ptr (std::shared_ptr< edm::service::AbstractMLscribe > m)
static void	squelch (std::string const &category)
static void	standAloneThreshold (edm::ELseverityLevel const &severity)

Private Member Functions
	MessageLoggerQ ()
	MessageLoggerQ (MessageLoggerQ const &)=delete
void	operator= (MessageLoggerQ const &)=delete
	~MessageLoggerQ ()

Static Private Member Functions
static void	handshakedCommand (OpCode opcode, void *operand, std::string const &commandMnemonic)
static void	simpleCommand (OpCode opcode, void *operand)

Static Private Attributes
static std::shared_ptr< edm::service::AbstractMLscribe >	mlscribe_ptr = obtainStandAloneScribePtr()
static std::set< std::string >	squelchSet
static edm::ELseverityLevel	threshold

Detailed Description

Definition at line 23 of file MessageLoggerQ.h.

Member Enumeration Documentation

enum edm::MessageLoggerQ::OpCode

Enumerator
END_THREAD
LOG_A_MESSAGE
CONFIGURE
EXTERN_DEST
SUMMARIZE
JOBMODE
SHUT_UP
FLUSH_LOG_Q
GROUP_STATS
FJR_SUMMARY

Definition at line 26 of file MessageLoggerQ.h.

    { END_THREAD  // END
      ,
      LOG_A_MESSAGE  // LOG
      ,
      CONFIGURE  // CFG -- handshaked
      ,
      EXTERN_DEST  // EXT
      ,
      SUMMARIZE  // SUM
      ,
      JOBMODE  // MOD
      ,
      SHUT_UP  // SHT
      ,
      FLUSH_LOG_Q  // FLS -- handshaked
      ,
      GROUP_STATS  // GRP
      ,
      FJR_SUMMARY  // JRS -- handshaked
    };             // OpCode

Constructor & Destructor Documentation

MessageLoggerQ::MessageLoggerQ ( )

private

Definition at line 115 of file MessageLoggerQ.cc.

{}

MessageLoggerQ::~MessageLoggerQ ( )

private

Definition at line 117 of file MessageLoggerQ.cc.

{}

edm::MessageLoggerQ::MessageLoggerQ ( MessageLoggerQ const &  )

privatedelete

Member Function Documentation

bool MessageLoggerQ::handshaked ( const OpCode &  op )

static

Definition at line 186 of file MessageLoggerQ.cc.

References edm::ELseverityLevel::ELsev_warning, squelchSet, and threshold.

Referenced by edm::service::MainThreadMLscribe::runCommand().

{
  return ((op == CONFIGURE) || (op == FLUSH_LOG_Q) || (op == FJR_SUMMARY));
}  // MessageLoggerQ::handshaked(op)

void MessageLoggerQ::handshakedCommand ( OpCode  opcode, void *  operand, std::string const &  commandMnemonic  )

staticprivate

Definition at line 138 of file MessageLoggerQ.cc.

References beam_dqm_sourceclient-live_cfg::cerr, and cms::Exception::what().

                                                                         {  // Change Log 10
  try {
    mlscribe_ptr->runCommand(opcode, operand);
  } catch (edm::Exception &ex) {
    ex << "\n The preceding exception was thrown in MessageLoggerScribe\n";
    ex << "and forwarded to the main thread from the Messages thread.";
    std::cerr << "exception from MessageLoggerQ::" << commandMnemonic << " - exception what() is \n" << ex.what();
    // TODO - get the above text into the what itself
    throw ex;
  }
}  // handshakedCommand

bool MessageLoggerQ::ignore ( edm::ELseverityLevel const &  severity, std::string const &  category  )

static

Definition at line 196 of file MessageLoggerQ.cc.

References MessageLogger_cff::threshold.

                                                                                         {
  if (severity < threshold)
    return true;
  if (squelchSet.count(category) > 0)
    return true;
  return false;
}

MessageLoggerQ * MessageLoggerQ::instance ( )

static

Definition at line 119 of file MessageLoggerQ.cc.

References CMS_THREAD_SAFE, and createBeamHaloJobs::queue.

                                         {
  CMS_THREAD_SAFE static MessageLoggerQ queue;
  return &queue;
}  // MessageLoggerQ::instance()

void MessageLoggerQ::MLqCFG ( ParameterSet *  p )

static

Definition at line 160 of file MessageLoggerQ.cc.

Referenced by edm::service::MessageLogger::MessageLogger().

{ handshakedCommand(CONFIGURE, p, "CFG"); }  // MessageLoggerQ::CFG()

void MessageLoggerQ::MLqEND ( )

static

Definition at line 152 of file MessageLoggerQ.cc.

Referenced by run_app(), edm::service::MessageServicePresence::~MessageServicePresence(), and edm::service::SingleThreadMSPresence::~SingleThreadMSPresence().

{ simpleCommand(END_THREAD, (void *)nullptr); }  // MessageLoggerQ::END()

void MessageLoggerQ::MLqFLS ( )

static

Definition at line 168 of file MessageLoggerQ.cc.

Referenced by edm::FlushMessageLog().

{
  // The ConfigurationHandshake, developed for synchronous CFG, contains a
  // place to convey exception information.  FLS does not need this, nor does
  // it need the parameter set, but we are reusing ConfigurationHandshake
  // rather than reinventing the mechanism.
  handshakedCommand(FLUSH_LOG_Q, nullptr, "FLS");
}  // MessageLoggerQ::FLS()

void MessageLoggerQ::MLqGRP ( std::string *  cat_p )

static

Definition at line 177 of file MessageLoggerQ.cc.

Referenced by edm::GroupLogStatistics().

{
  simpleCommand(GROUP_STATS, static_cast<void *>(cat_p));
}  // MessageLoggerQ::GRP()

void MessageLoggerQ::MLqJRS ( std::map< std::string, double > *  sum_p )

static

Definition at line 182 of file MessageLoggerQ.cc.

Referenced by edm::service::MessageLogger::SummarizeInJobReport().

                                                            {
  handshakedCommand(FJR_SUMMARY, sum_p, "JRS");
}  // MessageLoggerQ::CFG()

void MessageLoggerQ::MLqLOG ( ErrorObj *  p )

static

Definition at line 156 of file MessageLoggerQ.cc.

Referenced by edm::MessageSender::ErrorObjDeleter::operator()().

                                       {
  simpleCommand(LOG_A_MESSAGE, static_cast<void *>(p));
}  // MessageLoggerQ::LOG()

void MessageLoggerQ::MLqMOD ( std::string *  jm )

static

Definition at line 164 of file MessageLoggerQ.cc.

Referenced by edm::service::MessageLogger::MessageLogger().

                                         {
  simpleCommand(JOBMODE, static_cast<void *>(jm));
}  // MessageLoggerQ::MOD()

void MessageLoggerQ::MLqSHT ( )

static

Definition at line 154 of file MessageLoggerQ.cc.

Referenced by edm::HaltMessageLogging().

{ simpleCommand(SHUT_UP, (void *)nullptr); }  // MessageLoggerQ::SHT()

void MessageLoggerQ::MLqSUM ( )

static

Definition at line 162 of file MessageLoggerQ.cc.

Referenced by edm::service::MessageLogger::jobFailure(), edm::LogStatistics(), and edm::service::MessageLogger::postEndJob().

{ simpleCommand(SUMMARIZE, nullptr); }  // MessageLoggerQ::SUM()

void edm::MessageLoggerQ::operator= ( MessageLoggerQ const &  )

privatedelete

void MessageLoggerQ::setMLscribe_ptr ( std::shared_ptr< edm::service::AbstractMLscribe >  m )

static

Definition at line 124 of file MessageLoggerQ.cc.

References visualization-live-secondInstance_cfg::m.

Referenced by edm::service::MessageServicePresence::MessageServicePresence(), run_app(), edm::service::SingleThreadMSPresence::SingleThreadMSPresence(), edm::service::MessageServicePresence::~MessageServicePresence(), and edm::service::SingleThreadMSPresence::~SingleThreadMSPresence().

{
  if (!m) {
    mlscribe_ptr = obtainStandAloneScribePtr();
  } else {
    mlscribe_ptr = m;
  }
}  // MessageLoggerQ::setMLscribe_ptr(m)

void MessageLoggerQ::simpleCommand ( OpCode  opcode, void *  operand  )

staticprivate

Definition at line 133 of file MessageLoggerQ.cc.

{
  mlscribe_ptr->runCommand(opcode, operand);
}  // simpleCommand

void MessageLoggerQ::squelch ( std::string const &  category )

static

Definition at line 195 of file MessageLoggerQ.cc.

Referenced by edm::squelchStandAloneMessageCategory().

{ squelchSet.insert(category); }

void MessageLoggerQ::standAloneThreshold ( edm::ELseverityLevel const &  severity )

static

Definition at line 194 of file MessageLoggerQ.cc.

References HLT_2018_cff::severity, and MessageLogger_cff::threshold.

Referenced by edm::setStandAloneMessageThreshold().

{ threshold = severity; }

Member Data Documentation

std::shared_ptr< edm::service::AbstractMLscribe > MessageLoggerQ::mlscribe_ptr = obtainStandAloneScribePtr()

staticprivate

Definition at line 87 of file MessageLoggerQ.h.

std::set< std::string > MessageLoggerQ::squelchSet

staticprivate

Definition at line 89 of file MessageLoggerQ.h.

Referenced by handshaked().

edm::ELseverityLevel MessageLoggerQ::threshold

staticprivate

Definition at line 88 of file MessageLoggerQ.h.

Referenced by utils.StatisticalTest::get_status(), and handshaked().