IIncidentSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/EventContextHash.h>
#include <GaudiKernel/IInterface.h>
#include <GaudiKernel/Incident.h>
#include <memory>
#include <string>
#include <vector>
 
class IIncidentListener;

class GAUDI_API IIncidentSvc : virtual public IInterface {
public:
  DeclareInterfaceID( IIncidentSvc, 2, 0 );

  virtual void addListener( IIncidentListener* lis, const std::string& type = "", long priority = 0,
                            bool rethrow = false, bool singleShot = false ) = 0;
  virtual void removeListener( IIncidentListener* lis, const std::string& type = "" ) = 0;
 
  //@TODO: return vector by value instead...
  virtual void getListeners( std::vector<IIncidentListener*>& lis, const std::string& type = "" ) const = 0;

  virtual void fireIncident( const Incident& incident ) = 0;

  struct Listener final {
    IIncidentListener* iListener{ nullptr };
    long               priority{ 0 };
    bool               rethrow{ false };
    bool               singleShot{ false };
  };

  typedef std::vector<std::pair<std::unique_ptr<Incident>, std::vector<Listener>>> IncidentPack;

  virtual IIncidentSvc::IncidentPack getIncidents( const EventContext* ctx ) = 0;

  virtual void fireIncident( std::unique_ptr<Incident> incident ) = 0;
};