mf Namespace Reference

Namespaces
	detail
	errors
	priv
	service

Classes
class	ELextendedID
class	ELseverityLevel
struct	ELslProxy
class	ErrorObj
struct	file_mfPluginConfig
struct	file_mfStatsPluginConfig
struct	FinalShutdown
class	MaybeLogger_
struct	MFConfig
struct	MFDestinationConfig
class	NeverLogger_

Typedefs
using	LogDebug = MaybeLogger_< ELseverityLevel::ELsev_success, false >
using	LogInfo = MaybeLogger_< ELseverityLevel::ELsev_info, false >
using	LogWarning = MaybeLogger_< ELseverityLevel::ELsev_warning, false >
using	LogError = MaybeLogger_< ELseverityLevel::ELsev_error, false >
using	LogSystem = MaybeLogger_< ELseverityLevel::ELsev_severe, false >
using	LogTrace = MaybeLogger_< ELseverityLevel::ELsev_success, true >
using	LogVerbatim = MaybeLogger_< ELseverityLevel::ELsev_info, true >
using	LogPrint = MaybeLogger_< ELseverityLevel::ELsev_warning, true >
using	LogProblem = MaybeLogger_< ELseverityLevel::ELsev_error, true >
using	LogAbsolute = MaybeLogger_< ELseverityLevel::ELsev_severe, true >
using	ELslGen) = ELseverityLevel(
using	Exception = cet::coded_exception< errors::error, detail::translate >

Functions
bool	isMessageProcessingSetUp ()
void	LogErrorObj (ErrorObj *msg)
void	LogStatistics ()
void	FlushMessageLog ()
void	StartMessageFacility (fhicl::ParameterSet const &pset, string const &applicationName)
void	EndMessageFacility ()
void	SetApplicationName (string const &applicationName)
void	SetHostName (string const &hostname)
void	SetHostAddr (string const &hostaddr)
void	SetPid (long const pid)
string const &	GetApplicationName ()
string const &	GetHostName ()
string const &	GetHostAddr ()
long	GetPid ()
void	SetContextIteration (string const &val)
void	SetIteration (string const &val)
string const &	GetIteration ()
void	SetContextSinglet (string const &val)
void	SetModuleName (string const &val)
string const &	GetModuleName ()
bool	isDebugEnabled ()
bool	isInfoEnabled ()
bool	isWarningEnabled ()
std::ostringstream &	getStringStream (std::string const &psetName)
ostream &	operator<< (ostream &os, ELseverityLevel const sev)
ELseverityLevel constexpr	ELzeroSeverityGen ()
ELseverityLevel constexpr	ELsuccessGen ()
ELseverityLevel constexpr	ELdebugGen ()
ELseverityLevel constexpr	ELinfoGen ()
ELseverityLevel constexpr	ELwarningGen ()
ELseverityLevel constexpr	ELerrorGen ()
ELseverityLevel constexpr	ELunspecifiedGen ()
ELseverityLevel constexpr	ELsevereGen ()
ELseverityLevel constexpr	ELhighestSeverityGen ()
bool	operator== (ELseverityLevel e1, ELseverityLevel e2)
bool	operator!= (ELseverityLevel e1, ELseverityLevel e2)
bool	operator< (ELseverityLevel e1, ELseverityLevel e2)
bool	operator<= (ELseverityLevel e1, ELseverityLevel e2)
bool	operator> (ELseverityLevel e1, ELseverityLevel e2)
bool	operator>= (ELseverityLevel e1, ELseverityLevel e2)
ErrorObj &	operator<< (ErrorObj &e, char const *s)
template<class T >
ErrorObj &	operator<< (ErrorObj &e, T const &t)

Variables
static struct mf::FinalShutdown	ensureShutdown
ELslProxy< ELzeroSeverityGen > constexpr	ELzeroSeverity {}
ELslProxy< ELdebugGen > constexpr	ELdebug {}
ELslProxy< ELsuccessGen > constexpr	ELsuccess {}
ELslProxy< ELinfoGen > constexpr	ELinfo {}
ELslProxy< ELwarningGen > constexpr	ELwarning {}
ELslProxy< ELerrorGen > constexpr	ELerror {}
ELslProxy< ELunspecifiedGen > constexpr	ELunspecified {}
ELslProxy< ELsevereGen > constexpr	ELsevere {}
ELslProxy< ELhighestSeverityGen > constexpr	ELhighestSeverity {}
static atomic< int >	ourSerial {0}

Typedef Documentation

using mf::ELslGen = typedef ELseverityLevel(

Definition at line 12 of file ELseverityLevel.h.

using mf::Exception = typedef cet::coded_exception<errors::error, detail::translate>

Definition at line 17 of file exception.h.

using mf::LogAbsolute = typedef MaybeLogger_<ELseverityLevel::ELsev_severe, true>

Definition at line 219 of file MessageLogger.h.

using mf::LogDebug = typedef MaybeLogger_<ELseverityLevel::ELsev_success, false>

Definition at line 208 of file MessageLogger.h.

using mf::LogError = typedef MaybeLogger_<ELseverityLevel::ELsev_error, false>

Definition at line 211 of file MessageLogger.h.

using mf::LogInfo = typedef MaybeLogger_<ELseverityLevel::ELsev_info, false>

Definition at line 209 of file MessageLogger.h.

using mf::LogPrint = typedef MaybeLogger_<ELseverityLevel::ELsev_warning, true>

Definition at line 217 of file MessageLogger.h.

using mf::LogProblem = typedef MaybeLogger_<ELseverityLevel::ELsev_error, true>

Definition at line 218 of file MessageLogger.h.

using mf::LogSystem = typedef MaybeLogger_<ELseverityLevel::ELsev_severe, false>

Definition at line 212 of file MessageLogger.h.

using mf::LogTrace = typedef MaybeLogger_<ELseverityLevel::ELsev_success, true>

Definition at line 215 of file MessageLogger.h.

using mf::LogVerbatim = typedef MaybeLogger_<ELseverityLevel::ELsev_info, true>

Definition at line 216 of file MessageLogger.h.

using mf::LogWarning = typedef MaybeLogger_<ELseverityLevel::ELsev_warning, false>

Definition at line 210 of file MessageLogger.h.

Function Documentation

ELseverityLevel constexpr mf::ELdebugGen ( )

inline

Definition at line 77 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_success.

  {
    return ELseverityLevel::ELsev_success;
  }

ELseverityLevel constexpr mf::ELerrorGen ( )

inline

Definition at line 92 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_error.

  {
    return ELseverityLevel::ELsev_error;
  }

ELseverityLevel constexpr mf::ELhighestSeverityGen ( )

inline

Definition at line 107 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_highestSeverity.

  {
    return ELseverityLevel::ELsev_highestSeverity;
  }

ELseverityLevel constexpr mf::ELinfoGen ( )

inline

Definition at line 82 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_info.

  {
    return ELseverityLevel::ELsev_info;
  }

ELseverityLevel constexpr mf::ELsevereGen ( )

inline

Definition at line 102 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_severe.

  {
    return ELseverityLevel::ELsev_severe;
  }

ELseverityLevel constexpr mf::ELsuccessGen ( )

inline

Definition at line 72 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_success.

  {
    return ELseverityLevel::ELsev_success;
  }

ELseverityLevel constexpr mf::ELunspecifiedGen ( )

inline

Definition at line 97 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_unspecified.

  {
    return ELseverityLevel::ELsev_unspecified;
  }

ELseverityLevel constexpr mf::ELwarningGen ( )

inline

Definition at line 87 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_warning.

  {
    return ELseverityLevel::ELsev_warning;
  }

ELseverityLevel constexpr mf::ELzeroSeverityGen ( )

inline

Definition at line 67 of file ELseverityLevel.h.

References mf::ELseverityLevel::ELsev_zeroSeverity.

  {
    return ELseverityLevel::ELsev_zeroSeverity;
  }

void mf::EndMessageFacility

(

)

Definition at line 502 of file MessageLogger.cc.

Referenced by main(), and mf::FinalShutdown::~FinalShutdown().

  {
    isStarted.store(false);
    // FIXME: The finish() call in all known uses does nothing, the destination
    //        dtor can probably handle this, remove!
    for (auto& category_and_destination : destinations_) {
      category_and_destination.second->finish();
    }
  }

void mf::FlushMessageLog

(

)

Definition at line 453 of file MessageLogger.cc.

  {}

std::string const & mf::GetApplicationName

(

)

Definition at line 542 of file MessageLogger.cc.

  {
    return application_;
  }

std::string const & mf::GetHostAddr

(

)

Definition at line 556 of file MessageLogger.cc.

  {
    return hostaddr_;
  }

std::string const & mf::GetHostName

(

)

Definition at line 549 of file MessageLogger.cc.

  {
    return hostname_;
  }

std::string const & mf::GetIteration

(

)

Definition at line 586 of file MessageLogger.cc.

Referenced by mfplugins::ELsyslog::fillPrefix(), and mf::MaybeLogger_< SEV, VERBATIM >::~MaybeLogger_().

  {
    return iteration_;
  }

std::string const & mf::GetModuleName

(

)

Definition at line 607 of file MessageLogger.cc.

Referenced by mf::MaybeLogger_< SEV, VERBATIM >::~MaybeLogger_().

  {
    return module_;
  }

long mf::GetPid

(

)

Definition at line 563 of file MessageLogger.cc.

  {
    return pid_;
  }

ostringstream & mf::getStringStream

(

std::string const &

psetName

)

Definition at line 15 of file stringstream.cc.

References art::errors::Configuration, and mf::priv::streams.

{
  auto const I = streams.find(psetName);
  if (I != streams.end()) {
    return dynamic_cast<ostringstream&>(static_cast<ostream&>(I->second));
  }
  throw Exception(errors::Configuration, "mf::getStringStream:")
    << "Unable to find specified messagefacility logging stream \"" << psetName
    << ":\" please ensure it has been configured as a destination.";
}

bool mf::isDebugEnabled

(

)

Definition at line 617 of file MessageLogger.cc.

Referenced by larg4::LArVoxelReadoutGeometry::Construct(), trkf::Track3DKalmanHitAlg::makeKalmanTracks(), trkf::SpacePointAlg::makeSpacePoints(), trkf::Track3DKalmanHitAlg::makeSurface(), trkf::TrackKalmanCheater::produce(), and trkf::Track3DKalmanSPS::produce().

  {
    return false;
  }

bool mf::isInfoEnabled

(

)

Definition at line 627 of file MessageLogger.cc.

  {
    return true;
  }

bool mf::isMessageProcessingSetUp

(

)

Definition at line 414 of file MessageLogger.cc.

  {
    return isStarted.load();
  }

bool mf::isWarningEnabled

(

)

Definition at line 637 of file MessageLogger.cc.

  {
    return true;
  }

void mf::LogErrorObj

(

ErrorObj *

msg

)

Definition at line 421 of file MessageLogger.cc.

References mf::ErrorObj::fullText(), mf::ELseverityLevel::getSymbol(), mf::ELextendedID::id(), mf::ErrorObj::idOverflow(), mf::ErrorObj::is_verbatim(), mf::ELextendedID::severity(), and mf::ErrorObj::xid().

Referenced by mf::MaybeLogger_< SEV, VERBATIM >::~MaybeLogger_().

  {
    if (isStarted.load()) {
      logMessage(msg);
      return;
    }
    if (msg->is_verbatim()) {
      ostringstream buf;
      buf << msg->fullText() << '\n';
      cerr << buf.str();
    } else {
      ostringstream buf;
      buf << "%MSG" << msg->xid().severity().getSymbol() << ' '
          << msg->xid().id() << msg->idOverflow() << ": \n"
          << msg->fullText() << "\n"
          << "%MSG\n";
      cerr << buf.str();
    }
    delete msg;
  }

void mf::LogStatistics

(

)

Definition at line 444 of file MessageLogger.cc.

Referenced by art::EventProcessor::endJob().

  {
    if (isStarted.load()) {
      summarize();
    }
  }

bool mf::operator!= ( ELseverityLevel  e1, ELseverityLevel  e2  )

inline

Definition at line 177 of file ELseverityLevel.h.

References mf::ELseverityLevel::cmp().

  {
    return e1.cmp(e2) != 0;
  }

bool mf::operator< ( ELseverityLevel  e1, ELseverityLevel  e2  )

inline

Definition at line 183 of file ELseverityLevel.h.

References mf::ELseverityLevel::cmp().

  {
    return e1.cmp(e2) < 0;
  }

template<class T >

ErrorObj& mf::operator<<	(	ErrorObj &	e,
		T const &	t
	)

Definition at line 111 of file ErrorObj.h.

References mf::ErrorObj::opltlt().

  {
    return e.opltlt(t);
  }

ostream& mf::operator<<	(	std::ostream &	os,
		ELseverityLevel const	sev
	)

Definition at line 214 of file ELseverityLevel.cc.

References mf::ELseverityLevel::getName().

  {
    return os << " -" << sev.getName() << "- ";
  }

ErrorObj & mf::operator<<	(	ErrorObj &	e,
		char const *	s
	)

Definition at line 275 of file ErrorObj.cc.

References mf::ErrorObj::opltlt().

  {
    return e.opltlt(s);
  }

bool mf::operator<= ( ELseverityLevel  e1, ELseverityLevel  e2  )

inline

Definition at line 189 of file ELseverityLevel.h.

References mf::ELseverityLevel::cmp().

  {
    return e1.cmp(e2) <= 0;
  }

bool mf::operator== ( ELseverityLevel  e1, ELseverityLevel  e2  )

inline

Definition at line 171 of file ELseverityLevel.h.

References mf::ELseverityLevel::cmp().

  {
    return e1.cmp(e2) == 0;
  }

bool mf::operator> ( ELseverityLevel  e1, ELseverityLevel  e2  )

inline

Definition at line 195 of file ELseverityLevel.h.

References mf::ELseverityLevel::cmp().

  {
    return e1.cmp(e2) > 0;
  }

bool mf::operator>= ( ELseverityLevel  e1, ELseverityLevel  e2  )

inline

Definition at line 201 of file ELseverityLevel.h.

References mf::ELseverityLevel::cmp().

  {
    return e1.cmp(e2) >= 0;
  }

void mf::SetApplicationName

(

string const &

applicationName

)

Definition at line 514 of file MessageLogger.cc.

Referenced by testing::BasicEnvironmentConfiguration::BasicEnvironmentConfiguration(), testing::BasicEnvironmentConfiguration::DefaultInit(), lar::standalone::SetupMessageFacility(), and testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

  {
    application_ = applicationName;
  }

void mf::SetContextIteration

(

string const &

val

)

Definition at line 572 of file MessageLogger.cc.

Referenced by lar::standalone::SetupMessageFacility(), and testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

  {
    iteration_ = val;
  }

void mf::SetContextSinglet

(

string const &

val

)

Definition at line 594 of file MessageLogger.cc.

Referenced by lar::standalone::SetupMessageFacility(), and testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

  {
    module_ = val;
  }

void mf::SetHostAddr

(

string const &

hostaddr

)

Definition at line 528 of file MessageLogger.cc.

  {
    hostaddr_ = hostaddr;
  }

void mf::SetHostName

(

string const &

hostname

)

Definition at line 521 of file MessageLogger.cc.

  {
    hostname_ = hostname;
  }

void mf::SetIteration

(

string const &

val

)

Definition at line 580 of file MessageLogger.cc.

Referenced by main(), art::MFSU_0_ARG_UPDATER_DEFN(), art::MFSU_1_ARG_UPDATER_DEFN(), art::MFSU_2_ARG_UPDATER_DEFN(), and art::run_art().

  {
    iteration_ = val;
  }

void mf::SetModuleName

(

string const &

val

)

Definition at line 601 of file MessageLogger.cc.

Referenced by art::MFSU_0_ARG_UPDATER_DEFN(), art::MFSU_1_ARG_UPDATER_DEFN(), and art::MFSU_2_ARG_UPDATER_DEFN().

  {
    module_ = val;
  }

void mf::SetPid

(

long const

pid

)

Definition at line 535 of file MessageLogger.cc.

  {
    pid_ = pid;
  }

void mf::StartMessageFacility	(	fhicl::ParameterSet const &	pset,
		string const &	applicationName
	)

Definition at line 458 of file MessageLogger.cc.

References art::errors::Configuration, e, mf::errors::OtherError, and fhicl::detail::validationException::what().

Referenced by main(), art::run_art(), lar::standalone::SetupMessageFacility(), and testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

  {
    if (isStarted.load()) {
      return;
    }

    cet::BasicPluginFactory pluginFactory{getPluginPath(), "mfPlugin"};
    cet::BasicPluginFactory pluginStatsFactory{getPluginPath(),
                                               "mfStatsPlugin"};

    // FIXME: We should not have to call StartMessageFacility() to get these
    // initialized!
    initGlobalVars(applicationName);
    try {
      destinations_["cerr_early"s] = makePlugin_(
        pluginFactory, "cerr", "cerr_early", default_destination_config());
    }
    catch (fhicl::detail::validationException const& e) {
      string msg{"\nConfiguration error for destination: " +
                 cet::bold_fontify("cerr_early") + "\n\n"};
      msg += e.what();
      throw Exception(errors::Configuration) << msg;
    }
    try {
      // Note: We make all the destinations here.
      configure(
        MFDestinationConfig::Config{
          MFConfig::Parameters{pset}().destinations()},
        pluginFactory,
        pluginStatsFactory);
    }
    catch (Exception const& ex) {
      // FIXME: Hardly seems necessary to rethrow just to change the message to
      // say it was during configure!
      throw Exception(errors::OtherError,
                      "Exception from MessageLoggerScribe::configure",
                      ex);
    }
    isStarted.store(true);
  }

Variable Documentation

ELslProxy<ELdebugGen> constexpr mf::ELdebug {}

Definition at line 113 of file ELseverityLevel.h.

Referenced by mf::ErrorObj::setSeverity().

ELslProxy<ELerrorGen> constexpr mf::ELerror {}

Definition at line 117 of file ELseverityLevel.h.

ELslProxy<ELhighestSeverityGen> constexpr mf::ELhighestSeverity {}

Definition at line 120 of file ELseverityLevel.h.

Referenced by mf::ErrorObj::setSeverity().

ELslProxy<ELinfoGen> constexpr mf::ELinfo {}

Definition at line 115 of file ELseverityLevel.h.

ELslProxy<ELsevereGen> constexpr mf::ELsevere {}

Definition at line 119 of file ELseverityLevel.h.

Referenced by mf::ErrorObj::setSeverity().

ELslProxy<ELsuccessGen> constexpr mf::ELsuccess {}

Definition at line 114 of file ELseverityLevel.h.

ELslProxy<ELunspecifiedGen> constexpr mf::ELunspecified {}

Definition at line 118 of file ELseverityLevel.h.

ELslProxy<ELwarningGen> constexpr mf::ELwarning {}

Definition at line 116 of file ELseverityLevel.h.

Referenced by mf::service::ELdestination::flush().

ELslProxy<ELzeroSeverityGen> constexpr mf::ELzeroSeverity {}

Definition at line 112 of file ELseverityLevel.h.

Referenced by mf::ErrorObj::setSeverity(), and mf::service::ELdestination::summary().

struct mf::FinalShutdown mf::ensureShutdown

static

Referenced by mf::FinalShutdown::~FinalShutdown().

atomic<int> mf::ourSerial {0}

static

Definition at line 18 of file ErrorObj.cc.

Referenced by mf::ErrorObj::set().