iv::threads::ThreadRunnablePeriodic Class Reference

#include <ThreadRunnablePeriodic.hpp>

Inheritance diagram for iv::threads::ThreadRunnablePeriodic:

Collaboration diagram for iv::threads::ThreadRunnablePeriodic:

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

Public Member Functions
	ThreadRunnablePeriodic (const iv::types::pollTime sleepMs)
	ThreadRunnablePeriodic (const iv::types::pollTime sleepMs, const std::weak_ptr< bool > &isEnabledRef)
	~ThreadRunnablePeriodic () override=default
virtual void	periodicTask ()=0
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)

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

Protected Attributes
std::string_view	m_taskName

Private Member Functions
void	runFrame () override

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

Member Enumeration Documentation

eRunnableState

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

stronginherited

Enumerator
Init
Running
Paused
WaitingForEnd
Stopped

Constructor & Destructor Documentation

ThreadRunnablePeriodic() [1/2]

iv::threads::ThreadRunnablePeriodic::ThreadRunnablePeriodic ( const iv::types::pollTime sleepMs )

inlineexplicit

ThreadRunnablePeriodic() [2/2]

iv::threads::ThreadRunnablePeriodic::ThreadRunnablePeriodic ( const iv::types::pollTime sleepMs, const std::weak_ptr< bool > & isEnabledRef )

inline

~ThreadRunnablePeriodic()

iv::threads::ThreadRunnablePeriodic::~ThreadRunnablePeriodic ( )

overridedefault

Member Function Documentation

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.

periodicTask()

virtual void iv::threads::ThreadRunnablePeriodic::periodicTask ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationControllerFrame, iv::comms::can::LomCommunicationControllerFrame, iv::comms::can::LomMessageProcessorFrame, iv::comms::can::WatchCallMessageProcessorFrame, iv::comms::canJ1939::CanJ1939CommunicationControllerFrame, iv::comms::modbus::ModbusCommunicationControllerFrame, iv::comms::nmea0183::Nmea0183CommunicationControllerFrame, iv::comms::nmea2k::Nmea2kCommunicationControllerFrame, iv::comms::redundancy::RedundancyCommunicationControllerFrame, iv::comms::vdr::VdrCommunicationControllerFrame, iv::comms::watchcallNT::WatchcallNTControllerFrame, iv::threads::RunManageOfflineUnitAndStation, iv::threads::RunReceiveEditorComms, iv::threads::RunReconnect, iv::threads::RunSendHeartbeatStation, iv::threads::RunSendRedundancy, iv::threads::RunSendStationValuesToLoms, iv::threads::RunSendWatchcallNT, iv::threads::RunStationLogics, iv::threads::RunTanks, iv::threads::RunUpdateChannels, and iv::threads::WatchDog.

resume()

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

overridevirtualinherited

Implements iv::threads::IRunnable.

run()

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

overridevirtualinherited

Implements iv::threads::IRunnable.

runFrame()

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

inlineoverrideprivatevirtual

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

stop()

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

overridevirtualinherited

Implements iv::threads::IRunnable.

Member Data Documentation

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::ThreadRunnable::m_mutex

privateinherited

m_sleepMs

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

private

m_stateThread

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

privateinherited

m_taskName

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

protectedinherited

---

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

• src/threads/ThreadRunnablePeriodic.hpp