Sha256: 7387f0830d8a5b09a39bb2a55b694514d93fc184b74e04cc8eb853a2199fdae8

Contents?: true

Size: 929 Bytes

Versions: 42

Compression:

Stored size: 929 Bytes

Contents

.. _prepare:

:c:type:`uv_prepare_t` --- Prepare handle
=========================================

Prepare handles will run the given callback once per loop iteration, right
before polling for i/o.


Data types
----------

.. c:type:: uv_prepare_t

    Prepare handle type.

.. c:type:: void (*uv_prepare_cb)(uv_prepare_t* handle)

    Type definition for callback passed to :c:func:`uv_prepare_start`.


Public members
^^^^^^^^^^^^^^

N/A

.. seealso:: The :c:type:`uv_handle_t` members also apply.


API
---

.. c:function:: int uv_prepare_init(uv_loop_t* loop, uv_prepare_t* prepare)

    Initialize the handle.

.. c:function:: int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb)

    Start the handle with the given callback.

.. c:function:: int uv_prepare_stop(uv_prepare_t* prepare)

    Stop the handle, the callback will no longer be called.

.. seealso:: The :c:type:`uv_handle_t` API functions also apply.

Version data entries

42 entries across 42 versions & 2 rubygems

Version Path
mt-libuv-4.1.04 ext/libuv/docs/src/prepare.rst
mt-libuv-4.1.03 ext/libuv/docs/src/prepare.rst
mt-libuv-4.1.02 ext/libuv/docs/src/prepare.rst
libuv-4.0.9 ext/libuv/docs/src/prepare.rst
libuv-4.0.2 ext/libuv/docs/src/prepare.rst
libuv-4.0.1 ext/libuv/docs/src/prepare.rst
libuv-2.0.12 ext/libuv/docs/src/prepare.rst
libuv-2.0.11 ext/libuv/docs/src/prepare.rst
libuv-4.0.0 ext/libuv/docs/src/prepare.rst
libuv-3.3.0 ext/libuv/docs/src/prepare.rst
libuv-3.2.4 ext/libuv/docs/src/prepare.rst
libuv-3.2.3 ext/libuv/docs/src/prepare.rst
libuv-3.2.2 ext/libuv/docs/src/prepare.rst
libuv-3.2.1 ext/libuv/docs/src/prepare.rst
libuv-3.2.0 ext/libuv/docs/src/prepare.rst
libuv-3.1.9 ext/libuv/docs/src/prepare.rst
libuv-3.1.8 ext/libuv/docs/src/prepare.rst
libuv-3.1.7 ext/libuv/docs/src/prepare.rst
libuv-3.1.6 ext/libuv/docs/src/prepare.rst
libuv-3.1.5 ext/libuv/docs/src/prepare.rst