From d17bfc617e0fee3a891b93803ac9870f265698cd Mon Sep 17 00:00:00 2001 From: Andrius Bentkus Date: Wed, 2 Jul 2014 16:14:56 +0200 Subject: [PATCH] doc: add documentation to uv_udp_start_recv --- include/uv.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/uv.h b/include/uv.h index d3dcff42..a84af286 100644 --- a/include/uv.h +++ b/include/uv.h @@ -1079,6 +1079,11 @@ UV_EXTERN int uv_udp_send(uv_udp_send_t* req, * * Returns: * 0 on success, or an error code < 0 on failure. + * + * Note: The receive callback will be called with nread == 0 + * and addr == NULL when the there was nothing to read and + * with nread == 0 and addr != NULL when an empty udp + * packet is received. */ UV_EXTERN int uv_udp_recv_start(uv_udp_t* handle, uv_alloc_cb alloc_cb,