doc: document uv_alloc_cb

saghul · saghul · commit 5e822033b457 · 2014-09-25T21:38:03.000+02:00
Fixes #1498
diff --git a/docs/src/handle.rst b/docs/src/handle.rst
@@ -21,6 +21,15 @@ Data types
 
     Union of all handle types.
 
+.. c:type:: void (*uv_alloc_cb)(uv_handle_t* handle, size_t suggested_size, uv_buf_t* buf)
+
+    Type definition for callback passed to :c:func:`uv_read_start` and
+    :c:func:`uv_udp_recv_start`. The user must fill the supplied :c:type:`uv_buf_t`
+    structure with whatever size, as long as it's > 0. A suggested size (65536 at the moment)
+    is provided, but it doesn't need to be honored. Setting the buffer's length to 0
+    will trigger a ``UV_ENOBUFS`` error in the :c:type:`uv_udp_recv_cb` or
+    :c:type:`uv_read_cb` callback.
+
 .. c:type:: void (*uv_close_cb)(uv_handle_t* handle)
 
     Type definition for callback passed to :c:func:`uv_close`.
