Blame docs/src/prepare.rst
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. _prepare:
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
:c:type:`uv_prepare_t` --- Prepare handle
|
|
Packit Service |
7c31a4 |
=========================================
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Prepare handles will run the given callback once per loop iteration, right
|
|
Packit Service |
7c31a4 |
before polling for i/o.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Data types
|
|
Packit Service |
7c31a4 |
----------
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. c:type:: uv_prepare_t
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Prepare handle type.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. c:type:: void (*uv_prepare_cb)(uv_prepare_t* handle)
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Type definition for callback passed to :c:func:`uv_prepare_start`.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Public members
|
|
Packit Service |
7c31a4 |
^^^^^^^^^^^^^^
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
N/A
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. seealso:: The :c:type:`uv_handle_t` members also apply.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
API
|
|
Packit Service |
7c31a4 |
---
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. c:function:: int uv_prepare_init(uv_loop_t* loop, uv_prepare_t* prepare)
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Initialize the handle. This function always succeeds.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
:returns: 0
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. c:function:: int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb)
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Start the handle with the given callback. This function always succeeds,
|
|
Packit Service |
7c31a4 |
except when `cb` is `NULL`.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
:returns: 0 on success, or `UV_EINVAL` when `cb == NULL`.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. c:function:: int uv_prepare_stop(uv_prepare_t* prepare)
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
Stop the handle, the callback will no longer be called.
|
|
Packit Service |
7c31a4 |
This function always succeeds.
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
:returns: 0
|
|
Packit Service |
7c31a4 |
|
|
Packit Service |
7c31a4 |
.. seealso:: The :c:type:`uv_handle_t` API functions also apply.
|