ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.25
Committed: Sat Nov 3 11:44:44 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.24: +1 -0 lines
Log Message:
rework signal and child handling

File Contents

# User Rev Content
1 root 1.10 /*
2     * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3     * All rights reserved.
4     *
5     * Redistribution and use in source and binary forms, with or without
6     * modification, are permitted provided that the following conditions are
7     * met:
8     *
9     * * Redistributions of source code must retain the above copyright
10     * notice, this list of conditions and the following disclaimer.
11     *
12     * * Redistributions in binary form must reproduce the above
13     * copyright notice, this list of conditions and the following
14     * disclaimer in the documentation and/or other materials provided
15     * with the distribution.
16     *
17     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18     * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19     * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20     * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21     * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22     * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23     * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24     * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27     * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28     */
29    
30 root 1.1 #ifndef EV_H
31     #define EV_H
32    
33 root 1.19 #ifdef __cplusplus
34     extern "C" {
35     #endif
36    
37 root 1.1 typedef double ev_tstamp;
38    
39 root 1.21 /* these priorities are inclusive, higher priorities will be called earlier */
40     #ifndef EV_MINPRI
41     # define EV_MINPRI -2
42     #endif
43     #ifndef EV_MAXPRI
44     # define EV_MAXPRI +2
45     #endif
46    
47 root 1.1 /* eventmask, revents, events... */
48 root 1.17 #define EV_UNDEF -1 /* guaranteed to be invalid */
49     #define EV_NONE 0x00
50     #define EV_READ 0x01
51     #define EV_WRITE 0x02
52     #define EV_TIMEOUT 0x000100
53     #define EV_PERIODIC 0x000200
54     #define EV_SIGNAL 0x000400
55     #define EV_IDLE 0x000800
56     #define EV_CHECK 0x001000
57     #define EV_PREPARE 0x002000
58     #define EV_CHILD 0x004000
59     #define EV_ERROR 0x800000 /* sent when an error occurs */
60 root 1.1
61 root 1.6 /* can be used to add custom fields to all watchers */
62     #ifndef EV_COMMON
63     # define EV_COMMON void *data
64     #endif
65 root 1.9 #ifndef EV_PROTOTYPES
66     # define EV_PROTOTYPES 1
67     #endif
68 root 1.6
69 root 1.14 #define EV_VERSION_MAJOR 1
70     #define EV_VERSION_MINOR 1
71    
72 root 1.6 /*
73     * struct member types:
74     * private: you can look at them, but not change them, and they might not mean anything to you.
75     * ro: can be read anytime, but only changed when the watcher isn't active
76     * rw: can be read and modified anytime, even when the watcher is active
77     */
78    
79 root 1.1 /* shared by all watchers */
80     #define EV_WATCHER(type) \
81     int active; /* private */ \
82     int pending; /* private */ \
83 root 1.21 int priority; /* ro */ \
84 root 1.6 EV_COMMON; /* rw */ \
85     void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
86 root 1.1
87     #define EV_WATCHER_LIST(type) \
88     EV_WATCHER (type); \
89     struct type *next /* private */
90    
91 root 1.6 #define EV_WATCHER_TIME(type) \
92     EV_WATCHER (type); \
93     ev_tstamp at /* private */
94    
95 root 1.7 /* base class, nothing to see here unless you subclass */
96     struct ev_watcher {
97     EV_WATCHER (ev_watcher);
98     };
99    
100     /* base class, nothing to see here unless you subclass */
101     struct ev_watcher_list {
102     EV_WATCHER_LIST (ev_watcher_list);
103     };
104    
105     /* base class, nothing to see here unless you subclass */
106     struct ev_watcher_time {
107     EV_WATCHER_TIME (ev_watcher_time);
108     };
109    
110 root 1.6 /* invoked after a specific time, repeatable (based on monotonic clock) */
111 root 1.17 /* revent EV_TIMEOUT */
112 root 1.1 struct ev_timer
113     {
114 root 1.6 EV_WATCHER_TIME (ev_timer);
115 root 1.1
116     ev_tstamp repeat; /* rw */
117 root 1.6 };
118    
119     /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
120 root 1.17 /* revent EV_PERIODIC */
121 root 1.6 struct ev_periodic
122     {
123     EV_WATCHER_TIME (ev_periodic);
124    
125     ev_tstamp interval; /* rw */
126 root 1.1 };
127    
128 root 1.5 /* invoked when fd is either EV_READable or EV_WRITEable */
129 root 1.17 /* revent EV_READ, EV_WRITE */
130 root 1.1 struct ev_io
131     {
132     EV_WATCHER_LIST (ev_io);
133    
134     int fd; /* ro */
135     int events; /* ro */
136     };
137    
138 root 1.5 /* invoked when the given signal has been received */
139 root 1.17 /* revent EV_SIGNAL */
140 root 1.1 struct ev_signal
141     {
142     EV_WATCHER_LIST (ev_signal);
143    
144     int signum; /* ro */
145     };
146    
147 root 1.5 /* invoked when the nothing else needs to be done, keeps the process from blocking */
148 root 1.17 /* revent EV_IDLE */
149 root 1.5 struct ev_idle
150     {
151     EV_WATCHER (ev_idle);
152     };
153    
154 root 1.11 /* invoked for each run of the mainloop, just before the blocking call */
155     /* you can still change events in any way you like */
156 root 1.17 /* revent EV_PREPARE */
157 root 1.11 struct ev_prepare
158     {
159     EV_WATCHER (ev_prepare);
160     };
161    
162     /* invoked for each run of the mainloop, just after the blocking call */
163 root 1.17 /* revent EV_CHECK */
164 root 1.5 struct ev_check
165     {
166     EV_WATCHER (ev_check);
167     };
168    
169 root 1.12 /* invoked when sigchld is received and waitpid indicates the givne pid */
170 root 1.17 /* revent EV_CHILD */
171 root 1.25 /* does not support priorities */
172 root 1.12 struct ev_child
173     {
174     EV_WATCHER_LIST (ev_child);
175    
176 root 1.24 int pid; /* ro */
177     int rpid; /* rw, holds the received pid */
178     int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
179 root 1.12 };
180    
181 root 1.22 #define EVMETHOD_AUTO 0 /* consults environment */
182     #define EVMETHOD_SELECT 1
183     #define EVMETHOD_POLL 2
184     #define EVMETHOD_EPOLL 4
185     #define EVMETHOD_KQUEUE 8
186 root 1.23 #define EVMETHOD_DEVPOLL 16 /* NYI */
187     #define EVMETHOD_PORT 32 /* NYI */
188 root 1.22 #define EVMETHOD_ANY ~0 /* any method, do not consult env */
189 root 1.9 #if EV_PROTOTYPES
190     extern int ev_method;
191 root 1.20 int ev_init (int methods); /* returns ev_method */
192 root 1.14 int ev_version_major (void);
193     int ev_version_minor (void);
194 root 1.1
195 root 1.5 /* these three calls are suitable for plugging into pthread_atfork */
196 root 1.18 void ev_fork_prepare (void);
197     void ev_fork_parent (void);
198     void ev_fork_child (void);
199 root 1.1
200     extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
201     ev_tstamp ev_time (void);
202 root 1.9 #endif
203 root 1.1
204     #define EVLOOP_NONBLOCK 1 /* do not block/wait */
205     #define EVLOOP_ONESHOT 2 /* block *once* only */
206 root 1.9 #if EV_PROTOTYPES
207 root 1.3 void ev_loop (int flags);
208 root 1.7 extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
209 root 1.1
210 root 1.9 /* convinience function, wait for a single event, without registering an event watcher */
211     /* if timeout is < 0, do wait indefinitely */
212     void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
213     #endif
214    
215 root 1.2 /* these may evaluate ev multiple times, and the other arguments at most once */
216 root 1.16 /* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
217 root 1.21 #define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
218 root 1.3
219 root 1.16 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
220     #define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
221     #define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
222     #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
223     #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
224     #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
225     #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
226     #define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
227    
228     #define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
229     #define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
230     #define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
231     #define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
232     #define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
233     #define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
234     #define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
235     #define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
236 root 1.1
237 root 1.21 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
238     #define ev_set_priority(ev,pri) (ev)->priority = pri
239 root 1.1
240 root 1.5 /* stopping (enabling, adding) a watcher does nothing if it is already running */
241     /* stopping (disabling, deleting) a watcher does nothing unless its already running */
242 root 1.9 #if EV_PROTOTYPES
243 root 1.16 void ev_io_start (struct ev_io *w);
244     void ev_io_stop (struct ev_io *w);
245 root 1.6
246 root 1.16 void ev_timer_start (struct ev_timer *w);
247     void ev_timer_stop (struct ev_timer *w);
248     void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
249 root 1.1
250 root 1.16 void ev_periodic_start (struct ev_periodic *w);
251     void ev_periodic_stop (struct ev_periodic *w);
252 root 1.1
253 root 1.16 void ev_signal_start (struct ev_signal *w);
254     void ev_signal_stop (struct ev_signal *w);
255 root 1.1
256 root 1.16 void ev_idle_start (struct ev_idle *w);
257     void ev_idle_stop (struct ev_idle *w);
258 root 1.5
259 root 1.16 void ev_prepare_start (struct ev_prepare *w);
260     void ev_prepare_stop (struct ev_prepare *w);
261 root 1.11
262 root 1.16 void ev_check_start (struct ev_check *w);
263     void ev_check_stop (struct ev_check *w);
264 root 1.12
265 root 1.16 void ev_child_start (struct ev_child *w);
266     void ev_child_stop (struct ev_child *w);
267 root 1.9 #endif
268 root 1.5
269 root 1.19 #ifdef __cplusplus
270     }
271     #endif
272    
273 root 1.1 #endif
274