list_compat.h: add copyright info
[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 #ifdef USE_KQUEUE
59 bool flags;
60 #endif
61 };
62
63 struct uloop_timeout
64 {
65 struct list_head list;
66 bool pending;
67
68 uloop_timeout_handler cb;
69 struct timeval time;
70 };
71
72 struct uloop_process
73 {
74 struct list_head list;
75 bool pending;
76
77 uloop_process_handler cb;
78 pid_t pid;
79 };
80
81 extern bool uloop_cancelled;
82 extern bool uloop_handle_sigchld;
83
84 int uloop_fd_add(struct uloop_fd *sock, unsigned int flags);
85 int uloop_fd_delete(struct uloop_fd *sock);
86
87 int uloop_timeout_add(struct uloop_timeout *timeout);
88 int uloop_timeout_set(struct uloop_timeout *timeout, int msecs);
89 int uloop_timeout_cancel(struct uloop_timeout *timeout);
90
91 int uloop_process_add(struct uloop_process *p);
92 int uloop_process_delete(struct uloop_process *p);
93
94 static inline void uloop_end(void)
95 {
96 uloop_cancelled = true;
97 }
98
99 int uloop_init(void);
100 void uloop_run(void);
101 void uloop_done(void);
102
103 #endif