NAME

omni::chrono::drop_timer

A class of omni::chrono

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

MEMBERS

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


SYNOPSIS

A timer class that invokes or queues a basic tick event.

top

DESCRIPTION

This timer will invoke a tick event at a specified interval, and depending on how long the delegate takes to complete, could queue up additional events. In other words, if the timer elapses while an event is still executing, the next event will be queued up and fire after the completion of the current event. If the timer is stopped and there are still events queued up, all remaining events will be effectively dropped and not executed.

top

NOTES

Since the timer event happens on a new thread, care must be taken to make sure the attached delegate is re-entrant.

top