guanaqo::AtomicStopSignal Class Reference

#include <guanaqo/atomic-stop-signal.hpp>

Detailed Description

Cancel a running solver or other job in a thread-safe and signal-safe way.

Definition at line 13 of file atomic-stop-signal.hpp.

Collaboration diagram for guanaqo::AtomicStopSignal:

Public Member Functions
	AtomicStopSignal ()=default
	AtomicStopSignal (const AtomicStopSignal &)
AtomicStopSignal &	operator= (const AtomicStopSignal &)=delete
	AtomicStopSignal (AtomicStopSignal &&) noexcept
AtomicStopSignal &	operator= (AtomicStopSignal &&) noexcept
void	stop ()
bool	stop_requested () const

Private Attributes
std::atomic< bool >	stop_flag {false}

Constructor & Destructor Documentation

AtomicStopSignal() [1/3]

guanaqo::AtomicStopSignal::AtomicStopSignal ( )

default

Here is the caller graph for this function:

AtomicStopSignal() [2/3]

guanaqo::AtomicStopSignal::AtomicStopSignal ( const AtomicStopSignal & )

inline

Definition at line 16 of file atomic-stop-signal.hpp.

Here is the call graph for this function:

AtomicStopSignal() [3/3]

guanaqo::AtomicStopSignal::AtomicStopSignal ( AtomicStopSignal && )

inlinenoexcept

Definition at line 18 of file atomic-stop-signal.hpp.

Here is the call graph for this function:

Member Function Documentation

operator=() [1/2]

AtomicStopSignal & guanaqo::AtomicStopSignal::operator= ( const AtomicStopSignal & )

delete

Here is the call graph for this function:

operator=() [2/2]

AtomicStopSignal & guanaqo::AtomicStopSignal::operator= ( AtomicStopSignal && )

inlinenoexcept

Definition at line 19 of file atomic-stop-signal.hpp.

Here is the call graph for this function:

stop()

void guanaqo::AtomicStopSignal::stop ( )

inline

Definition at line 21 of file atomic-stop-signal.hpp.

stop_requested()

bool guanaqo::AtomicStopSignal::stop_requested ( ) const

inlinenodiscard

Definition at line 22 of file atomic-stop-signal.hpp.

Member Data Documentation

stop_flag

std::atomic<bool> guanaqo::AtomicStopSignal::stop_flag {false}

private

Definition at line 27 of file atomic-stop-signal.hpp.

---

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

• include/guanaqo/atomic-stop-signal.hpp