Blame docs/src/check.rst

Packit b5b901
Packit b5b901
.. _check:
Packit b5b901
Packit b5b901
:c:type:`uv_check_t` --- Check handle
Packit b5b901
=====================================
Packit b5b901
Packit b5b901
Check handles will run the given callback once per loop iteration, right
Packit b5b901
after polling for i/o.
Packit b5b901
Packit b5b901
Packit b5b901
Data types
Packit b5b901
----------
Packit b5b901
Packit b5b901
.. c:type:: uv_check_t
Packit b5b901
Packit b5b901
    Check handle type.
Packit b5b901
Packit b5b901
.. c:type:: void (*uv_check_cb)(uv_check_t* handle)
Packit b5b901
Packit b5b901
    Type definition for callback passed to :c:func:`uv_check_start`.
Packit b5b901
Packit b5b901
Packit b5b901
Public members
Packit b5b901
^^^^^^^^^^^^^^
Packit b5b901
Packit b5b901
N/A
Packit b5b901
Packit b5b901
.. seealso:: The :c:type:`uv_handle_t` members also apply.
Packit b5b901
Packit b5b901
Packit b5b901
API
Packit b5b901
---
Packit b5b901
Packit b5b901
.. c:function:: int uv_check_init(uv_loop_t* loop, uv_check_t* check)
Packit b5b901
Packit Service e08953
    Initialize the handle. This function always succeeds.
Packit Service e08953
Packit Service e08953
    :returns: 0
Packit b5b901
Packit b5b901
.. c:function:: int uv_check_start(uv_check_t* check, uv_check_cb cb)
Packit b5b901
Packit Service e08953
    Start the handle with the given callback. This function always succeeds,
Packit Service e08953
    except when `cb` is `NULL`.
Packit Service e08953
Packit Service e08953
    :returns: 0 on success, or `UV_EINVAL` when `cb == NULL`.
Packit b5b901
Packit b5b901
.. c:function:: int uv_check_stop(uv_check_t* check)
Packit b5b901
Packit b5b901
    Stop the handle, the callback will no longer be called.
Packit Service e08953
    This function always succeeds.
Packit Service e08953
Packit Service e08953
    :returns: 0
Packit b5b901
Packit b5b901
.. seealso:: The :c:type:`uv_handle_t` API functions also apply.