summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/libuv/docs/src/timer.rst
diff options
context:
space:
mode:
author Miodrag Milanovic <mmicko@gmail.com>2016-10-07 14:14:08 +0200
committer Miodrag Milanovic <mmicko@gmail.com>2016-10-07 14:14:08 +0200
commit85f4741fcf642f52ac4fa56f0aff1728727c901b (patch)
treeda8cca02913839152d2eb04c0e85a83018bcaed3 /3rdparty/libuv/docs/src/timer.rst
parentff01b716711b97c2fcaa709ea97f7650f106aa10 (diff)
Remove libuv library (nw)
Diffstat (limited to '3rdparty/libuv/docs/src/timer.rst')
-rw-r--r--3rdparty/libuv/docs/src/timer.rst76
1 files changed, 0 insertions, 76 deletions
diff --git a/3rdparty/libuv/docs/src/timer.rst b/3rdparty/libuv/docs/src/timer.rst
deleted file mode 100644
index 31d733efc39..00000000000
--- a/3rdparty/libuv/docs/src/timer.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-
-.. _timer:
-
-:c:type:`uv_timer_t` --- Timer handle
-=====================================
-
-Timer handles are used to schedule callbacks to be called in the future.
-
-
-Data types
-----------
-
-.. c:type:: uv_timer_t
-
- Timer handle type.
-
-.. c:type:: void (*uv_timer_cb)(uv_timer_t* handle)
-
- Type definition for callback passed to :c:func:`uv_timer_start`.
-
-
-Public members
-^^^^^^^^^^^^^^
-
-N/A
-
-.. seealso:: The :c:type:`uv_handle_t` members also apply.
-
-
-API
----
-
-.. c:function:: int uv_timer_init(uv_loop_t* loop, uv_timer_t* handle)
-
- Initialize the handle.
-
-.. c:function:: int uv_timer_start(uv_timer_t* handle, uv_timer_cb cb, uint64_t timeout, uint64_t repeat)
-
- Start the timer. `timeout` and `repeat` are in milliseconds.
-
- If `timeout` is zero, the callback fires on the next event loop iteration.
- If `repeat` is non-zero, the callback fires first after `timeout`
- milliseconds and then repeatedly after `repeat` milliseconds.
-
-.. c:function:: int uv_timer_stop(uv_timer_t* handle)
-
- Stop the timer, the callback will not be called anymore.
-
-.. c:function:: int uv_timer_again(uv_timer_t* handle)
-
- Stop the timer, and if it is repeating restart it using the repeat value
- 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 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.
-
-.. c:function:: uint64_t uv_timer_get_repeat(const uv_timer_t* handle)
-
- Get the timer repeat value.
-
-.. seealso:: The :c:type:`uv_handle_t` API functions also apply.