StalledEventMonitor Class Reference

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

#include <src/component/StalledEventMonitor.h>

Inheritance diagram for StalledEventMonitor:

Collaboration diagram for StalledEventMonitor:

Public Member Functions
	StalledEventMonitor (const std::string &name, ISvcLocator *svcLoc)
	Constructor. More...
	~StalledEventMonitor () override=default
	Destructor. More...
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< BASE, Interfaces >
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...
	~extends () override=default
	Virtual destructor. More...
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...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Attributes
unsigned int	m_eventTimeout
	Number of seconds allowed to process a single event. More...
int	m_maxTimeoutCount
	Number timeouts before aborting the execution (0 means never abort). More...
bool	m_stackTrace
	Whether to print a stack-trace on timeout. More...
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< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... 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 29 of file StalledEventMonitor.h.

Constructor & Destructor Documentation

StalledEventMonitor::StalledEventMonitor	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

Constructor.

Definition at line 84 of file StalledEventMonitor.cpp.

                                                                                  :
  base_class(name, svcLoc) {

  declareProperty("EventTimeout", m_eventTimeout = 600,
                  "Number of seconds allowed to process a single event (0 to disable the check).");

  declareProperty("MaxTimeoutCount", m_maxTimeoutCount = 0,
                  "Number timeouts before aborting the execution (0 means never abort).");

  declareProperty("StackTrace", m_stackTrace = false,
                  "Whether to print the stack-trace on timeout.");
}

StalledEventMonitor::~StalledEventMonitor ( )

overridedefault

Destructor.

Member Function Documentation

StatusCode StalledEventMonitor::finalize ( )

override

Finalization of the service.

Definition at line 146 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();
}

void StalledEventMonitor::handle ( const Incident &  )

override

Notify the watchdog thread for a new event.

Definition at line 135 of file StalledEventMonitor.cpp.

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

StatusCode StalledEventMonitor::initialize ( )

override

Initialization of the service.

Prepare the watchdog thread and configures it.

Definition at line 98 of file StalledEventMonitor.cpp.

                                           {
  StatusCode sc = base_class::initialize();
  if (sc.isFailure()) return sc;


  if (m_eventTimeout) {
    // create the watchdog thread
    m_watchdog.reset( new EventWatchdog(msgSvc(),
                                        "EventWatchdog",
                                        boost::posix_time::seconds(m_eventTimeout),
                                        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;
}

StatusCode StalledEventMonitor::start ( )

override

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

Definition at line 129 of file StalledEventMonitor.cpp.

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

StatusCode StalledEventMonitor::stop ( )

override

Stop the watchdog thread (after the event loop).

Definition at line 140 of file StalledEventMonitor.cpp.

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

Member Data Documentation

unsigned int StalledEventMonitor::m_eventTimeout

private

Number of seconds allowed to process a single event.

Definition at line 55 of file StalledEventMonitor.h.

SmartIF<IIncidentSvc> StalledEventMonitor::m_incidentSvc

private

Pointer to the incident service.

Definition at line 67 of file StalledEventMonitor.h.

int StalledEventMonitor::m_maxTimeoutCount

private

Number timeouts before aborting the execution (0 means never abort).

Definition at line 58 of file StalledEventMonitor.h.

bool StalledEventMonitor::m_stackTrace

private

Whether to print a stack-trace on timeout.

Definition at line 61 of file StalledEventMonitor.h.

std::unique_ptr<WatchdogThread> StalledEventMonitor::m_watchdog

private

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

Definition at line 64 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