omni::chrono::async_timer::start
NAME

omni::chrono::async_timer::start

A member function of omni::chrono::async_timer

#include <omni/chrono/async_timer.hpp>
void omni::chrono::async_timer::start(uint32_t delay)

SYNOPSIS

Starts the timer after a delay.

top

DESCRIPTION

Starts the timer and blocks until the timer is in a running state. If the timer is already running, nothing happens.

top

PARAMETERS

delay - The delay, in milliseconds, to wait until the underlying timer thread starts. This allows you to add an additional delay to the first tick event. If the delay is 0, this has the same effect as just calling the start function.

top


ERRORS

omni::exceptions::invalid_delegate can be raised if there is no delegate attached to the tick event. Additionally omni::exceptions::index_out_of_range can be raised if the interval is set to 0.

top