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

   1 /* Licensed under LGPLv2.1+ - see LICENSE file for details */
   2 #ifndef CCAN_IO_H
   3 #define CCAN_IO_H
   4 #include <ccan/tal/tal.h>
   5 #include <ccan/typesafe_cb/typesafe_cb.h>
   6 #include <stdbool.h>
   7 #include <poll.h>
   8 #include <unistd.h>
   9
  10 struct timers;
  11 struct timer;
  12 struct list_head;
  13
  14 /**
  15  * struct io_plan - a plan for input or output.
  16  *
  17  * Each io_conn has zero to two of these active at any time.
  18  */
  19 struct io_plan;
  20
  21 /**
  22  * struct io_conn - a connection associated with an fd.
  23  */
  24 struct io_conn;
  25
  26 /**
  27  * io_new_conn - create a new connection.
  28  * @ctx: the context to tal from (or NULL)
  29  * @fd: the file descriptor.
  30  * @init: the function to call for a new connection
  31  * @arg: the argument to @init.
  32  *
  33  * This creates a connection which owns @fd, it then calls
  34  * @init to initialize the connection, which sets up an io_plan.
  35  *
  36  * Returns NULL on error (and sets errno).
  37  *
  38  * Example:
  39  * // Dumb init function to print string and tell conn to close.
  40  * static struct io_plan *conn_init(struct io_conn *conn, const char *msg)
  41  * {
  42  *      printf("Created conn %p: %s", conn, msg);
  43  *      return io_close(conn);
  44  * }
  45  *
  46  * static void create_self_closing_pipe(void)
  47  * {
  48  *      int fd[2];
  49  *      struct io_conn *conn;
  50  *
  51  *      if (pipe(fd) != 0)
  52  *              exit(1);
  53  *      conn = io_new_conn(NULL, fd[0], conn_init, (const char *)"hi!");
  54  *      if (!conn)
  55  *              exit(1);
  56  * }
  57  */
  58 #define io_new_conn(ctx, fd, init, arg)                                 \
  59         io_new_conn_((ctx), (fd),                                       \
  60                      typesafe_cb_preargs(struct io_plan *, void *,      \
  61                                          (init), (arg),                 \
  62                                          struct io_conn *conn),         \
  63                      (void *)(arg))
  64
  65 struct io_conn *io_new_conn_(const tal_t *ctx, int fd,
  66                              struct io_plan *(*init)(struct io_conn *, void *),
  67                              void *arg);
  68
  69 /**
  70  * io_set_finish - set finish function on a connection.
  71  * @conn: the connection.
  72  * @finish: the function to call when it's closed or fails.
  73  * @arg: the argument to @finish.
  74  *
  75  * @finish will be called when an I/O operation fails, or you call
  76  * io_close() on the connection.  errno will be set to the value
  77  * after the failed I/O, or at the call to io_close().  The fd
  78  * will be closed before @finish is called.
  79  *
  80  * Example:
  81  * static void finish(struct io_conn *conn, const char *msg)
  82  * {
  83  *      // errno is not 0 after success, so this is a bit useless.
  84  *      printf("Conn %p closed with errno %i (%s)\n", conn, errno, msg);
  85  * }
  86  *
  87  * // Dumb init function to print string and tell conn to close.
  88  * static struct io_plan *conn_init(struct io_conn *conn, const char *msg)
  89  * {
  90  *      io_set_finish(conn, finish, msg);
  91  *      return io_close(conn);
  92  * }
  93  */
  94 #define io_set_finish(conn, finish, arg)                                \
  95         io_set_finish_((conn),                                          \
  96                        typesafe_cb_preargs(void, void *,                \
  97                                            (finish), (arg),             \
  98                                            struct io_conn *),           \
  99                        (void *)(arg))
 100 void io_set_finish_(struct io_conn *conn,
 101                     void (*finish)(struct io_conn *, void *),
 102                     void *arg);
 103
 104
 105 /**
 106  * io_new_listener - create a new accepting listener.
 107  * @ctx: the context to tal from (or NULL)
 108  * @fd: the file descriptor.
 109  * @init: the function to call for a new connection
 110  * @arg: the argument to @init.
 111  *
 112  * When @fd becomes readable, we accept(), create a new connection,
 113  * (tal'ocated off @ctx) and pass that to init().  Note that if there is
 114  * an error on this file descriptor, it will be freed.
 115  *
 116  * Returns NULL on error (and sets errno).
 117  *
 118  * Example:
 119  * #include <sys/types.h>
 120  * #include <sys/socket.h>
 121  * #include <netdb.h>
 122  *
 123  * ...
 124  *
 125  * // Set up a listening socket, return it.
 126  * static struct io_listener *do_listen(const char *port)
 127  * {
 128  *      struct addrinfo *addrinfo, hints;
 129  *      int fd, on = 1;
 130  *
 131  *      memset(&hints, 0, sizeof(hints));
 132  *      hints.ai_family = AF_UNSPEC;
 133  *      hints.ai_socktype = SOCK_STREAM;
 134  *      hints.ai_flags = AI_PASSIVE;
 135  *      hints.ai_protocol = 0;
 136  *
 137  *      if (getaddrinfo(NULL, port, &hints, &addrinfo) != 0)
 138  *              return NULL;
 139  *
 140  *      fd = socket(addrinfo->ai_family, addrinfo->ai_socktype,
 141  *                  addrinfo->ai_protocol);
 142  *      if (fd < 0)
 143  *              return NULL;
 144  *
 145  *      freeaddrinfo(addrinfo);
 146  *      setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
 147  *      if (bind(fd, addrinfo->ai_addr, addrinfo->ai_addrlen) != 0) {
 148  *              close(fd);
 149  *              return NULL;
 150  *      }
 151  *      if (listen(fd, 1) != 0) {
 152  *              close(fd);
 153  *              return NULL;
 154  *      }
 155  *      return io_new_listener(NULL, fd, conn_init, (const char *)"listened!");
 156  * }
 157  */
 158 #define io_new_listener(ctx, fd, init, arg)                             \
 159         io_new_listener_((ctx), (fd),                                   \
 160                          typesafe_cb_preargs(struct io_plan *, void *,  \
 161                                              (init), (arg),             \
 162                                              struct io_conn *conn),     \
 163                          (void *)(arg))
 164 struct io_listener *io_new_listener_(const tal_t *ctx, int fd,
 165                                      struct io_plan *(*init)(struct io_conn *,
 166                                                              void *),
 167                                      void *arg);
 168
 169 /**
 170  * io_close_listener - delete a listener.
 171  * @listener: the listener returned from io_new_listener.
 172  *
 173  * This closes the fd and frees @listener.
 174  *
 175  * Example:
 176  * ...
 177  *      struct io_listener *l = do_listen("8111");
 178  *      if (l) {
 179  *              io_loop(NULL, NULL);
 180  *              io_close_listener(l);
 181  *      }
 182  */
 183 void io_close_listener(struct io_listener *listener);
 184
 185 /**
 186  * io_write - output plan to write data.
 187  * @conn: the connection that plan is for.
 188  * @data: the data buffer.
 189  * @len: the length to write.
 190  * @next: function to call output is done.
 191  * @arg: @next argument
 192  *
 193  * This updates the output plan, to write out a data buffer.  Once it's all
 194  * written, the @next function will be called: on an error, the finish
 195  * function is called instead.
 196  *
 197  * Note that the I/O may actually be done immediately.
 198  *
 199  * Example:
 200  * static struct io_plan *write_to_conn(struct io_conn *conn, const char *msg)
 201  * {
 202  *      // Write message, then close.
 203  *      return io_write(conn, msg, strlen(msg), io_close_cb, NULL);
 204  * }
 205  */
 206 #define io_write(conn, data, len, next, arg)                            \
 207         io_write_((conn), (data), (len),                                \
 208                   typesafe_cb_preargs(struct io_plan *, void *,         \
 209                                       (next), (arg), struct io_conn *), \
 210                   (arg))
 211 struct io_plan *io_write_(struct io_conn *conn,
 212                           const void *data, size_t len,
 213                           struct io_plan *(*next)(struct io_conn *, void *),
 214                           void *arg);
 215
 216 /**
 217  * io_read - input plan to read data.
 218  * @conn: the connection that plan is for.
 219  * @data: the data buffer.
 220  * @len: the length to read.
 221  * @next: function to call once input is done.
 222  * @arg: @next argument
 223  *
 224  * This creates a plan to read data into a buffer.  Once it's all
 225  * read, the @next function will be called: on an error, the finish
 226  * function is called instead.  If read() returns 0 (EOF) errno is set
 227  * to 0.
 228  *
 229  * Note that the I/O may actually be done immediately.
 230  *
 231  * Example:
 232  * static struct io_plan *read_from_conn(struct io_conn *conn, char *buf)
 233  * {
 234  *      // Read message, then close.
 235  *      return io_read(conn, buf, 12, io_close_cb, NULL);
 236  * }
 237  */
 238 #define io_read(conn, data, len, next, arg)                             \
 239         io_read_((conn), (data), (len),                                 \
 240                  typesafe_cb_preargs(struct io_plan *, void *,          \
 241                                      (next), (arg), struct io_conn *),  \
 242                  (arg))
 243 struct io_plan *io_read_(struct io_conn *conn,
 244                          void *data, size_t len,
 245                          struct io_plan *(*next)(struct io_conn *, void *),
 246                          void *arg);
 247
 248
 249 /**
 250  * io_read_partial - input plan to read some data.
 251  * @conn: the connection that plan is for.
 252  * @data: the data buffer.
 253  * @maxlen: the maximum length to read
 254  * @lenp: set to the length actually read.
 255  * @next: function to call once input is done.
 256  * @arg: @next argument
 257  *
 258  * This creates a plan to read data into a buffer.  Once any data is
 259  * read, @len is updated and the @next function will be called: on an
 260  * error, the finish function is called instead.  If read() returns 0 (EOF)
 261  * errno is set to 0.
 262  *
 263  * Note that the I/O may actually be done immediately.
 264  *
 265  * Example:
 266  * struct buf {
 267  *      size_t len;
 268  *      char buf[12];
 269  * };
 270  *
 271  * static struct io_plan *dump(struct io_conn *conn, struct buf *b)
 272  * {
 273  *      printf("Partial read: '%*s'\n", (int)b->len, b->buf);
 274  *      free(b);
 275  *      return io_close(conn);
 276  * }
 277  *
 278  * static struct io_plan *read_part(struct io_conn *conn, struct buf *b)
 279  * {
 280  *      // Read message, then dump and close.
 281  *      return io_read_partial(conn, b->buf, sizeof(b->buf), &b->len, dump, b);
 282  * }
 283  */
 284 #define io_read_partial(conn, data, maxlen, lenp, next, arg)            \
 285         io_read_partial_((conn), (data), (maxlen), (lenp),              \
 286                          typesafe_cb_preargs(struct io_plan *, void *,  \
 287                                              (next), (arg),             \
 288                                              struct io_conn *),         \
 289                          (arg))
 290 struct io_plan *io_read_partial_(struct io_conn *conn,
 291                                  void *data, size_t maxlen, size_t *lenp,
 292                                  struct io_plan *(*next)(struct io_conn *,
 293                                                          void *),
 294                                  void *arg);
 295
 296 /**
 297  * io_write_partial - output plan to write some data.
 298  * @conn: the connection that plan is for.
 299  * @data: the data buffer.
 300  * @maxlen: the maximum length to write
 301  * @lenp: set to the length actually written.
 302  * @next: function to call once output is done.
 303  * @arg: @next argument
 304  *
 305  * This creates a plan to write data from a buffer.   Once any data is
 306  * written, @len is updated and the @next function will be called: on an
 307  * error, the finish function is called instead.
 308  *
 309  * Note that the I/O may actually be done immediately.
 310  *
 311  * Example:
 312  * struct buf {
 313  *      size_t len;
 314  *      char buf[12];
 315  * };
 316  *
 317  * static struct io_plan *show_partial(struct io_conn *conn, struct buf *b)
 318  * {
 319  *      printf("Only wrote: '%*s'\n", (int)b->len, b->buf);
 320  *      free(b);
 321  *      return io_close(conn);
 322  * }
 323  *
 324  * static struct io_plan *write_part(struct io_conn *conn, struct buf *b)
 325  * {
 326  *      // Write message, then dump and close.
 327  *      strcpy(b->buf, "Hello world");
 328  *      return io_write_partial(conn, b->buf, strlen(b->buf),
 329  *                              &b->len, show_partial, b);
 330  * }
 331  */
 332 #define io_write_partial(conn, data, maxlen, lenp, next, arg)           \
 333         io_write_partial_((conn), (data), (maxlen), (lenp),             \
 334                           typesafe_cb_preargs(struct io_plan *, void *, \
 335                                               (next), (arg),            \
 336                                               struct io_conn *),        \
 337                           (arg))
 338 struct io_plan *io_write_partial_(struct io_conn *conn,
 339                                   const void *data, size_t maxlen, size_t *lenp,
 340                                   struct io_plan *(*next)(struct io_conn *,
 341                                                           void*),
 342                                   void *arg);
 343
 344 /**
 345  * io_always - plan to immediately call next callback
 346  * @conn: the connection that plan is for.
 347  * @next: function to call.
 348  * @arg: @next argument
 349  *
 350  * Sometimes it's neater to plan a callback rather than call it directly;
 351  * for example, if you only need to read data for one path and not another.
 352  *
 353  * Example:
 354  * static struct io_plan *init_conn_with_nothing(struct io_conn *conn,
 355  *                                               void *unused)
 356  * {
 357  *      // Silly example: close on next time around loop.
 358  *      return io_always(conn, io_close_cb, NULL);
 359  * }
 360  */
 361 #define io_always(conn, next, arg)                                      \
 362         io_always_((conn), typesafe_cb_preargs(struct io_plan *, void *, \
 363                                                (next), (arg),           \
 364                                                struct io_conn *),       \
 365                    (arg))
 366
 367 struct io_plan *io_always_(struct io_conn *conn,
 368                            struct io_plan *(*next)(struct io_conn *, void *),
 369                            void *arg);
 370
 371 /**
 372  * io_out_always - output plan to immediately call next callback
 373  * @conn: the connection that plan is for.
 374  * @next: function to call.
 375  * @arg: @next argument
 376  *
 377  * This is a variant of io_always() which uses the output plan; it only
 378  * matters if you are using io_duplex, and thus have two plans running at
 379  * once.
 380  */
 381 #define io_out_always(conn, next, arg)                                  \
 382         io_out_always_((conn), typesafe_cb_preargs(struct io_plan *, void *, \
 383                                                    (next), (arg),       \
 384                                                    struct io_conn *),   \
 385                        (arg))
 386
 387 struct io_plan *io_out_always_(struct io_conn *conn,
 388                                struct io_plan *(*next)(struct io_conn *,
 389                                                        void *),
 390                                void *arg);
 391
 392 /**
 393  * io_sock_shutdown - start socket close process (flushes TCP sockets).
 394  * @conn: the connection the plan is for
 395  *
 396  * Simply closing a TCP socket can lose data; unfortunately you should
 397  * shutdown(SHUT_WR) and wait for the other side to see this and close.
 398  * Of course, you also need to set a timer, in case it doesn't (you may
 399  * already have some responsiveness timer, of course).
 400  *
 401  * On error, is equivalent to io_close().
 402  *
 403  * Example:
 404  * #include <ccan/timer/timer.h>
 405  *
 406  * // Timer infra needs wrapper to contain extra data.
 407  * struct timeout_timer {
 408  *    struct timer t;
 409  *    struct io_conn *conn;
 410  * };
 411  * static struct timers timers;
 412  *
 413  * static struct io_plan *flush_and_close(struct io_conn *conn)
 414  * {
 415  *    struct timeout_timer *timeout;
 416  *    // Freed if conn closes normally.
 417  *    timeout = tal(conn, struct timeout_timer);
 418  *    timeout->conn = conn;
 419  *    timer_addrel(&timers, &timeout->t, time_from_sec(5));
 420  *    return io_sock_shutdown(conn);
 421  * }
 422  */
 423 struct io_plan *io_sock_shutdown(struct io_conn *conn);
 424
 425 /**
 426  * io_connect - create an asynchronous connection to a listening socket.
 427  * @conn: the connection that plan is for.
 428  * @addr: where to connect.
 429  * @init: function to call once it's connected
 430  * @arg: @init argument
 431  *
 432  * This initiates a connection, and creates a plan for
 433  * (asynchronously) completing it.  Once complete, the @init function
 434  * will be called.
 435  *
 436  * Example:
 437  * #include <sys/types.h>
 438  * #include <sys/socket.h>
 439  * #include <netdb.h>
 440  *
 441  * // Write, then close socket.
 442  * static struct io_plan *init_connect(struct io_conn *conn,
 443  *                                     struct addrinfo *addrinfo)
 444  * {
 445  *      return io_connect(conn, addrinfo, io_close_cb, NULL);
 446  * }
 447  *
 448  * ...
 449  *
 450  *      int fd;
 451  *      struct addrinfo *addrinfo;
 452  *
 453  *      fd = socket(AF_INET, SOCK_STREAM, 0);
 454  *      getaddrinfo("localhost", "8111", NULL, &addrinfo);
 455  *      io_new_conn(NULL, fd, init_connect, addrinfo);
 456  */
 457 struct addrinfo;
 458 #define io_connect(conn, addr, next, arg)                               \
 459         io_connect_((conn), (addr),                                     \
 460                     typesafe_cb_preargs(struct io_plan *, void *,       \
 461                                         (next), (arg),                  \
 462                                         struct io_conn *),              \
 463                     (arg))
 464
 465 struct io_plan *io_connect_(struct io_conn *conn, const struct addrinfo *addr,
 466                             struct io_plan *(*next)(struct io_conn *, void *),
 467                             void *arg);
 468
 469 /**
 470  * io_duplex - set plans for both input and output.
 471  * @conn: the connection that plan is for.
 472  * @in: the input plan
 473  * @out: the output plan
 474  *
 475  * Most plans are either for input or output; io_duplex creates a plan
 476  * which does both.  This is often used in the init function to create
 477  * two independent streams, though it can be used once on any connection.
 478  *
 479  * Note that if either plan closes the connection, it will be closed.
 480  *
 481  * Example:
 482  * struct buf {
 483  *      char in[100];
 484  *      char out[100];
 485  * };
 486  *
 487  * static struct io_plan *read_and_write(struct io_conn *conn, struct buf *b)
 488  * {
 489  *      return io_duplex(conn,
 490  *                       io_read(conn, b->in, sizeof(b->in), io_close_cb, b),
 491  *                       io_write(conn, b->out, sizeof(b->out), io_close_cb,b));
 492  * }
 493  */
 494 struct io_plan *io_duplex(struct io_conn *conn,
 495                           struct io_plan *in_plan, struct io_plan *out_plan);
 496
 497 /**
 498  * io_halfclose - close half of an io_duplex connection.
 499  * @conn: the connection that plan is for.
 500  *
 501  * It's common to want to close a duplex connection after both input and
 502  * output plans have completed.  If either calls io_close() the connection
 503  * closes immediately.  Instead, io_halfclose() needs to be called twice.
 504  *
 505  * Example:
 506  * struct buf {
 507  *      char in[100];
 508  *      char out[100];
 509  * };
 510  *
 511  * static struct io_plan *finish(struct io_conn *conn, struct buf *b)
 512  * {
 513  *      return io_halfclose(conn);
 514  * }
 515  *
 516  * static struct io_plan *read_and_write(struct io_conn *conn, struct buf *b)
 517  * {
 518  *      return io_duplex(conn,
 519  *                       io_read(conn, b->in, sizeof(b->in), finish, b),
 520  *                       io_write(conn, b->out, sizeof(b->out), finish, b));
 521  * }
 522  */
 523 struct io_plan *io_halfclose(struct io_conn *conn);
 524
 525 /**
 526  * io_wait - leave a plan idle until something wakes us.
 527  * @conn: the connection that plan is for.
 528  * @waitaddr: the address to wait on.
 529  * @next: function to call after waiting.
 530  * @arg: @next argument
 531  *
 532  * This leaves the input or output idle: io_wake(@waitaddr) will be
 533  * called later to restart the connection.
 534  *
 535  * Example:
 536  * // Silly example to wait then close.
 537  * static struct io_plan *wait(struct io_conn *conn, void *b)
 538  * {
 539  *      return io_wait(conn, b, io_close_cb, NULL);
 540  * }
 541  */
 542 #define io_wait(conn, waitaddr, next, arg)                              \
 543         io_wait_((conn), (waitaddr),                                    \
 544                  typesafe_cb_preargs(struct io_plan *, void *,          \
 545                                      (next), (arg),                     \
 546                                      struct io_conn *),                 \
 547                  (arg))
 548
 549 struct io_plan *io_wait_(struct io_conn *conn,
 550                          const void *wait,
 551                          struct io_plan *(*next)(struct io_conn *, void *),
 552                          void *arg);
 553
 554
 555 /**
 556  * io_out_wait - leave the output plan idle until something wakes us.
 557  * @conn: the connection that plan is for.
 558  * @waitaddr: the address to wait on.
 559  * @next: function to call after waiting.
 560  * @arg: @next argument
 561  *
 562  * io_wait() makes the input plan idle: if you're not using io_duplex it
 563  * doesn't matter which plan is waiting.  Otherwise, you may need to use
 564  * io_out_wait() instead, to specify explicitly that the output plan is
 565  * waiting.
 566  */
 567 #define io_out_wait(conn, waitaddr, next, arg)                          \
 568         io_out_wait_((conn), (waitaddr),                                \
 569                      typesafe_cb_preargs(struct io_plan *, void *,      \
 570                                          (next), (arg),                 \
 571                                          struct io_conn *),             \
 572                      (arg))
 573
 574 struct io_plan *io_out_wait_(struct io_conn *conn,
 575                              const void *wait,
 576                              struct io_plan *(*next)(struct io_conn *, void *),
 577                              void *arg);
 578
 579 /**
 580  * io_wake - wake up any connections waiting on @wait
 581  * @waitaddr: the address to trigger.
 582  *
 583  * All io_conns who have returned io_wait() on @waitaddr will move on
 584  * to their next callback.
 585  *
 586  * Example:
 587  * static struct io_plan *wake_it(struct io_conn *conn, void *b)
 588  * {
 589  *      io_wake(b);
 590  *      return io_close(conn);
 591  * }
 592  */
 593 void io_wake(const void *wait);
 594
 595 /**
 596  * io_break - return from io_loop()
 597  * @ret: non-NULL value to return from io_loop().
 598  *
 599  * This breaks out of the io_loop.  As soon as the current function
 600  * returns, any io_close()'d connections will have their finish
 601  * callbacks called, then io_loop() with return with @ret.
 602  *
 603  * If io_loop() is called again, then @plan will be carried out.
 604  *
 605  * Example:
 606  *      static struct io_plan *fail_on_timeout(struct io_conn *conn, char *msg)
 607  *      {
 608  *              io_break(msg);
 609  *              return io_close(conn);
 610  *      }
 611  */
 612 void io_break(const void *ret);
 613
 614 /**
 615  * io_never - assert if callback is called.
 616  * @conn: the connection that plan is for.
 617  * @unused: an unused parameter to make this suitable for use as a callback.
 618  *
 619  * Sometimes you want to make it clear that a callback should never happen
 620  * (eg. for io_break).  This will assert() if called.
 621  *
 622  * Example:
 623  * static struct io_plan *break_out(struct io_conn *conn, void *unused)
 624  * {
 625  *      io_break(conn);
 626  *      // We won't ever return from io_break
 627  *      return io_never(conn, NULL);
 628  * }
 629  */
 630 struct io_plan *io_never(struct io_conn *conn, void *unused);
 631
 632 /* FIXME: io_recvfrom/io_sendto */
 633
 634 /**
 635  * io_close - close a connection.
 636  * @conn: the connection to close.
 637  *
 638  * The connection is immediately freed: it doesn't have to be the
 639  * current connection and it doesn't need to be idle.  No more IO or
 640  * callbacks will occur, but if a function was added by io_set_finish()
 641  * it will be called with the current errno preserved.
 642  *
 643  * This is equivalent to tal_free(io_conn), except it returns an io_plan
 644  * for use in an io callback.
 645  *
 646  * Example:
 647  * static struct io_plan *close_on_timeout(struct io_conn *conn, const char *msg)
 648  * {
 649  *      printf("closing: %s\n", msg);
 650  *      return io_close(conn);
 651  * }
 652  */
 653 struct io_plan *io_close(struct io_conn *conn);
 654
 655 /**
 656  * io_close_cb - helper callback to close a connection.
 657  * @conn: the connection.
 658  *
 659  * This is closes a connection; designed to be used as a callback
 660  * function.
 661  *
 662  * Example:
 663  *      #define close_on_timeout io_close_cb
 664  */
 665 struct io_plan *io_close_cb(struct io_conn *, void *unused);
 666
 667 /**
 668  * io_close_taken_fd - close a connection, but remove the filedescriptor first.
 669  * @conn: the connection to take the file descriptor from and close.
 670  *
 671  * io_close closes the file descriptor underlying the io_conn; this version does
 672  * not.  Presumably you have used io_conn_fd() on it beforehand and will take
 673  * care of the fd yourself.
 674  *
 675  * Note that this also turns off O_NONBLOCK on the fd.
 676  *
 677  * Example:
 678  * static struct io_plan *steal_fd(struct io_conn *conn, int *fd)
 679  * {
 680  *      *fd = io_conn_fd(conn);
 681  *      printf("stealing fd %i and closing\n", *fd);
 682  *      return io_close_taken_fd(conn);
 683  * }
 684  */
 685 struct io_plan *io_close_taken_fd(struct io_conn *conn);
 686
 687 /**
 688  * io_loop - process fds until all closed on io_break.
 689  * @timers - timers which are waiting to go off (or NULL for none)
 690  * @expired - an expired timer (can be NULL if @timers is)
 691  *
 692  * This is the core loop; it exits with the io_break() arg, or NULL if
 693  * all connections and listeners are closed, or with @expired set to an
 694  * expired timer (if @timers isn't NULL).
 695  *
 696  * Example:
 697  *      io_loop(NULL, NULL);
 698  */
 699 void *io_loop(struct timers *timers, struct timer **expired);
 700
 701 /**
 702  * io_conn_fd - get the fd from a connection.
 703  * @conn: the connection.
 704  *
 705  * Sometimes useful, eg for getsockname().  Note that the fd is O_NONBLOCK.
 706  *
 707  * See Also:
 708  *      io_close_taken_fd
 709  */
 710 int io_conn_fd(const struct io_conn *conn);
 711
 712 /**
 713  * io_plan_in_started - is this conn doing input I/O now?
 714  * @conn: the conn.
 715  *
 716  * This returns true if input I/O has been performed on the conn but
 717  * @next hasn't been called yet.  For example, io_read() may have done
 718  * a partial read.
 719  *
 720  * This can be useful if we want to terminate a connection only after
 721  * reading a whole packet: if this returns true, we would wait until
 722  * @next is called.
 723  */
 724 bool io_plan_in_started(const struct io_conn *conn);
 725
 726 /**
 727  * io_plan_out_started - is this conn doing output I/O now?
 728  * @conn: the conn.
 729  *
 730  * This returns true if output I/O has been performed on the conn but
 731  * @next hasn't been called yet.  For example, io_write() may have done
 732  * a partial write.
 733  *
 734  * This can be useful if we want to terminate a connection only after
 735  * writing a whole packet: if this returns true, we would wait until
 736  * @next is called.
 737  */
 738 bool io_plan_out_started(const struct io_conn *conn);
 739
 740 /**
 741  * io_flush_sync - (synchronously) complete any outstanding output.
 742  * @conn: the connection.
 743  *
 744  * This is generally used as an emergency escape, for example when we
 745  * want to write an error message on a socket before terminating, but it may
 746  * be in the middle of existing I/O.  We don't want to service any other
 747  * IO, either.
 748  *
 749  * This returns true if all pending output is complete, false on error.
 750  * The next callback is not called on the conn, but will be as soon as
 751  * io_loop() is called.
 752  *
 753  * See Also:
 754  *      io_close_taken_fd
 755  */
 756 bool io_flush_sync(struct io_conn *conn);
 757
 758 /**
 759  * io_conn_exclusive - set/unset an io_conn to exclusively serviced
 760  * @conn: the connection
 761  * @exclusive: whether to be exclusive or not
 762  *
 763  * If any io_conn is set exclusive, then no non-exclusive io_conn (or
 764  * io_listener) will be serviced by io_loop().  If it's a io_duplex io_conn(),
 765  * then io_conn_exclusive() makes the read-side exclusive; io_conn_out_exclusive()
 766  * makes the write-side exclusive.
 767  *
 768  * This allows you to temporarily service only one (or several) fds.
 769  * For example, you might want to flush out one io_conn and not
 770  * receive any new connections or read any other input.
 771  *
 772  * Returns true if any exclusive io_conn remain, otherwise false.
 773  * (This is useful for checking your own logic: dangling exclusive io_conn
 774  * are dangerous!).
 775  */
 776 bool io_conn_exclusive(struct io_conn *conn, bool exclusive);
 777
 778 /**
 779  * io_conn_out_exclusive - set/unset exclusive on the write-side of a duplex
 780  * @conn: the connection, post io_duplex
 781  * @exclusive: whether to be exclusive or not
 782  *
 783  * See io_conn_exclusive() above.
 784  */
 785 bool io_conn_out_exclusive(struct io_conn *conn, bool exclusive);
 786
 787 /**
 788  * io_fd_block - helper to set an fd blocking/nonblocking.
 789  * @fd: the file descriptor
 790  * @block: true to set blocking, false to set non-blocking.
 791  *
 792  * Generally only fails is @fd isn't a valid file descriptor, otherwise
 793  * returns true.
 794  */
 795 bool io_fd_block(int fd, bool block);
 796
 797 /**
 798  * io_time_override - override the normal call for time.
 799  * @nowfn: the function to call.
 800  *
 801  * io usually uses time_mono() internally, but this forces it
 802  * to use your function (eg. for debugging).  Returns the old
 803  * one.
 804  */
 805 struct timemono (*io_time_override(struct timemono (*now)(void)))(void);
 806
 807 /**
 808  * io_poll_override - override the normal call for poll.
 809  * @pollfn: the function to call.
 810  *
 811  * io usually uses poll() internally, but this forces it to use your
 812  * function (eg. for debugging, suppressing fds, or polling on others unknown
 813  * to ccan/io).  Returns the old one.
 814  */
 815 int (*io_poll_override(int (*poll)(struct pollfd *fds, nfds_t nfds, int timeout)))(struct pollfd *, nfds_t, int);
 816
 817 /**
 818  * io_have_fd - do we own this file descriptor?
 819  * @fd: the file descriptor.
 820  * @listener: if non-NULL, set to true if it's a listening socket (io_listener).
 821  *
 822  * Returns NULL if we don't own it, otherwise a struct io_conn * or struct io_listener *.
 823  */
 824 const void *io_have_fd(int fd, bool *listener);
 825
 826 #endif /* CCAN_IO_H */