IncidentSvc.h

Go to the documentation of this file.

#ifndef IncidentSvc_IncidentSvc_H
#define IncidentSvc_IncidentSvc_H
// ============================================================================
// Include Files
// ============================================================================
// STD & STL
// ============================================================================
#include <map>
#include <list>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/Service.h"
#include "GaudiKernel/IIncidentSvc.h"
#include "GaudiKernel/StringKey.h"
#include "GaudiKernel/StringKey.h"
#include "GaudiKernel/HashMap.h"
#include "GaudiKernel/ChronoEntity.h"
// ============================================================================
// TBB
// ============================================================================
#include "tbb/concurrent_queue.h"
#include "tbb/concurrent_unordered_map.h"
// ============================================================================
struct isSingleShot_t;

class IncidentSvc : public extends<Service,
                                   IIncidentSvc>
{
    public:
  struct Listener final
  {
    IIncidentListener* iListener;
    long priority;
    bool rethrow;
    bool singleShot;

    Listener(IIncidentListener* il, long pri, bool thr=false, bool single=false):
      iListener(il), priority(pri), rethrow(thr), singleShot(single){}
  };
    private:

  // Typedefs
  // ListenerList should be a list rather than a vector because handing
  // a fired incident may result in a call to addListener.
  typedef std::list<Listener> ListenerList;
  typedef GaudiUtils::HashMap<Gaudi::StringKey, std::unique_ptr<ListenerList>> ListenerMap;

public:
  // Inherited Service overrides:
  //
  StatusCode initialize() override;
  StatusCode finalize() override;

  // IIncidentSvc interfaces overwrite
  //
  void addListener( IIncidentListener* lis       ,
                    const std::string& type = "" ,
                    long priority   = 0          ,
                    bool rethrow    = false      ,
                    bool singleShot = false      ) override;

  void removeListener( IIncidentListener* l, const std::string& type = "" ) override;
  void fireIncident( const Incident& incident) override;
  void fireIncident( std::unique_ptr<Incident> incident) override;
  //TODO: return by value instead...
  void getListeners (std::vector<IIncidentListener*>& lis,
                     const std::string& type = "") const override;

  // Standard Constructor.
  IncidentSvc( const std::string& name, ISvcLocator* svc );
  // Destructor.
  ~IncidentSvc() override;
  IIncidentSvc::IncidentPack getIncidents(const EventContext* ctx) override;

private:
  ListenerMap::iterator removeListenerFromList(ListenerMap::iterator, 
                                               IIncidentListener* item, 
                                               bool scheduleRemoval);
  // ==========================================================================
  void i_fireIncident(const Incident& incident, const std::string& type);


  ListenerMap  m_listenerMap;

  const std::string *m_currentIncidentType = nullptr;

  mutable std::recursive_mutex m_listenerMapMutex;

  mutable ChronoEntity m_timer     ;
  mutable bool         m_timerLock = false ;
  // ==========================================================================
  // When TBB supports unique_ptrs in concurrent queue typedef should be changed
  //typedef tbb::concurrent_queue<std::unique_ptr<Incident>> IncQueue_t;
  typedef tbb::concurrent_queue<Incident*> IncQueue_t;
  tbb::concurrent_unordered_map<EventContext,IncQueue_t,EventContextHash,EventContextHash> m_firedIncidents;

};
// ============================================================================
// The END
// ============================================================================
#endif
// ============================================================================