CThreadInterrupt Class Reference

A helper class for interruptible sleeps. More...

#include <threadinterrupt.h>

Collaboration diagram for CThreadInterrupt:

Public Types
using	Clock = std::chrono::steady_clock

Public Member Functions
	CThreadInterrupt ()
	operator bool () const
void	operator() () EXCLUSIVE_LOCKS_REQUIRED(!mut)
void	reset ()
bool	sleep_for (Clock::duration rel_time) EXCLUSIVE_LOCKS_REQUIRED(!mut)

Private Attributes
std::condition_variable	cond
Mutex	mut
std::atomic< bool >	flag

Detailed Description

A helper class for interruptible sleeps.

Calling operator() will interrupt any current sleep, and after that point operator bool() will return true until reset.

This class should not be used in a signal handler. It uses thread synchronization primitives that are not safe to use with signals. If sending an interrupt from a signal handler is necessary, the SignalInterrupt class can be used instead.

Definition at line 26 of file threadinterrupt.h.

Member Typedef Documentation

Clock

using CThreadInterrupt::Clock = std::chrono::steady_clock

Definition at line 29 of file threadinterrupt.h.

Constructor & Destructor Documentation

CThreadInterrupt()

CThreadInterrupt::CThreadInterrupt

(

)

Definition at line 10 of file threadinterrupt.cpp.

Member Function Documentation

operator bool()

CThreadInterrupt::operator bool ( ) const

explicit

Definition at line 12 of file threadinterrupt.cpp.

operator()()

void CThreadInterrupt::operator()

(

)

Definition at line 22 of file threadinterrupt.cpp.

reset()

void CThreadInterrupt::reset

(

)

Definition at line 17 of file threadinterrupt.cpp.

Here is the caller graph for this function:

sleep_for()

bool CThreadInterrupt::sleep_for

(

Clock::duration

rel_time

)

Definition at line 31 of file threadinterrupt.cpp.

Here is the caller graph for this function:

Member Data Documentation

cond

std::condition_variable CThreadInterrupt::cond

private

Definition at line 37 of file threadinterrupt.h.

flag

std::atomic<bool> CThreadInterrupt::flag

private

Definition at line 39 of file threadinterrupt.h.

mut

Mutex CThreadInterrupt::mut

private

Definition at line 38 of file threadinterrupt.h.

---

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

• src/util/threadinterrupt.h
• src/util/threadinterrupt.cpp