timertt::details::thread_mixin Struct Reference

A mixin which must be used as base class for timer threads. More...

#include <all.hpp>

Classes
class	lock_guard
	A special wrapper around actual std::unique_lock. More...

Public Member Functions
void	ensure_started ()
	Checks that timer thread is really started.
void	notify ()
	Sends notification to timer thread.

Public Attributes
std::mutex	m_lock
	Timer thread's lock.
std::condition_variable	m_condition
	Condition variable for waiting for next event.
std::shared_ptr< std::thread >	m_thread
	Underlying thread object.

Detailed Description

A mixin which must be used as base class for timer threads.

Since

v.1.1.0

Definition at line 2885 of file 3rd_party/timertt/all.hpp.

Member Function Documentation

ensure_started()

void timertt::details::thread_mixin::ensure_started ( )

inline

Checks that timer thread is really started.

Exceptions

std::exception

if thread is not started.

Definition at line 2923 of file 3rd_party/timertt/all.hpp.

notify()

void timertt::details::thread_mixin::notify ( )

inline

Sends notification to timer thread.

Definition at line 2931 of file 3rd_party/timertt/all.hpp.

Member Data Documentation

m_condition

std::condition_variable timertt::details::thread_mixin::m_condition

Condition variable for waiting for next event.

Definition at line 2891 of file 3rd_party/timertt/all.hpp.

m_lock

std::mutex timertt::details::thread_mixin::m_lock

Timer thread's lock.

Definition at line 2888 of file 3rd_party/timertt/all.hpp.

m_thread

std::shared_ptr< std::thread > timertt::details::thread_mixin::m_thread

Underlying thread object.

Note

Will be created during timer thread start and destroyed after timer thread shutdown.

Definition at line 2898 of file 3rd_party/timertt/all.hpp.

---

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

• 3rd_party/timertt/all.hpp