| The Gaudi Framework v27r1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Private Attributes | List of all members
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:
[legend]
Collaboration diagram for StalledEventMonitor:
[legend]

## 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< 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...
| ~extends () override=default
| Virtual destructor. 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...
StatusCode | setProperty (const Property &p) override
StatusCode | setProperty (const std::string &s) override
StatusCode | setProperty (const std::string &n, const std::string &v) override
StatusCode | getProperty (Property *p) const override
const Property & | getProperty (const std::string &name) const override
StatusCode | getProperty (const std::string &n, std::string &v) const override
const std::vector< Property * > & | getProperties () const override
bool | hasProperty (const std::string &name) const override
template<class TYPE >
StatusCode | setProperty (const std::string &name, const TYPE &value)
| set the property form the value More...
| Service (std::string name, ISvcLocator *svcloc)
| Standard Constructor. More...
SmartIF< ISvcLocator > & | serviceLocator () const override
| Retrieve pointer to service locator. More...
StatusCode | setProperties ()
| Method for setting declared properties to the values specified for the job. 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 >
Property * | declareProperty (const std::string &name, T &property, const std::string &doc="none") const
| Declare the named property. More...
Property * | declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
| Declare remote named properties. More...
template<class T >
StatusCode | declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
| Declare used Private tool. More...
template<class T >
StatusCode | declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
| Declare used Public tool. More...
SmartIF< IAuditorSvc > & | auditorSvc () const
| The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
Public Member Functions inherited from CommonMessagingBase
virtual | ~CommonMessagingBase ()=default
| Virtual destructor. More...
SmartIF< IMessageSvc > & | msgSvc () const
| The standard message service. More...
MsgStream & | msgStream () const
| Return an uninitialized MsgStream. More...
MsgStream & | msgStream (const MSG::Level level) const
| Predefined configurable message stream for the efficient printouts. More...
MsgStream & | always () const
| shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream & | fatal () const
| shortcut for the method msgStream(MSG::FATAL) More...
MsgStream & | err () const
| shortcut for the method msgStream(MSG::ERROR) More...
MsgStream & | error () const
| shortcut for the method msgStream(MSG::ERROR) More...
MsgStream & | warning () const
| shortcut for the method msgStream(MSG::WARNING) More...
MsgStream & | info () const
| shortcut for the method msgStream(MSG::INFO) More...
MsgStream & | debug () const
| shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream & | verbose () const
| shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream & | msg () const
| shortcut for the method msgStream(MSG::INFO) More...
MSG::Level | msgLevel () const
| get the output level from the embedded MsgStream More...
MSG::Level | outputLevel () const __attribute__((deprecated))
| Backward compatibility function for getting the output level. More...
bool | msgLevel (MSG::Level lvl) const
| get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
| ~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< 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
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * > | Factory
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
| ~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 > >
void | updateMsgStreamOutputLevel (int level)
| Update the output level of the cached MsgStream. More...
Protected Attributes inherited from Service
IntegerProperty | m_outputLevel = MSG::NIL
| Service output level. More...
Gaudi::StateMachine::State | m_state = Gaudi::StateMachine::OFFLINE
| Service state. More...
Gaudi::StateMachine::State | m_targetState = Gaudi::StateMachine::OFFLINE
| Service state. 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.

84 :
85 base_class(name, svcLoc) {
86
87 declareProperty("EventTimeout", m_eventTimeout = 600,
88 "Number of seconds allowed to process a single event (0 to disable the check).");
89
90 declareProperty("MaxTimeoutCount", m_maxTimeoutCount = 0,
91 "Number timeouts before aborting the execution (0 means never abort).");
92
93 declareProperty("StackTrace", m_stackTrace = false,
94 "Whether to print the stack-trace on timeout.");
95 }
StalledEventMonitor::m_stackTrace
bool m_stackTrace
Whether to print a stack-trace on timeout.
Definition: StalledEventMonitor.h:62
extends< Service, IIncidentListener >::base_class
extends base_class
Typedef to this class.
Definition: extends.h:14
StalledEventMonitor::m_maxTimeoutCount
int m_maxTimeoutCount
Number timeouts before aborting the execution (0 means never abort).
Definition: StalledEventMonitor.h:59
StalledEventMonitor::m_eventTimeout
unsigned int m_eventTimeout
Number of seconds allowed to process a single event.
Definition: StalledEventMonitor.h:56
Service::declareProperty
Property * declareProperty(const std::string &name, T &property, const std::string &doc="none") const
Declare the named property.
Definition: Service.h:215

StalledEventMonitor::~StalledEventMonitor | ( |  | ) |
| override default

Destructor.

## Member Function Documentation

StatusCode StalledEventMonitor::finalize | ( |  | ) |
| override

Finalization of the service.

Definition at line 146 of file StalledEventMonitor.cpp.

146 {
147 // destroy the watchdog thread (if any)
148 m_watchdog.reset();
149 // unregistering from the IncidentSvc
150 m_incidentSvc->removeListener(this, IncidentType::BeginEvent);
151 m_incidentSvc.reset();
152 return base_class::finalize();
153 }
StalledEventMonitor::m_watchdog
std::unique_ptr< WatchdogThread > m_watchdog
Pointer to the watchdog thread that checks for the event timeout.
Definition: StalledEventMonitor.h:65
StalledEventMonitor::m_incidentSvc
SmartIF< IIncidentSvc > m_incidentSvc
Pointer to the incident service.
Definition: StalledEventMonitor.h:68
std::unique_ptr::reset
T reset(T...args)
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:88
IIncidentSvc::removeListener
virtual void removeListener(IIncidentListener *lis, const std::string &type="")=0
Remove listener.

