uv_prepare_t
— Prepare handle¶
Prepare handles will run the given callback once per loop iteration, right before polling for i/o.
Data types¶
-
type
uv_prepare_t
¶ Prepare handle type.
-
typedef void (*
uv_prepare_cb
)(uv_prepare_t *handle)¶ Type definition for callback passed to
uv_prepare_start()
.
API¶
-
int
uv_prepare_init
(uv_loop_t *loop, uv_prepare_t *prepare)¶ Initialize the handle. This function always succeeds.
- Returns
0
-
int
uv_prepare_start
(uv_prepare_t *prepare, uv_prepare_cb cb)¶ Start the handle with the given callback. This function always succeeds, except when cb is NULL.
- Returns
0 on success, or UV_EINVAL when cb == NULL.
-
int
uv_prepare_stop
(uv_prepare_t *prepare)¶ Stop the handle, the callback will no longer be called. This function always succeeds.
- Returns
0
See also
The uv_handle_t
API functions also apply.