NAME

omni::chrono::sync_timer

A class of omni::chrono

#include <omni/chrono/sync_timer.hpp>
class omni::chrono::sync_timer

MEMBERS

omni::chrono::sync_timer::sync_timer()
omni::chrono::sync_timer::~sync_timer()
bool omni::chrono::sync_timer::auto_reset()
uint64_t omni::chrono::sync_timer::hash()
uint32_t omni::chrono::sync_timer::interval()
bool omni::chrono::sync_timer::is_running()
void omni::chrono::sync_timer::reset()
void omni::chrono::sync_timer::set_auto_reset(bool autoreset)
void omni::chrono::sync_timer::set_interval(uint32_t interval_ms)
void omni::chrono::sync_timer::start()
void omni::chrono::sync_timer::stop()
void omni::chrono::sync_timer::swap(omni::chrono::sync_timer& other)
omni::chrono::timer_sync_type::enum_t omni::chrono::sync_timer::tick_type()
uint64_t omni::chrono::sync_timer::type()
inline bool omni::chrono::sync_timer::operator!=(const omni::chrono::sync_timer& o)
omni::chrono::sync_timer& omni::chrono::sync_timer::operator=(const omni::chrono::sync_timer& other)
bool omni::chrono::sync_timer::operator==(const omni::chrono::sync_timer& o)
omni::chrono::sync_timer::disposing
omni::chrono::sync_timer::name
omni::chrono::sync_timer::state_object
omni::chrono::sync_timer::tick


SYNOPSIS

A timer class that invokes a basic tick event synchronously.

top

DESCRIPTION

This timer will invoke a tick event at a specified interval and will not tick again until the attached delegate has completed, regardless of how long the specified interval is; in this way the tick event is a blocking event. If the timer is stopped before the interval has elapsed, any subsequent tick events will not fire.

top

NOTES

While the timer event is a blocking event, the timer does happen on a separate thread, and care must be taken that any shared data in the attached delegate is protected in a thread-safe way. Additionally, it should be noted that it is possible for the total time elapsed to be longer than the specified interval if the attached delegate executes or blocks for longer than the interval.

top