ext/libuv/docs/src/timer.rst in libuv-2.0.5 vs ext/libuv/docs/src/timer.rst in libuv-2.0.6

- old
+ new

@@ -52,10 +52,18 @@ as the timeout. If the timer has never been started before it returns UV_EINVAL. .. c:function:: void uv_timer_set_repeat(uv_timer_t* handle, uint64_t repeat) - Set the repeat value in milliseconds. + Set the repeat interval value in milliseconds. The timer will be scheduled + to run on the given interval, regardless of the callback execution + duration, and will follow normal timer semantics in the case of a + time-slice overrun. + + For example, if a 50ms repeating timer first runs for 17ms, it will be + scheduled to run again 33ms later. If other tasks consume more than the + 33ms following the first timer callback, then the callback will run as soon + as possible. .. note:: If the repeat value is set from a timer callback it does not immediately take effect. If the timer was non-repeating before, it will have been stopped. If it was repeating, then the old repeat value will have been used to schedule the next timeout.