diff options
| author | Bartosz Sosnowski <bartosz@janeasystems.com> | 2018-02-19 18:04:41 +0100 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2018-02-21 09:09:25 -0500 |
| commit | 10fe8c806575b4e869420dfbfb8d23a801fdb740 (patch) | |
| tree | 136e05257be7a4fae97bf30fb2a6ac0ca4e78f67 /docs/src | |
| parent | 9d74b27ad45a259e977cc2a842b51ab53f9d4991 (diff) | |
| download | libuv-10fe8c806575b4e869420dfbfb8d23a801fdb740.tar.gz libuv-10fe8c806575b4e869420dfbfb8d23a801fdb740.zip | |
doc: add note about handle movability
Add note that explaining pointers to handles need to
remain valid during the requested operations.
Refs: https://github.com/libuv/libuv/issues/1731
PR-URL: https://github.com/libuv/libuv/pull/1749
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/handle.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/src/handle.rst b/docs/src/handle.rst index e4cb90b5..cdfb76bf 100644 --- a/docs/src/handle.rst +++ b/docs/src/handle.rst @@ -9,6 +9,9 @@ Structures are aligned so that any libuv handle can be cast to `uv_handle_t`. All API functions defined here work with any handle type. +Libuv handles are not movable. Pointers to handle structures passed to +functions must remain valid for the duration of the requested operation. Take +care when using stack allocated handles. Data types ---------- |