omni::chrono::drop_timer::stop
NAME

omni::chrono::drop_timer::stop

A member function of omni::chrono::drop_timer

#include <omni/chrono/drop_timer.hpp>
void omni::chrono::drop_timer::stop(uint32_t join_timeout, bool kill_on_timeout)

SYNOPSIS

Stops the timer.

top

DESCRIPTION

Stops the timer and waits for any tick events to finish before continuing. This is a blocking call.

top

PARAMETERS

join_timeout - The timeout to wait for any unfinished tick events before unblocking and continuing. kill_on_timeout - If this is true and the timeout elapses while waiting, the underlying event threads are killed.

top


NOTES

If the timeout elapses and kill_on_timeout is true, the underlying threads will be killed. While killing a thread can be an option, it can leave the program in an undefined state. It's best to ensure your tick events are short lived and exit cleanly.

top