X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fio%2Fio.h;h=cbd2b9be248b803daec99586001892e6e4e716c9;hp=e48f15b52efe25643b64b533871a64778cdcba60;hb=109f8003b603675aec35e5b1fc678ee363e2f30c;hpb=733b09fa8b6083949ff62795e54851aa282d510c diff --git a/ccan/io/io.h b/ccan/io/io.h index e48f15b5..cbd2b9be 100644 --- a/ccan/io/io.h +++ b/ccan/io/io.h @@ -34,13 +34,6 @@ enum io_result { RESULT_CLOSE }; -enum io_state { - IO_IO, - IO_NEXT, /* eg starting, woken from idle, return from io_break. */ - IO_IDLE, - IO_FINISHED -}; - /** * struct io_plan - returned from a setup function. * @@ -48,8 +41,9 @@ enum io_state { */ struct io_plan { int pollflag; - enum io_state state; + /* Only NULL if idle. */ enum io_result (*io)(struct io_conn *conn); + /* Only NULL if closing. */ struct io_plan (*next)(struct io_conn *, void *arg); void *next_arg; @@ -64,57 +58,44 @@ struct io_plan { /** * io_new_conn - create a new connection. * @fd: the file descriptor. - * @start: the first function to call. + * @plan: the first I/O function. * @finish: the function to call when it's closed or fails. - * @arg: the argument to both @start and @finish. + * @arg: the argument to @finish. * - * This creates a connection which owns @fd. @start will be called on the - * next return to io_loop(), and @finish will be called when an I/O operation + * This creates a connection which owns @fd. @plan will be called on the + * next io_loop(), and @finish will be called when an I/O operation * fails, or you call io_close() on the connection. * - * The @start function must call one of the io queueing functions - * (eg. io_read, io_write) and return the next function to call once - * that is done using io_next(). The alternative is to call io_close(). - * * Returns NULL on error (and sets errno). */ -#define io_new_conn(fd, start, finish, arg) \ - io_new_conn_((fd), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (start), (arg), struct io_conn *), \ +#define io_new_conn(fd, plan, finish, arg) \ + io_new_conn_((fd), (plan), \ typesafe_cb_preargs(void, void *, (finish), (arg), \ struct io_conn *), \ (arg)) struct io_conn *io_new_conn_(int fd, - struct io_plan (*start)(struct io_conn *, void *), + struct io_plan plan, void (*finish)(struct io_conn *, void *), void *arg); /** * io_new_listener - create a new accepting listener. * @fd: the file descriptor. - * @start: the first function to call on new connections. - * @finish: the function to call when the connection is closed or fails. - * @arg: the argument to both @start and @finish. + * @init: the function to call for a new connection + * @arg: the argument to @init. * - * When @fd becomes readable, we accept() and turn that fd into a new - * connection. + * When @fd becomes readable, we accept() and pass that fd to init(). * * Returns NULL on error (and sets errno). */ -#define io_new_listener(fd, start, finish, arg) \ +#define io_new_listener(fd, init, arg) \ io_new_listener_((fd), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (start), (arg), \ - struct io_conn *), \ - typesafe_cb_preargs(void, void *, (finish), \ - (arg), struct io_conn *), \ + typesafe_cb_preargs(void, void *, \ + (init), (arg), \ + int fd), \ (arg)) struct io_listener *io_new_listener_(int fd, - struct io_plan (*start)(struct io_conn *, - void *arg), - void (*finish)(struct io_conn *, - void *arg), + void (*init)(int fd, void *arg), void *arg); /** @@ -250,9 +231,9 @@ bool io_timeout_(struct io_conn *conn, struct timespec ts, /** * io_duplex - split an fd into two connections. * @conn: a connection. - * @start: the first function to call. + * @plan: the first I/O function to call. * @finish: the function to call when it's closed or fails. - * @arg: the argument to both @start and @finish. + * @arg: the argument to @finish. * * Sometimes you want to be able to simultaneously read and write on a * single fd, but io forces a linear call sequence. The solition is @@ -261,56 +242,38 @@ bool io_timeout_(struct io_conn *conn, struct timespec ts, * * You must io_close() both of them to close the fd. */ -#define io_duplex(conn, start, finish, arg) \ - io_duplex_((conn), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (start), (arg), struct io_conn *), \ +#define io_duplex(conn, plan, finish, arg) \ + io_duplex_((conn), (plan), \ typesafe_cb_preargs(void, void *, (finish), (arg), \ struct io_conn *), \ (arg)) struct io_conn *io_duplex_(struct io_conn *conn, - struct io_plan (*start)(struct io_conn *, void *), + struct io_plan plan, void (*finish)(struct io_conn *, void *), void *arg); /** - * io_wake - wake up and idle connection. + * io_wake - wake up an idle connection. * @conn: an idle connection. - * @fn: the next function to call once queued IO is complete. - * @arg: the argument to @next. + * @plan: the next I/O function for @conn. * - * This makes @conn run its @next function the next time around the - * io_loop(). + * This makes @conn do I/O the next time around the io_loop(). */ -#define io_wake(conn, fn, arg) \ - io_wake_((conn), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (fn), (arg), struct io_conn *), \ - (arg)) -void io_wake_(struct io_conn *conn, - struct io_plan (*fn)(struct io_conn *, void *), void *arg); +void io_wake(struct io_conn *conn, struct io_plan plan); /** * io_break - return from io_loop() * @ret: non-NULL value to return from io_loop(). - * @cb: function to call once on return - * @arg: @cb argument + * @plan: I/O to perform on return (if any) * * This breaks out of the io_loop. As soon as the current @next * function returns, any io_closed()'d connections will have their * finish callbacks called, then io_loop() with return with @ret. * - * If io_loop() is called again, then @cb will be called. + * If io_loop() is called again, then @plan will be carried out. */ -#define io_break(ret, fn, arg) \ - io_break_((ret), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (fn), (arg), struct io_conn *), \ - (arg)) -struct io_plan io_break_(void *ret, - struct io_plan (*fn)(struct io_conn *, void *), - void *arg); +struct io_plan io_break(void *ret, struct io_plan plan); /* FIXME: io_recvfrom/io_sendto */