Mercurial
comparison third_party/libuv/docs/src/check.rst @ 160:948de3f54cea
[ThirdParty] Added libuv
| author | June Park <parkjune1995@gmail.com> |
|---|---|
| date | Wed, 14 Jan 2026 19:39:52 -0800 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 159:05cf9467a1c3 | 160:948de3f54cea |
|---|---|
| 1 | |
| 2 .. _check: | |
| 3 | |
| 4 :c:type:`uv_check_t` --- Check handle | |
| 5 ===================================== | |
| 6 | |
| 7 Check handles will run the given callback once per loop iteration, right | |
| 8 after polling for i/o. | |
| 9 | |
| 10 | |
| 11 Data types | |
| 12 ---------- | |
| 13 | |
| 14 .. c:type:: uv_check_t | |
| 15 | |
| 16 Check handle type. | |
| 17 | |
| 18 .. c:type:: void (*uv_check_cb)(uv_check_t* handle) | |
| 19 | |
| 20 Type definition for callback passed to :c:func:`uv_check_start`. | |
| 21 | |
| 22 | |
| 23 Public members | |
| 24 ^^^^^^^^^^^^^^ | |
| 25 | |
| 26 N/A | |
| 27 | |
| 28 .. seealso:: The :c:type:`uv_handle_t` members also apply. | |
| 29 | |
| 30 | |
| 31 API | |
| 32 --- | |
| 33 | |
| 34 .. c:function:: int uv_check_init(uv_loop_t* loop, uv_check_t* check) | |
| 35 | |
| 36 Initialize the handle. This function always succeeds. | |
| 37 | |
| 38 :returns: 0 | |
| 39 | |
| 40 .. c:function:: int uv_check_start(uv_check_t* check, uv_check_cb cb) | |
| 41 | |
| 42 Start the handle with the given callback. This function always succeeds, | |
| 43 except when `cb` is `NULL`. | |
| 44 | |
| 45 :returns: 0 on success, or `UV_EINVAL` when `cb == NULL`. | |
| 46 | |
| 47 .. c:function:: int uv_check_stop(uv_check_t* check) | |
| 48 | |
| 49 Stop the handle, the callback will no longer be called. | |
| 50 This function always succeeds. | |
| 51 | |
| 52 :returns: 0 | |
| 53 | |
| 54 .. seealso:: The :c:type:`uv_handle_t` API functions also apply. |