void StalledEventMonitor::handle | ( | const Incident & |  | ) |
| override

Notify the watchdog thread for a new event.

Definition at line 135 of file StalledEventMonitor.cpp.

135 {
136 if (m_watchdog) m_watchdog->ping();
137 }
StalledEventMonitor::m_watchdog
std::unique_ptr< WatchdogThread > m_watchdog
Pointer to the watchdog thread that checks for the event timeout.
Definition: StalledEventMonitor.h:65
WatchdogThread::ping
void ping()
Function to call to notify the watchdog thread that we are still alive.
Definition: WatchdogThread.h:44

StatusCode StalledEventMonitor::initialize | ( |  | ) |
| override

Initialization of the service.

Prepare the watchdog thread and configures it.

Definition at line 98 of file StalledEventMonitor.cpp.

98 {
99 StatusCode sc = base_class::initialize();
100 if (sc.isFailure()) return sc;
101
102
103 if (m_eventTimeout) {
104 // create the watchdog thread
105 m_watchdog.reset( new EventWatchdog(msgSvc(),
106 "EventWatchdog",
107 boost::posix_time::seconds(m_eventTimeout),
108 m_stackTrace,
109 m_maxTimeoutCount));
110
111 // register to the incident service
112 static const std::string serviceName = "IncidentSvc";
113 m_incidentSvc = serviceLocator()->service(serviceName);
114 if ( ! m_incidentSvc ) {
115 error() << "Cannot retrieve " << serviceName << endmsg;
116 return StatusCode::FAILURE;
117 }
118 debug() << "Register to the IncidentSvc" << endmsg;
119 m_incidentSvc->addListener(this, IncidentType::BeginEvent);
120 } else {
121 warning() << "StalledEventMonitor/" << name()
122 << " instantiated with 0 time-out: no monitoring performed" << endmsg;
123 }
124
125 return StatusCode::SUCCESS;
126 }
Service::serviceLocator
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:324
AnalysisTest.initialize
def initialize()
Definition: AnalysisTest.py:12
StalledEventMonitor::m_watchdog
std::unique_ptr< WatchdogThread > m_watchdog
Pointer to the watchdog thread that checks for the event timeout.
Definition: StalledEventMonitor.h:65
StalledEventMonitor::m_stackTrace
bool m_stackTrace
Whether to print a stack-trace on timeout.
Definition: StalledEventMonitor.h:62
merge_files.sc
int sc
Definition: merge_files.py:167
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
std::string
STL class.
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:78
Service::name
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:319
CommonMessagingBase::error
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
Definition: CommonMessaging.h:118
StalledEventMonitor::m_incidentSvc
SmartIF< IIncidentSvc > m_incidentSvc
Pointer to the incident service.
Definition: StalledEventMonitor.h:68
CommonMessagingBase::warning
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
Definition: CommonMessaging.h:121
StatusCode::FAILURE
Definition: StatusCode.h:29
StatusCode::SUCCESS
Definition: StatusCode.h:30
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
StalledEventMonitor::m_maxTimeoutCount
int m_maxTimeoutCount
Number timeouts before aborting the execution (0 means never abort).
Definition: StalledEventMonitor.h:59
StalledEventMonitor::m_eventTimeout
unsigned int m_eventTimeout
Number of seconds allowed to process a single event.
Definition: StalledEventMonitor.h:56
std::unique_ptr::reset
T reset(T...args)
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:127
IIncidentSvc::addListener
virtual void addListener(IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false)=0
Add listener.
CommonMessagingBase::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:73
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244

StatusCode StalledEventMonitor::start | ( |  | ) |
| override

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

Definition at line 129 of file StalledEventMonitor.cpp.

129 {
130 if (m_watchdog) m_watchdog->start();
131 return StatusCode::SUCCESS;
132 }
WatchdogThread::start
void start()
Start the watchdog thread.
Definition: WatchdogThread.cpp:24
StalledEventMonitor::m_watchdog
std::unique_ptr< WatchdogThread > m_watchdog
Pointer to the watchdog thread that checks for the event timeout.
Definition: StalledEventMonitor.h:65
StatusCode::SUCCESS
Definition: StatusCode.h:30

StatusCode StalledEventMonitor::stop | ( |  | ) |
| override

Stop the watchdog thread (after the event loop).

Definition at line 140 of file StalledEventMonitor.cpp.

140 {
141 if (m_watchdog) m_watchdog->stop();
142 return StatusCode::SUCCESS;
143 }
StalledEventMonitor::m_watchdog
std::unique_ptr< WatchdogThread > m_watchdog
Pointer to the watchdog thread that checks for the event timeout.
Definition: StalledEventMonitor.h:65
StatusCode::SUCCESS
Definition: StatusCode.h:30
WatchdogThread::stop
void stop()
Signal the watchdog thread to stop and wait for it.
Definition: WatchdogThread.cpp:36

## Member Data Documentation

unsigned int StalledEventMonitor::m_eventTimeout
| private

Number of seconds allowed to process a single event.

Definition at line 56 of file StalledEventMonitor.h.

SmartIF<IIncidentSvc> StalledEventMonitor::m_incidentSvc
| private

Pointer to the incident service.

Definition at line 68 of file StalledEventMonitor.h.

int StalledEventMonitor::m_maxTimeoutCount
| private

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

Definition at line 59 of file StalledEventMonitor.h.

bool StalledEventMonitor::m_stackTrace
| private

Whether to print a stack-trace on timeout.

Definition at line 62 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 65 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