Gaudi::ISignalMonitor Class Reference

Interface for the service that monitors the occurrences of system signals. More...

#include </builds/gaudi/Gaudi/GaudiUtils/include/GaudiUtils/ISignalMonitor.h>

Inheritance diagram for Gaudi::ISignalMonitor:

Collaboration diagram for Gaudi::ISignalMonitor:

Public Member Functions
	DeclareInterfaceID (ISignalMonitor, 1, 0)
	InterfaceID.
virtual void	monitorSignal (int signum, bool propagate=true)=0
	Add a signal (number) to the list of signals to be monitored.
virtual void	ignoreSignal (int signum)=0
	Ignore future occurrences of the given signal number.
virtual bool	gotSignal (int signum) const =0
	Tell if the given signal has been received or not.
virtual void	setSignal (int signum)=0
	Set the flag for the given signal, as if the signal was received.
virtual void	clearSignal (int signum)=0
	Clear the flag for the given signal, so that a new occurrence can be identified.
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
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.
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

Interface for the service that monitors the occurrences of system signals.

The signal to be monitored have to be declared via the method monitorSignal(). The method gotSignal() can used to check if a signal has been received.

Note that the service is passive, in the sense that it simply keeps track of received signals without performing any action. So it is responsibility of the users to add a check if the signal has been received or not.

Author

Marco Clemencic

Definition at line 28 of file ISignalMonitor.h.

Member Function Documentation

clearSignal()

virtual void Gaudi::ISignalMonitor::clearSignal ( int signum )

pure virtual

Clear the flag for the given signal, so that a new occurrence can be identified.

Parameters

signum

signal number

DeclareInterfaceID()

Gaudi::ISignalMonitor::DeclareInterfaceID	(	ISignalMonitor	,
		1	,
		0	)

InterfaceID.

gotSignal()

virtual bool Gaudi::ISignalMonitor::gotSignal ( int signum ) const

pure virtual

Tell if the given signal has been received or not.

Parameters

signum

signal number

ignoreSignal()

virtual void Gaudi::ISignalMonitor::ignoreSignal ( int signum )

pure virtual

Ignore future occurrences of the given signal number.

Parameters

signum

signal number

monitorSignal()

virtual void Gaudi::ISignalMonitor::monitorSignal ( int signum, bool propagate = true )

pure virtual

Add a signal (number) to the list of signals to be monitored.

It possible to choose if a previously installed signal handler should be called or not.

Parameters

signum	signal number
propagate	if true (default) an already present signal handler is called, otherwise the signal is stopped in the service.

setSignal()

virtual void Gaudi::ISignalMonitor::setSignal ( int signum )

pure virtual

Set the flag for the given signal, as if the signal was received.

Parameters

signum

signal number

---

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

• GaudiUtils/include/GaudiUtils/ISignalMonitor.h