X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fio%2Fio.h;h=c1d09963caa9a813bb9560763e1fd07269b8c97f;hp=68dd56876333293989411ccbb7206acf6001e766;hb=c8f5d9df177cb3326c2b27909b9925521490c7b9;hpb=0ce52c7ca42c2b3a6458cac348f5a8b96d7f1b62 diff --git a/ccan/io/io.h b/ccan/io/io.h index 68dd5687..c1d09963 100644 --- a/ccan/io/io.h +++ b/ccan/io/io.h @@ -454,11 +454,8 @@ struct io_plan *io_connect_(struct io_conn *conn, const struct addrinfo *addr, * io_write(conn, b->out, sizeof(b->out), io_close_cb,b)); * } */ -#define io_duplex(conn, in_plan, out_plan) \ - (io_duplex_prepare(conn), io_duplex_(in_plan, out_plan)) - -struct io_plan *io_duplex_(struct io_plan *in_plan, struct io_plan *out_plan); -void io_duplex_prepare(struct io_conn *conn); +struct io_plan *io_duplex(struct io_conn *conn, + struct io_plan *in_plan, struct io_plan *out_plan); /** * io_halfclose - close half of an io_duplex connection. @@ -598,14 +595,16 @@ struct io_plan *io_never(struct io_conn *conn, void *unused); /* FIXME: io_recvfrom/io_sendto */ /** - * io_close - plan to close a connection. + * io_close - close a connection. * @conn: the connection to close. * - * On return to io_loop, the connection will be closed. It doesn't have - * to be the current connection and it doesn't need to be idle. No more - * IO or callbacks will occur. + * The connection is immediately freed: it doesn't have to be the + * current connection and it doesn't need to be idle. No more IO or + * callbacks will occur, but if a function was added by io_set_finish() + * it will be called with the current errno preserved. * - * You can close a connection twice without harmful effects. + * This is equivalent to tal_free(io_conn), except it returns an io_plan + * for use in an io callback. * * Example: * static struct io_plan *close_on_timeout(struct io_conn *conn, const char *msg) @@ -620,8 +619,8 @@ struct io_plan *io_close(struct io_conn *conn); * io_close_cb - helper callback to close a connection. * @conn: the connection. * - * This schedules a connection to be closed; designed to be used as - * a callback function. + * This is closes a connection; designed to be used as a callback + * function. * * Example: * #define close_on_timeout io_close_cb @@ -654,43 +653,10 @@ int io_conn_fd(const struct io_conn *conn); * io_time_override - override the normal call for time. * @nowfn: the function to call. * - * io usually uses time_now() internally, but this forces it + * io usually uses time_mono() internally, but this forces it * to use your function (eg. for debugging). Returns the old * one. */ -struct timeabs (*io_time_override(struct timeabs (*now)(void)))(void); +struct timemono (*io_time_override(struct timemono (*now)(void)))(void); -/** - * io_set_debug - set synchronous mode on a connection. - * @conn: the connection. - * @debug: whether to enable or disable debug. - * - * Once @debug is true on a connection, all I/O is done synchronously - * as soon as it is set, until it is unset or @conn is closed. This - * makes it easy to debug what's happening with a connection, but note - * that other connections are starved while this is being done. - * - * See also: io_debug_complete() - * - * Example: - * // Dumb init function to set debug and tell conn to close. - * static struct io_plan *conn_init(struct io_conn *conn, const char *msg) - * { - * io_set_debug(conn, true); - * return io_close(conn); - * } - */ -void io_set_debug(struct io_conn *conn, bool debug); - -/** - * io_debug_complete - empty function called when conn is closing/waiting. - * @conn: the connection. - * - * This is for putting a breakpoint onto, when debugging. It is called - * when a conn with io_set_debug() true can no longer be synchronous: - * 1) It is io_close()'d - * 2) It enters io_wait() (sychronous debug will resume after io_wake()) - * 3) io_break() is called (sychronous debug will resume after io_loop()) - */ -void io_debug_complete(struct io_conn *conn); #endif /* CCAN_IO_H */