diff options
Diffstat (limited to 'deps/uv/docs/src/timer.rst')
| -rw-r--r-- | deps/uv/docs/src/timer.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/deps/uv/docs/src/timer.rst b/deps/uv/docs/src/timer.rst index e558704cb2..31d733efc3 100644 --- a/deps/uv/docs/src/timer.rst +++ b/deps/uv/docs/src/timer.rst @@ -54,7 +54,15 @@ API .. 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. |