doc: add documentation to uv_udp_start_recv

2014-07-02 16:14:56 +02:00 · 2014-07-02 16:14:56 +02:00 · d17bfc617e
commit d17bfc617e
parent 1830a3cd91
1 changed files with 5 additions and 0 deletions
--- 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,