From 3ea93e853e44fd7e227688cb96f5f847817862c0 Mon Sep 17 00:00:00 2001 From: Denys Vlasenko Date: Thu, 9 Jan 2014 19:58:19 +0100 Subject: networking: explain isrv_run() API Signed-off-by: Denys Vlasenko --- networking/isrv.h | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) (limited to 'networking/isrv.h') diff --git a/networking/isrv.h b/networking/isrv.h index 4c7e01dd1..a42fd4100 100644 --- a/networking/isrv.h +++ b/networking/isrv.h @@ -23,7 +23,32 @@ int isrv_register_fd(isrv_state_t *state, int peer, int fd); void isrv_close_fd(isrv_state_t *state, int fd); int isrv_register_peer(isrv_state_t *state, void *param); -/* driver */ +/* Driver: + * + * Select on listen_fd for (or forever if 0). + * + * If we time out and we have no peers, exit. + * If we have peers, call do_timeout(peer_param), + * if it returns !0, peer is removed. + * + * If listen_fd is active, accept new connection ("peer"), + * call new_peer() on it, and if it returns 1, + * and add it to fds to select on. + * Now, select will wait for , not + * (as long as we we have more than zero clients). + * + * If a peer's fd is active, we call do_rd() on it if read + * mask bit was set, + * and then do_wr() if write mask bit was also set. + * If either returns !0, peer is removed. + * Reaching this place also resets timeout counter for this peer. + * + * Note that peer must indicate that he wants to be selected + * for read and/or write using isrv_want_rd()/isrv_want_wr() + * [can be called in new_peer() or in do_rd()/do_wr()]. + * If it never wants to be selected for write, do_wr() + * will never be called (can be NULL). + */ void isrv_run( int listen_fd, int (*new_peer)(isrv_state_t *state, int fd), -- cgit v1.2.3