39b9b582336efe7780ea6c36a6f24c77277c963f
[project/libubox.git] / uloop.h
1 /*
2 * uloop - event loop implementation
3 *
4 * Copyright (C) 2010-2013 Felix Fietkau <nbd@openwrt.org>
5 *
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 #ifndef _ULOOP_H__
19 #define _ULOOP_H__
20
21 #include <sys/time.h>
22 #include <sys/types.h>
23 #include <stdbool.h>
24 #include <stdint.h>
25 #include <signal.h>
26
27 #if defined(__APPLE__) || defined(__FreeBSD__)
28 #define USE_KQUEUE
29 #else
30 #define USE_EPOLL
31 #endif
32
33 #include "list.h"
34
35 struct uloop_fd;
36 struct uloop_timeout;
37 struct uloop_process;
38
39 typedef void (*uloop_fd_handler)(struct uloop_fd *u, unsigned int events);
40 typedef void (*uloop_timeout_handler)(struct uloop_timeout *t);
41 typedef void (*uloop_process_handler)(struct uloop_process *c, int ret);
42
43 #define ULOOP_READ (1 << 0)
44 #define ULOOP_WRITE (1 << 1)
45 #define ULOOP_EDGE_TRIGGER (1 << 2)
46 #define ULOOP_BLOCKING (1 << 3)
47 #ifdef USE_KQUEUE
48 #define ULOOP_EDGE_DEFER (1 << 4)
49 #endif
50
51 struct uloop_fd
52 {
53 uloop_fd_handler cb;
54 int fd;
55 bool eof;
56 bool error;
57 bool registered;
58 uint8_t flags;
59 };
60
61 struct uloop_timeout
62 {
63 struct list_head list;
64 bool pending;
65
66 uloop_timeout_handler cb;
67 struct timeval time;
68 };
69
70 struct uloop_process
71 {
72 struct list_head list;
73 bool pending;
74
75 uloop_process_handler cb;
76 pid_t pid;
77 };
78
79 extern bool uloop_cancelled;
80 extern bool uloop_handle_sigchld;
81
82 int uloop_fd_add(struct uloop_fd *sock, unsigned int flags);
83 int uloop_fd_delete(struct uloop_fd *sock);
84
85 int uloop_timeout_add(struct uloop_timeout *timeout);
86 int uloop_timeout_set(struct uloop_timeout *timeout, int msecs);
87 int uloop_timeout_cancel(struct uloop_timeout *timeout);
88 int uloop_timeout_remaining(struct uloop_timeout *timeout);
89
90 int uloop_process_add(struct uloop_process *p);
91 int uloop_process_delete(struct uloop_process *p);
92
93 static inline void uloop_end(void)
94 {
95 uloop_cancelled = true;
96 }
97
98 int uloop_init(void);
99 void uloop_run(void);
100 void uloop_done(void);
101
102 #endif