ccan/io: update and improve documentation.

[ccan] / ccan / io / _info

diff --git a/ccan/io/_info b/ccan/io/_info
index a96ee669eb4ae16fbb229f0c247ebd9beb67bb2f..235e6ba3d281df8ee8f7576030ceabcc9779e533 100644 (file)
--- a/ccan/io/_info
+++ b/ccan/io/_info
@@ -3,12 +3,18 @@
 #include "config.h"
 
 /**
- * io - simple library for stateful io handling.
+ * io - simple library for asynchronous io handling.
  *
- * io provides a simple mechanism to write I/O servers with multiple
- * connections.  Handling of connections is multiplexed, and function
- * indicate what they want written or read, and what follow-on
- * function to call on success (or failure).
+ * io provides a mechanism to write I/O servers with multiple
+ * connections.  Each callback indicates what I/O they plan next
+ * (eg. read, write).  It is also possible to write custom I/O
+ * plans.
+ *
+ * When compiled with DEBUG, control flow is changed so that rather
+ * than returning to the main io_loop(), plans are executed sequentially
+ * providing a backtrace showing what has occurred on that connection.
+ * Which connection(s) do this depends on the user-specified io_debug
+ * function.
  *
  * Example:
  * // Given tr A-Z a-z outputs tr a-z a-z
@@ -46,7 +52,7 @@
  * static void reader_exit(struct io_conn *c, struct stdin_buffer *b)
  * {
  *     assert(c == b->reader);
- *     io_wake(b->writer, io_close(b->writer, NULL));
+ *     io_wake(b->writer, io_close());
  *     b->reader = NULL;
  * }
  *
@@ -54,7 +60,7 @@
  * {
  *     assert(c == b->writer);
  *     if (!b->reader)
- *             return io_close(c, NULL);
+ *             return io_close();
  *     b->len = sizeof(b->inbuf);
  *     io_wake(b->reader, io_read_partial(b->inbuf, &b->len, wake_writer, b));
  *     return io_idle();