sas::ShutdownSignaler Class Reference

Shutdown coordinator. More...

#include <sas_shutdown_signaler.hpp>

Public Member Functions
	ShutdownSignaler ()=default
	Default constructor.
	ShutdownSignaler (std::atomic_bool *external_shutdown_signal)
	Construct a ShutdownSignaler using an external atomic flag.
bool	should_shutdown ()
	Check whether a shutdown has been requested.
void	shutdown ()
	Trigger a shutdown signal.

Detailed Description

Shutdown coordinator.

ShutdownSignaler provides a thread-safe mechanism to unify shutdown requests.

Constructor & Destructor Documentation

ShutdownSignaler()

sas::ShutdownSignaler::ShutdownSignaler ( std::atomic_bool * external_shutdown_signal )

inline

Construct a ShutdownSignaler using an external atomic flag.

Parameters

external_shutdown_signal

Pointer to an external atomic_bool used for shutdown signaling

Member Function Documentation

should_shutdown()

bool sas::ShutdownSignaler::should_shutdown

(

)

Check whether a shutdown has been requested.

Returns

true if shutdown requested (external or internal), false otherwise

---

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

• src/sas_core/include/sas_core/sas_shutdown_signaler.hpp
• src/sas_core/src/sas_shutdown_signaler.cpp