IIncidentSvc Class Reference

The interface implemented by the IncidentSvc service. More...

#include <GaudiKernel/IIncidentSvc.h>

Inheritance diagram for IIncidentSvc:

Collaboration diagram for IIncidentSvc:

Classes
struct	Listener
	Listener properties. More...

Public Types
typedef std::vector< std::pair< std::unique_ptr< Incident >, std::vector< Listener > > >	IncidentPack
	List of incidents and their listeners.
Public Types inherited from IInterface
enum class	Status : StatusCode::code_t {   FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,   LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId<IInterface, 0, 0>
	Interface ID.
using	ext_iids = Gaudi::interface_list<iid>
	Extra interfaces.

Public Member Functions
	DeclareInterfaceID (IIncidentSvc, 2, 0)
	InterfaceID.
virtual void	addListener (IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false)=0
	Add listener.
virtual void	removeListener (IIncidentListener *lis, const std::string &type="")=0
	Remove listener.
virtual void	getListeners (std::vector< IIncidentListener * > &lis, const std::string &type="") const =0
virtual void	fireIncident (const Incident &incident)=0
	Fire an Incident.
virtual IIncidentSvc::IncidentPack	getIncidents (const EventContext *ctx)=0
	Get List of asynchronous incidents and their listeners.
virtual void	fireIncident (std::unique_ptr< Incident > incident)=0
	Fire an Incident, Incident ownership has to be passed to the service since it is going to be accessed asynchronously.
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()
template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long	addRef () const =0
	Increment the reference count of Interface instance.
virtual unsigned long	release () const =0
	Release Interface instance.
virtual unsigned long	refCount () const =0
	Current reference count.
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.
virtual	~IInterface ()=default
	Virtual destructor.
virtual void const *	i_cast (const InterfaceID &) const =0
void *	i_cast (const InterfaceID &iid)

Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

Detailed Description

The interface implemented by the IncidentSvc service.

It is used by Listeners to declare themselves that they are interested by Incidents of a certain type and by Incident originators.

Author

Pere Mato

Definition at line 30 of file IIncidentSvc.h.

Member Typedef Documentation

IncidentPack

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

List of incidents and their listeners.

Definition at line 65 of file IIncidentSvc.h.

Member Function Documentation

addListener()

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

pure virtual

Add listener.

Parameters

lis	Listener address
type	Incident type
priority	Priority in handling incident

DeclareInterfaceID()

IIncidentSvc::DeclareInterfaceID	(	IIncidentSvc	,
		2	,
		0	)

InterfaceID.

fireIncident() [1/2]

virtual void IIncidentSvc::fireIncident ( const Incident & incident )

pure virtual

Fire an Incident.

Parameters

Incident

being fired

fireIncident() [2/2]

virtual void IIncidentSvc::fireIncident ( std::unique_ptr< Incident > incident )

pure virtual

Fire an Incident, Incident ownership has to be passed to the service since it is going to be accessed asynchronously.

Parameters

Incident

being fired

getIncidents()

virtual IIncidentSvc::IncidentPack IIncidentSvc::getIncidents ( const EventContext * ctx )

pure virtual

Get List of asynchronous incidents and their listeners.

getListeners()

virtual void IIncidentSvc::getListeners ( std::vector< IIncidentListener * > & lis, const std::string & type = "" ) const

pure virtual

removeListener()

virtual void IIncidentSvc::removeListener ( IIncidentListener * lis, const std::string & type = "" )

pure virtual

Remove listener.

Parameters

lis	Listener address
type	Incident type

---

The documentation for this class was generated from the following file:

• GaudiKernel/include/GaudiKernel/IIncidentSvc.h