*
* @finish will be called when an I/O operation fails, or you call
* io_close() on the connection. errno will be set to the value
- * after the failed I/O, or at the call to io_close().
+ * after the failed I/O, or at the call to io_close(). The fd
+ * will be closed (unless a duplex) before @finish is called.
*
* Example:
* static void finish(struct io_conn *conn, void *unused)
struct io_plan (*cb)(struct io_conn *, void*),
void *arg);
+/**
+ * io_always - plan to immediately call next callback.
+ * @cb: function to call.
+ * @arg: @cb argument
+ *
+ * Sometimes it's neater to plan a callback rather than call it directly;
+ * for example, if you only need to read data for one path and not another.
+ *
+ * Example:
+ * static void start_conn_with_nothing(int fd)
+ * {
+ * // Silly example: close on next time around loop.
+ * io_new_conn(fd, io_always(io_close_cb, NULL));
+ * }
+ */
+#define io_always(cb, arg) \
+ io_debug(io_always_(typesafe_cb_preargs(struct io_plan, void *, \
+ (cb), (arg), \
+ struct io_conn *), \
+ (arg)))
+struct io_plan io_always_(struct io_plan (*cb)(struct io_conn *, void *),
+ void *arg);
+
/**
* io_connect - plan to connect to a listening socket.
* @fd: file descriptor.
#define io_break(ret, plan) (io_plan_no_debug(), io_break_((ret), (plan)))
struct io_plan io_break_(void *ret, struct io_plan plan);
+/**
+ * io_never - assert if callback is called.
+ *
+ * Sometimes you want to make it clear that a callback should never happen
+ * (eg. for io_break). This will assert() if called.
+ *
+ * Example:
+ * static struct io_plan break_out(struct io_conn *conn, void *unused)
+ * {
+ * // We won't ever return from io_break
+ * return io_break(conn, io_never());
+ * }
+ */
+struct io_plan io_never(void);
+
/* FIXME: io_recvfrom/io_sendto */
/**
*/
struct io_plan io_close_cb(struct io_conn *, void *unused);
+/**
+ * io_close_other - close different connection next time around the I/O loop.
+ * @conn: the connection to close.
+ *
+ * This is used to force a different connection to close: no more I/O will
+ * happen on @conn, even if it's pending.
+ *
+ * It's a bug to use this on the current connection!
+ *
+ * Example:
+ * static void stop_connection(struct io_conn *conn)
+ * {
+ * printf("forcing stop on connection\n");
+ * io_close_other(conn);
+ * }
+ */
+void io_close_other(struct io_conn *conn);
+
/**
* io_loop - process fds until all closed on io_break.
*