iv::threads::WatchDog Class Reference

#include <WatchDog.hpp>

Inheritance diagram for iv::threads::WatchDog:

Collaboration diagram for iv::threads::WatchDog:

Public Types
enum class	eRunnableState {   Init , Running , Paused , WaitingForEnd ,   Stopped }

Public Member Functions
	WatchDog ()
	~WatchDog () override=default
bool	isRunning () override
bool	isPaused () override
bool	isStopped () override
void	run () override
void	pause () override
void	resume () override
void	stop () override
void	setTaskName (const std::string_view taskName)

Static Public Member Functions
static bool	startMonitoring ()
static bool	stopMonitoring ()
static void	addThread (const iv::types::threadName &name, ThreadRunnablePeriodic *runnable, eThreadType type)
static void	removeThread (const iv::types::threadName &name)
static void	startThreads (eThreadType type, const std::optional< std::shared_ptr< AbstractProgress > > &progress)
static void	restartThreads (eThreadType type, const std::optional< std::shared_ptr< AbstractProgress > > &progress)
static void	stopThreads (eThreadType type, const std::optional< std::shared_ptr< AbstractProgress > > &progress)
static bool	startThread (const iv::types::threadName &name)
static bool	restartThread (const iv::types::threadName &name)
static bool	stopThread (const iv::types::threadName &name)
static void	pauseThread (const iv::types::threadName &name)
static void	resumeThread (const iv::types::threadName &name)
static std::optional< ThreadData >	getThreadData (const iv::types::threadName &name)

Static Public Attributes
static std::map< std::thread::id, std::atomic< bool > >	haveThreadsCrashed = {}

Protected Member Functions
void	sleepFrame (iv::types::pollTime milliseconds)

Protected Attributes
std::string_view	m_taskName

Private Member Functions
void	periodicTask () override
void	runFrame () override

Private Attributes
iv::types::timestamp	startTime
iv::types::pollTime	m_sleepMs
std::condition_variable	m_cv
std::atomic< IRunnable::eRunnableState >	m_stateThread
std::weak_ptr< bool >	m_isEnabled

Static Private Attributes
static std::map< iv::types::threadName, ThreadData >	m_threads = {}
static std::mutex	m_mutex = {}

Member Enumeration Documentation

eRunnableState

enum class iv::threads::IRunnable::eRunnableState

stronginherited

Enumerator
Init
Running
Paused
WaitingForEnd
Stopped

Constructor & Destructor Documentation

WatchDog()

iv::threads::WatchDog::WatchDog

(

)

~WatchDog()

iv::threads::WatchDog::~WatchDog ( )

overridedefault

Member Function Documentation

addThread()

void iv::threads::WatchDog::addThread ( const iv::types::threadName & name, ThreadRunnablePeriodic * runnable, eThreadType type )

static

getThreadData()

std::optional< ThreadData > iv::threads::WatchDog::getThreadData ( const iv::types::threadName & name )

static

isPaused()

bool iv::threads::ThreadRunnable::isPaused ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

isRunning()

bool iv::threads::ThreadRunnable::isRunning ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

isStopped()

bool iv::threads::ThreadRunnable::isStopped ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

pause()

void iv::threads::ThreadRunnable::pause ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

pauseThread()

void iv::threads::WatchDog::pauseThread ( const iv::types::threadName & name )

static

periodicTask()

void iv::threads::WatchDog::periodicTask ( )

overrideprivatevirtual

Implements iv::threads::ThreadRunnablePeriodic.

removeThread()

void iv::threads::WatchDog::removeThread ( const iv::types::threadName & name )

static

restartThread()

bool iv::threads::WatchDog::restartThread ( const iv::types::threadName & name )

static

restartThreads()

void iv::threads::WatchDog::restartThreads ( eThreadType type, const std::optional< std::shared_ptr< AbstractProgress > > & progress )

static

resume()

void iv::threads::ThreadRunnable::resume ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

resumeThread()

void iv::threads::WatchDog::resumeThread ( const iv::types::threadName & name )

static

run()

void iv::threads::ThreadRunnable::run ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

runFrame()

void iv::threads::ThreadRunnablePeriodic::runFrame ( )

inlineoverrideprivatevirtualinherited

Implements iv::threads::ThreadRunnable.

setTaskName()

void iv::threads::IRunnable::setTaskName ( const std::string_view taskName )

inlineinherited

sleepFrame()

void iv::threads::ThreadRunnable::sleepFrame ( iv::types::pollTime milliseconds )

protectedinherited

startMonitoring()

bool iv::threads::WatchDog::startMonitoring ( )

static

startThread()

bool iv::threads::WatchDog::startThread ( const iv::types::threadName & name )

static

startThreads()

void iv::threads::WatchDog::startThreads ( eThreadType type, const std::optional< std::shared_ptr< AbstractProgress > > & progress )

static

stop()

void iv::threads::ThreadRunnable::stop ( )

overridevirtualinherited

Implements iv::threads::IRunnable.

stopMonitoring()

bool iv::threads::WatchDog::stopMonitoring ( )

static

stopThread()

bool iv::threads::WatchDog::stopThread ( const iv::types::threadName & name )

static

stopThreads()

void iv::threads::WatchDog::stopThreads ( eThreadType type, const std::optional< std::shared_ptr< AbstractProgress > > & progress )

static

Member Data Documentation

haveThreadsCrashed

std::map< std::thread::id, std::atomic< bool > > iv::threads::WatchDog::haveThreadsCrashed = {}

static

m_cv

std::condition_variable iv::threads::ThreadRunnable::m_cv

privateinherited

m_isEnabled

std::weak_ptr<bool> iv::threads::ThreadRunnable::m_isEnabled

privateinherited

m_mutex

std::mutex iv::threads::WatchDog::m_mutex = {}

staticprivate

m_sleepMs

iv::types::pollTime iv::threads::ThreadRunnablePeriodic::m_sleepMs

privateinherited

m_stateThread

std::atomic<IRunnable::eRunnableState> iv::threads::ThreadRunnable::m_stateThread

privateinherited

m_taskName

std::string_view iv::threads::IRunnable::m_taskName

protectedinherited

m_threads

std::map< iv::types::threadName, ThreadData > iv::threads::WatchDog::m_threads = {}

staticprivate

startTime

iv::types::timestamp iv::threads::WatchDog::startTime

private

---

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

• src/threads/WatchDog.hpp
• src/threads/WatchDog.cpp