aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorjensbjorgensen <jbj1@ultraemail.net>2022-10-21 04:02:43 -0500
committerGitHub <noreply@github.com>2022-10-21 11:02:43 +0200
commit821b0ba8cb44c8804aa9f9e1f3591cd408840d9a (patch)
tree0b8c2cfb36571d1e41dbf856e03a642dd3736b08 /docs/src
parentacfe668ecbb008755ded4c2a7b2639e6b17a6f11 (diff)
downloadlibuv-821b0ba8cb44c8804aa9f9e1f3591cd408840d9a.tar.gz
libuv-821b0ba8cb44c8804aa9f9e1f3591cd408840d9a.zip
doc: add uv_poll_cb status==UV_EBADF note (#3797)
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/poll.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/src/poll.rst b/docs/src/poll.rst
index 93a101ec..f5010892 100644
--- a/docs/src/poll.rst
+++ b/docs/src/poll.rst
@@ -101,7 +101,9 @@ API
with one of the `UV_E*` error codes (see :ref:`errors`). The user should
not close the socket while the handle is active. If the user does that
anyway, the callback *may* be called reporting an error status, but this is
- **not** guaranteed.
+ **not** guaranteed. If `status == UV_EBADF` polling is discontinued for the
+ file handle and no further events will be reported. The user should
+ then call :c:func:`uv_close` on the handle.
.. note::
Calling :c:func:`uv_poll_start` on a handle that is already active is