From a87bb3c5f609504f6e6741d40f24ed2a67af24db Mon Sep 17 00:00:00 2001 From: Philip Chimento Date: Wed, 22 Apr 2020 12:44:07 +0200 Subject: [PATCH] doc: uv_cancel() handles uv_random_t requests This seems to be the case from reading the code of uv_cancel(). Also fixes a broken link due to a markup typo. PR-URL: https://github.com/libuv/libuv/pull/2797 Reviewed-By: Ben Noordhuis Reviewed-By: Colin Ihrig --- docs/src/request.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/src/request.rst b/docs/src/request.rst index 56038287..5807ccba 100644 --- a/docs/src/request.rst +++ b/docs/src/request.rst @@ -69,8 +69,8 @@ API Returns 0 on success, or an error code < 0 on failure. Only cancellation of :c:type:`uv_fs_t`, :c:type:`uv_getaddrinfo_t`, - :c:type:`uv_getnameinfo_t` and :c:type:`uv_work_t` requests is - currently supported. + :c:type:`uv_getnameinfo_t`, :c:type:`uv_random_t` and :c:type:`uv_work_t` + requests is currently supported. Cancelled requests have their callbacks invoked some time in the future. It's **not** safe to free the memory associated with the request until the @@ -80,8 +80,9 @@ API * A :c:type:`uv_fs_t` request has its req->result field set to `UV_ECANCELED`. - * A :c:type:`uv_work_t`, :c:type:`uv_getaddrinfo_t` or c:type:`uv_getnameinfo_t` - request has its callback invoked with status == `UV_ECANCELED`. + * A :c:type:`uv_work_t`, :c:type:`uv_getaddrinfo_t`, + :c:type:`uv_getnameinfo_t` or :c:type:`uv_random_t` request has its + callback invoked with status == `UV_ECANCELED`. .. c:function:: size_t uv_req_size(uv_req_type type)