Service that monitor the time taken by processing of single events using a separate thread. More...

#include </builds/gaudi/Gaudi/GaudiUtils/src/component/StalledEventMonitor.h>

Inheritance diagram for StalledEventMonitor:

[legend]

Collaboration diagram for StalledEventMonitor:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialization of the service. More...

StatusCode	start () override
	Start the watchdog thread (before entering the event loop). More...

void	handle (const Incident &) override
	Notify the watchdog thread for a new event. More...

StatusCode	stop () override
	Stop the watchdog thread (after the event loop). More...

StatusCode	finalize () override
	Finalization of the service. More...

Public Member Functions inherited from extends< Service, IIncidentListener >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service More...

StatusCode	sysStart () override
	Initialize Service More...

StatusCode	sysStop () override
	Initialize Service More...

StatusCode	sysFinalize () override
	Finalize Service More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Attributes
Gaudi::Property< unsigned int >	m_eventTimeout

Gaudi::Property< int >	m_maxTimeoutCount

Gaudi::Property< bool >	m_stackTrace

std::unique_ptr< WatchdogThread >	m_watchdog
	Pointer to the watchdog thread that checks for the event timeout. More...

SmartIF< IIncidentSvc >	m_incidentSvc
	Pointer to the incident service. More...

Additional Inherited Members
Public Types inherited from extends< Service, IIncidentListener >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override
	Standard Destructor More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Service that monitor the time taken by processing of single events using a separate thread.

See also: WatchdogThread

Author: Marco Clemencic

Date: Apr 19, 2010

Definition at line 39 of file StalledEventMonitor.h.

Member Function Documentation

◆ finalize()

StatusCode StalledEventMonitor::finalize ( )

override

Finalization of the service.

Definition at line 133 of file StalledEventMonitor.cpp.

                                          {
   // destroy the watchdog thread (if any)
   m_watchdog.reset();
   // unregistering from the IncidentSvc
   m_incidentSvc->removeListener( this, IncidentType::BeginEvent );
   m_incidentSvc.reset();
   return base_class::finalize();
 }

◆ handle()

void StalledEventMonitor::handle ( const Incident & )

override

Notify the watchdog thread for a new event.

Definition at line 122 of file StalledEventMonitor.cpp.

                                                     {
   if ( m_watchdog ) m_watchdog->ping();
 }

◆ initialize()

StatusCode StalledEventMonitor::initialize ( )

override

Initialization of the service.

Prepare the watchdog thread and configures it.

Definition at line 88 of file StalledEventMonitor.cpp.

                                            {
   StatusCode sc = base_class::initialize();
   if ( sc.isFailure() ) return sc;
  
   warning() << "the service StalledEventMonitor is deprecated, please use Gaudi::EventWatchdogAlg" << endmsg;
  
   if ( m_eventTimeout ) {
     // create the watchdog thread
     m_watchdog = std::make_unique<EventWatchdog>(
         msgSvc(), "EventWatchdog", std::chrono::seconds( m_eventTimeout.value() ), m_stackTrace, m_maxTimeoutCount );
  
     // register to the incident service
     static const std::string serviceName = "IncidentSvc";
     m_incidentSvc                        = serviceLocator()->service( serviceName );
     if ( !m_incidentSvc ) {
       error() << "Cannot retrieve " << serviceName << endmsg;
       return StatusCode::FAILURE;
     }
     debug() << "Register to the IncidentSvc" << endmsg;
     m_incidentSvc->addListener( this, IncidentType::BeginEvent );
   } else {
     warning() << "StalledEventMonitor/" << name() << " instantiated with 0 time-out: no monitoring performed" << endmsg;
   }
  
   return StatusCode::SUCCESS;
 }

◆ start()

StatusCode StalledEventMonitor::start ( )

override

Start the watchdog thread (before entering the event loop).

Definition at line 116 of file StalledEventMonitor.cpp.

                                       {
   if ( m_watchdog ) m_watchdog->start();
   return StatusCode::SUCCESS;
 }

◆ stop()

StatusCode StalledEventMonitor::stop ( )

override

Stop the watchdog thread (after the event loop).

Definition at line 127 of file StalledEventMonitor.cpp.

                                      {
   if ( m_watchdog ) m_watchdog->stop();
   return StatusCode::SUCCESS;
 }

Member Data Documentation

◆ m_eventTimeout

Gaudi::Property<unsigned int> StalledEventMonitor::m_eventTimeout

private

Initial value:

{ this, "EventTimeout", 600,
                                                "[[deprecated]] **use Gaudi::EventWatchdogAlg** - Number of seconds "
                                                "allowed to process a single event (0 to disable the check)." }

Definition at line 61 of file StalledEventMonitor.h.

◆ m_incidentSvc

SmartIF<IIncidentSvc> StalledEventMonitor::m_incidentSvc

private

Pointer to the incident service.

Definition at line 75 of file StalledEventMonitor.h.

◆ m_maxTimeoutCount

Gaudi::Property<int> StalledEventMonitor::m_maxTimeoutCount

private

Initial value:

{ this, "MaxTimeoutCount", 0,
                                          "[[deprecated]] **use Gaudi::EventWatchdogAlg** - Number timeouts before "
                                                   "aborting the execution (0 means never abort)." }

Definition at line 64 of file StalledEventMonitor.h.

◆ m_stackTrace

Gaudi::Property<bool> StalledEventMonitor::m_stackTrace

private

Initial value:

{
      this, "StackTrace", false,
      "[[deprecated]] **use Gaudi::EventWatchdogAlg** - Whether to print the stack-trace on timeout." }

Definition at line 67 of file StalledEventMonitor.h.

◆ m_watchdog

std::unique_ptr<WatchdogThread> StalledEventMonitor::m_watchdog

private

Pointer to the watchdog thread that checks for the event timeout.

Definition at line 72 of file StalledEventMonitor.h.

The documentation for this class was generated from the following files:

GaudiUtils/src/component/StalledEventMonitor.h
GaudiUtils/src/component/StalledEventMonitor.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ finalize()

◆ handle()

◆ initialize()

◆ start()

◆ stop()

Member Data Documentation

◆ m_eventTimeout

◆ m_incidentSvc

◆ m_maxTimeoutCount

◆ m_stackTrace

◆ m_watchdog