omni::chrono::drop_timer::tick

SYNOPSIS

The tick event that is called when the timer elapses.

top

DESCRIPTION

The event that is raised when the timer elapses. Each delegate is called in the order to which it was attached. The tick event is supposed to be a short-lived function, or you are to ensure that a separate thread is called to handle the elapsed time.

top

CONSIDERATIONS

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

top


NOTES

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