git.ozlabs.org Git - ccan/blob - ccan/io/backend.h

   1 /* Licensed under LGPLv2.1+ - see LICENSE file for details */
   2 #ifndef CCAN_IO_BACKEND_H
   3 #define CCAN_IO_BACKEND_H
   4 #include <stdbool.h>
   5 #include "io_plan.h"
   6 #include <ccan/list/list.h>
   7
   8 struct fd {
   9         int fd;
  10         bool listener;
  11         size_t backend_info;
  12 };
  13
  14 /* Listeners create connections. */
  15 struct io_listener {
  16         struct fd fd;
  17
  18         const tal_t *ctx;
  19
  20         /* These are for connections we create. */
  21         struct io_plan *(*init)(struct io_conn *conn, void *arg);
  22         void *arg;
  23 };
  24
  25 enum io_plan_status {
  26         /* As before calling next function. */
  27         IO_UNSET,
  28         /* Normal, but haven't started yet. */
  29         IO_POLLING_NOTSTARTED,
  30         IO_POLLING_STARTED,
  31         /* Waiting for io_wake */
  32         IO_WAITING,
  33         /* Always do this. */
  34         IO_ALWAYS
  35 };
  36
  37 /**
  38  * struct io_plan - one half of I/O to do
  39  * @status: the status of this plan.
  40  * @io: function to call when fd becomes read/writable, returns 0 to be
  41  *      called again, 1 if it's finished, and -1 on error (fd will be closed)
  42  * @next: the next function which is called if io returns 1.
  43  * @next_arg: the argument to @next
  44  * @u1, @u2: scratch space for @io.
  45  */
  46 struct io_plan {
  47         enum io_plan_status status;
  48
  49         int (*io)(int fd, struct io_plan_arg *arg);
  50
  51         struct io_plan *(*next)(struct io_conn *, void *next_arg);
  52         void *next_arg;
  53
  54         struct io_plan_arg arg;
  55 };
  56
  57 /* One connection per client. */
  58 struct io_conn {
  59         struct fd fd;
  60
  61         /* always list. */
  62         struct list_node always;
  63
  64         void (*finish)(struct io_conn *, void *arg);
  65         void *finish_arg;
  66
  67         struct io_plan plan[2];
  68 };
  69
  70 extern void *io_loop_return;
  71
  72 bool add_listener(struct io_listener *l);
  73 bool add_conn(struct io_conn *c);
  74 bool add_duplex(struct io_conn *c);
  75 void del_listener(struct io_listener *l);
  76 void cleanup_conn_without_close(struct io_conn *c);
  77 void backend_new_always(struct io_conn *conn);
  78 void backend_new_plan(struct io_conn *conn);
  79 void remove_from_always(struct io_conn *conn);
  80 void backend_plan_done(struct io_conn *conn);
  81
  82 void backend_wake(const void *wait);
  83
  84 void io_ready(struct io_conn *conn, int pollflags);
  85 void io_do_always(struct io_conn *conn);
  86 void io_do_wakeup(struct io_conn *conn, enum io_direction dir);
  87 void *do_io_loop(struct io_conn **ready);
  88 #endif /* CCAN_IO_BACKEND_H */