util::SignalsHandler Class Reference

Class handling signals. More...

#include <SignalsHandler.hpp>

Public Types
enum class	Priority { StopFirst = 0 , Normal = 1 , StopLast = 2 }
	Enum for stop priority.

Public Member Functions
	SignalsHandler (util::config::ClioConfigDefinition const &config, std::function< void()> forceExitHandler=kDEFAULT_FORCE_EXIT_HANDLER)
	Create SignalsHandler object.
	SignalsHandler (SignalsHandler const &)=delete
	SignalsHandler (SignalsHandler &&)=delete
SignalsHandler &	operator= (SignalsHandler const &)=delete
SignalsHandler &	operator= (SignalsHandler &&)=delete
	~SignalsHandler ()
	Destructor of SignalsHandler.
template<std::invocable SomeCallback>
void	subscribeToStop (SomeCallback &&callback, Priority priority=Priority::Normal)
	Subscribe to stop signal.

Static Public Attributes
static constexpr auto	kHANDLED_SIGNALS = {SIGINT, SIGTERM}

Friends
class	impl::SignalsHandlerStatic

Detailed Description

Class handling signals.

Note

There could be only one instance of this class.

Constructor & Destructor Documentation

SignalsHandler()

util::SignalsHandler::SignalsHandler	(	util::config::ClioConfigDefinition const &	config,
		std::function< void()>	forceExitHandler = kDEFAULT_FORCE_EXIT_HANDLER )

Create SignalsHandler object.

Parameters

config	The configuration.
forceExitHandler	The handler for forced exit.

Member Function Documentation

subscribeToStop()

template<std::invocable SomeCallback>

void util::SignalsHandler::subscribeToStop ( SomeCallback && callback, Priority priority = Priority::Normal )

inline

Subscribe to stop signal.

Template Parameters

SomeCallback

The type of the callback.

Parameters

callback	The callback to call on stop signal.
priority	The priority of the callback. Default is Normal.

---

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

• /__w/clio/clio/src/util/SignalsHandler.hpp
• /__w/clio/clio/src/util/SignalsHandler.cpp