io: io_always, and zero-length operations support.
[ccan] / ccan / io / backend.h
index 2b41fa72864ca1df0ac16b2afa023e2cfcd1856c..e2090ff14068ebe0a34317941bb8efc6f7cb9a0a 100644 (file)
-/* Licensed under BSD-MIT - see LICENSE file for details */
+/* Licensed under LGPLv2.1+ - see LICENSE file for details */
 #ifndef CCAN_IO_BACKEND_H
 #define CCAN_IO_BACKEND_H
 #include <stdbool.h>
+#include <ccan/timer/timer.h>
+#include <poll.h>
+
+/* A setting for actions to always run (eg. zero-length reads). */
+#define POLLALWAYS (((POLLIN|POLLOUT) + 1) & ~((POLLIN|POLLOUT)))
+
+struct io_alloc {
+       void *(*alloc)(size_t size);
+       void *(*realloc)(void *ptr, size_t size);
+       void (*free)(void *ptr);
+};
+extern struct io_alloc io_alloc;
 
 struct fd {
        int fd;
        bool listener;
        size_t backend_info;
-
-       struct io_op *(*next)(struct io_conn *, void *arg);
-       void *next_arg;
-
-       void (*finish)(struct io_conn *, void *arg);
-       void *finish_arg;
 };
 
-
 /* Listeners create connections. */
 struct io_listener {
        struct fd fd;
-};
 
-enum io_state {
-       /* These wait for something to input */
-       READ,
-       READPART,
-
-       /* These wait for room to output */
-       WRITE,
-       WRITEPART,
-
-       NEXT, /* eg starting, woken from idle, return from io_break. */
-       IDLE,
-       FINISHED,
-       PROCESSING /* We expect them to change this now. */
-};
-
-static inline enum io_state from_ioop(struct io_op *op)
-{
-       return (enum io_state)(long)op;
-}
-
-struct io_state_read {
-       char *buf;
-       size_t len;
+       /* These are for connections we create. */
+       void (*init)(int fd, void *arg);
+       void *arg;
 };
 
-struct io_state_write {
-       const char *buf;
-       size_t len;
-};
-
-struct io_state_readpart {
-       char *buf;
-       size_t *lenp;
-};
+struct io_timeout {
+       struct timer timer;
+       struct io_conn *conn;
 
-struct io_state_writepart {
-       const char *buf;
-       size_t *lenp;
+       struct io_plan (*next)(struct io_conn *, void *arg);
+       void *next_arg;
 };
 
 /* One connection per client. */
 struct io_conn {
        struct fd fd;
 
+       void (*finish)(struct io_conn *, void *arg);
+       void *finish_arg;
+
        struct io_conn *duplex;
+       struct io_timeout *timeout;
 
-       enum io_state state;
-       union {
-               struct io_state_read read;
-               struct io_state_write write;
-               struct io_state_readpart readpart;
-               struct io_state_writepart writepart;
-       } u;
+       struct io_plan plan;
 };
 
+static inline bool timeout_active(const struct io_conn *conn)
+{
+       return conn->timeout && conn->timeout->conn;
+}
+
 extern void *io_loop_return;
 
+#ifdef DEBUG
+extern struct io_conn *current;
+static inline void set_current(struct io_conn *conn)
+{
+       current = conn;
+}
+static inline bool doing_debug_on(struct io_conn *conn)
+{
+       return io_debug_conn && io_debug_conn(conn);
+}
+static inline bool doing_debug(void)
+{
+       return io_debug_conn;
+}
+#else
+static inline void set_current(struct io_conn *conn)
+{
+}
+static inline bool doing_debug_on(struct io_conn *conn)
+{
+       return false;
+}
+static inline bool doing_debug(void)
+{
+       return false;
+}
+#endif
+
 bool add_listener(struct io_listener *l);
 bool add_conn(struct io_conn *c);
 bool add_duplex(struct io_conn *c);
 void del_listener(struct io_listener *l);
-void backend_set_state(struct io_conn *conn, struct io_op *op);
+void backend_plan_changed(struct io_conn *conn);
+void backend_add_timeout(struct io_conn *conn, struct timespec ts);
+void backend_del_timeout(struct io_conn *conn);
+void backend_del_conn(struct io_conn *conn);
 
-struct io_op *do_ready(struct io_conn *conn);
+void io_ready(struct io_conn *conn);
+void *do_io_loop(struct io_conn **ready);
 #endif /* CCAN_IO_BACKEND_H */