aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorPhilip Chimento <philip.chimento@gmail.com>2020-04-22 12:44:07 +0200
committerBen Noordhuis <info@bnoordhuis.nl>2020-04-22 12:44:12 +0200
commita87bb3c5f609504f6e6741d40f24ed2a67af24db (patch)
tree0680d222748a10dfa1b8c31a8c8a028984491ca5 /docs/src
parent13886c52930ad8b14d594ad4ac9c90da7e084cb5 (diff)
downloadlibuv-a87bb3c5f609504f6e6741d40f24ed2a67af24db.tar.gz
libuv-a87bb3c5f609504f6e6741d40f24ed2a67af24db.zip
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 <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/request.rst9
1 files 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)