From d88049161629757a90778ce2b017c6d1becb07ad Mon Sep 17 00:00:00 2001
From: Ben Noordhuis <info@bnoordhuis.nl>
Date: Thu, 16 Jun 2011 23:10:47 +0200
Subject: [PATCH] Document that writes are in-order. Fixes #59.

---
 uv.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/uv.h b/uv.h
index 0b83c5bc..7d95820a 100644
--- a/uv.h
+++ b/uv.h
@@ -237,6 +237,23 @@ int uv_read_start(uv_tcp_t*, uv_alloc_cb alloc_cb, uv_read_cb read_cb);
 
 int uv_read_stop(uv_tcp_t*);
 
+/* Write data to stream. Buffers are written in order. Example:
+ *
+ *   uv_buf_t a[] = {
+ *     { .base = "1", .len = 1 },
+ *     { .base = "2", .len = 1 }
+ *   };
+ *
+ *   uv_buf_t b[] = {
+ *     { .base = "3", .len = 1 },
+ *     { .base = "4", .len = 1 }
+ *   };
+ *
+ *   // writes "1234"
+ *   uv_write(req, a, 2);
+ *   uv_write(req, b, 2);
+ *
+ */
 int uv_write(uv_req_t* req, uv_buf_t bufs[], int bufcnt);