diff options
| author | Ulrik Strid <ulrik.strid@outlook.com> | 2017-03-16 12:06:49 -0400 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2020-09-21 22:15:46 -0400 |
| commit | 2a1b880f5439e074ef4d5c556f626b1044fb6781 (patch) | |
| tree | 29c894eb559a754a026c3faf1c360c84bc1d70c9 /docs/src | |
| parent | 3ee60fa72a3a562a50436a5384494e4b429ac7f0 (diff) | |
| download | libuv-2a1b880f5439e074ef4d5c556f626b1044fb6781.tar.gz libuv-2a1b880f5439e074ef4d5c556f626b1044fb6781.zip | |
unix,win: add uv_timer_get_due_in()
Co-authored-by: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Refs: https://github.com/nodejs/node-report/pull/73
Refs: https://github.com/libuv/libuv/pull/1255
Fixes: https://github.com/libuv/libuv/issues/2950
PR-URL: https://github.com/libuv/libuv/pull/2951
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/timer.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/src/timer.rst b/docs/src/timer.rst index e163e288..070fa79d 100644 --- a/docs/src/timer.rst +++ b/docs/src/timer.rst @@ -78,4 +78,11 @@ API Get the timer repeat value. +.. c:function:: uint64_t uv_timer_get_due_in(const uv_timer_t* handle) + + Get the timer due value or 0 if it has expired. The time is relative to + :c:func:`uv_now()`. + + .. versionadded:: 1.40.0 + .. seealso:: The :c:type:`uv_handle_t` API functions also apply. |