| The Gaudi Framework v28r2-patches (bc4ad17a)

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

- File List
- File Members

IncidentSvc.h
Go to the documentation of this file.
1 #ifndef IncidentSvc_IncidentSvc_H
2 #define IncidentSvc_IncidentSvc_H
3 // ============================================================================
4 // Include Files
5 // ============================================================================
6 // STD & STL
7 // ============================================================================
8 #include <map>
9 #include <list>
10 // ============================================================================
11 // GaudiKernel
12 // ============================================================================
13 #include "GaudiKernel/Service.h"
14 #include "GaudiKernel/IIncidentSvc.h"
15 #include "GaudiKernel/StringKey.h"
16 #include "GaudiKernel/StringKey.h"
17 #include "GaudiKernel/HashMap.h"
18 #include "GaudiKernel/ChronoEntity.h"
19 // ============================================================================
20 // TBB
21 // ============================================================================
22 #include "tbb/concurrent_queue.h"
23 #include "tbb/concurrent_unordered_map.h"
24 // ============================================================================
36 struct isSingleShot_t;
37
38 class IncidentSvc : public extends<Service,
39 IIncidentSvc>
40 {
41 public:
42 struct Listener final
43 {
44 IIncidentListener* iListener;
45 long priority;
46 bool rethrow;
47 bool singleShot;
48
49 Listener(IIncidentListener* il, long pri, bool thr=false, bool single=false):
50 iListener(il), priority(pri), rethrow(thr), singleShot(single){}
51 };
52 private:
53
54 // Typedefs
55 // ListenerList should be a list rather than a vector because handing
56 // a fired incident may result in a call to addListener.
57 typedef std::list<Listener> ListenerList;
58 typedef GaudiUtils::HashMap<Gaudi::StringKey, std::unique_ptr<ListenerList>> ListenerMap;
59
60 public:
61 // Inherited Service overrides:
62 //
63 StatusCode initialize() override;
64 StatusCode finalize() override;
65
66 // IIncidentSvc interfaces overwrite
67 //
68 void addListener( IIncidentListener* lis ,
69 const std::string& type = "" ,
70 long priority = 0 ,
71 bool rethrow = false ,
72 bool singleShot = false ) override;
73
74 void removeListener( IIncidentListener* l, const std::string& type = "" ) override;
75 void fireIncident( const Incident& incident) override;
76 void fireIncident( std::unique_ptr<Incident> incident) override;
77 //TODO: return by value instead...
78 void getListeners (std::vector<IIncidentListener*>& lis,
79 const std::string& type = "") const override;
80
81 // Standard Constructor.
82 IncidentSvc( const std::string& name, ISvcLocator* svc );
83 // Destructor.
84 ~IncidentSvc() override;
85 IIncidentSvc::IncidentPack getIncidents(const EventContext* ctx) override;
86
87 private:
88 ListenerMap::iterator removeListenerFromList(ListenerMap::iterator,
89 IIncidentListener* item,
90 bool scheduleRemoval);
91 // ==========================================================================
93 void i_fireIncident(const Incident& incident, const std::string& type);
94
95
97 ListenerMap m_listenerMap;
98
101 const std::string *m_currentIncidentType = nullptr;
102
104 mutable std::recursive_mutex m_listenerMapMutex;
105
107 mutable ChronoEntity m_timer ;
108 mutable bool m_timerLock = false ;
109 // ==========================================================================
110 // When TBB supports unique_ptrs in concurrent queue typedef should be changed
111 //typedef tbb::concurrent_queue<std::unique_ptr<Incident>> IncQueue_t;
112 typedef tbb::concurrent_queue<Incident*> IncQueue_t;
113 tbb::concurrent_unordered_map<EventContext,IncQueue_t,EventContextHash,EventContextHash> m_firedIncidents;
114
115 };
116 // ============================================================================
117 // The END
118 // ============================================================================
119 #endif
120 // ============================================================================
IncidentSvc::m_firedIncidents
tbb::concurrent_unordered_map< EventContext, IncQueue_t, EventContextHash, EventContextHash > m_firedIncidents
Definition: IncidentSvc.h:113
IncidentSvc::m_timer
ChronoEntity m_timer
timer & it&#39;s lock
Definition: IncidentSvc.h:107
ISvcLocator
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
Service::name
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:289
IncidentSvc::finalize
StatusCode finalize() override
Definition: IncidentSvc.cpp:80
ChronoEntity
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
IncidentSvc::m_timerLock
bool m_timerLock
Definition: IncidentSvc.h:108
IncidentSvc::Listener::rethrow
bool rethrow
Definition: IncidentSvc.h:46
IncidentSvc::addListener
void addListener(IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false) override
Definition: IncidentSvc.cpp:94
IncidentSvc::getIncidents
IIncidentSvc::IncidentPack getIncidents(const EventContext *ctx) override
Definition: IncidentSvc.cpp:290
IncidentSvc::removeListenerFromList
ListenerMap::iterator removeListenerFromList(ListenerMap::iterator, IIncidentListener *item, bool scheduleRemoval)
Definition: IncidentSvc.cpp:124
IncidentSvc::ListenerList
std::list< Listener > ListenerList
Definition: IncidentSvc.h:57
IncidentSvc::Listener::singleShot
bool singleShot
Definition: IncidentSvc.h:47
HashMap.h
EventContext
This class represents an entry point to all the event specific data.
Definition: EventContext.h:25
IncidentSvc::IncidentSvc
IncidentSvc(const std::string &name, ISvcLocator *svc)
Definition: IncidentSvc.cpp:51
IncidentSvc::~IncidentSvc
~IncidentSvc() override
Definition: IncidentSvc.cpp:55
std::string
STL class.
Service.h
IIncidentListener
The interface implemented by any class wanting to listen to Incidents.
Definition: IIncidentListener.h:15
IncidentSvc::m_listenerMapMutex
std::recursive_mutex m_listenerMapMutex
Mutex to synchronize access to m_listenerMap.
Definition: IncidentSvc.h:104
IIncidentSvc.h
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IncidentSvc::removeListener
void removeListener(IIncidentListener *l, const std::string &type="") override
Definition: IncidentSvc.cpp:148
gaudirun.type
type
Definition: gaudirun.py:125
std::recursive_mutex
IncidentSvc::Listener::priority
long priority
Definition: IncidentSvc.h:45
StringKey.h
IncidentSvc::initialize
StatusCode initialize() override
Definition: IncidentSvc.cpp:62
IncidentSvc::m_currentIncidentType
const std::string * m_currentIncidentType
Incident being fired.
Definition: IncidentSvc.h:101
IIncidentSvc::IncidentPack
Definition: IIncidentSvc.h:54
IncidentSvc::Listener::Listener
Listener(IIncidentListener *il, long pri, bool thr=false, bool single=false)
Definition: IncidentSvc.h:49
std::list
STL class.
IncidentSvc::Listener::iListener
IIncidentListener * iListener
Definition: IncidentSvc.h:44
IncidentSvc::IncQueue_t
tbb::concurrent_queue< Incident * > IncQueue_t
Definition: IncidentSvc.h:112
gaudirun.l
dictionary l
Definition: gaudirun.py:421
IncidentSvc::getListeners
void getListeners(std::vector< IIncidentListener * > &lis, const std::string &type="") const override
Definition: IncidentSvc.cpp:270
GaudiUtils::Map::iterator
map_type::iterator iterator
Definition: Map.h:99
std::vector
STL class.
std::unique_ptr< Incident >
extends
Base class used to extend a class implementing other interfaces.
Definition: extends.h:10
IncidentSvc::i_fireIncident
void i_fireIncident(const Incident &incident, const std::string &type)
Internal function to allow incidents listening to all events.
Definition: IncidentSvc.cpp:174
Incident
Base class for all Incidents (computing events).
Definition: Incident.h:17
IncidentSvc::Listener
Definition: IncidentSvc.h:42
GaudiUtils::HashMap
Common class providing an architecture-independent hash map.
Definition: HashMap.h:77
IncidentSvc::fireIncident
void fireIncident(const Incident &incident) override
Definition: IncidentSvc.cpp:246
IncidentSvc::m_listenerMap
ListenerMap m_listenerMap
List of auditor names.
Definition: IncidentSvc.h:97
IncidentSvc
Default implementation of the IIncidentSvc interface.
Definition: IncidentSvc.h:38
ChronoEntity.h
IncidentSvc::ListenerMap
GaudiUtils::HashMap< Gaudi::StringKey, std::unique_ptr< ListenerList > > ListenerMap
Definition: IncidentSvc.h:58