ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.27
Committed: Sat Nov 3 21:58:51 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.26: +38 -24 lines
Log Message:
prepare for multiple bases

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.27 #define EV_P void
48     #define EV_P_
49     #define EV_A
50     #define EV_A_
51    
52 root 1.1 /* eventmask, revents, events... */
53 root 1.17 #define EV_UNDEF -1 /* guaranteed to be invalid */
54     #define EV_NONE 0x00
55     #define EV_READ 0x01
56     #define EV_WRITE 0x02
57     #define EV_TIMEOUT 0x000100
58     #define EV_PERIODIC 0x000200
59     #define EV_SIGNAL 0x000400
60     #define EV_IDLE 0x000800
61     #define EV_CHECK 0x001000
62     #define EV_PREPARE 0x002000
63     #define EV_CHILD 0x004000
64     #define EV_ERROR 0x800000 /* sent when an error occurs */
65 root 1.1
66 root 1.6 /* can be used to add custom fields to all watchers */
67     #ifndef EV_COMMON
68     # define EV_COMMON void *data
69     #endif
70 root 1.9 #ifndef EV_PROTOTYPES
71     # define EV_PROTOTYPES 1
72     #endif
73 root 1.6
74 root 1.14 #define EV_VERSION_MAJOR 1
75     #define EV_VERSION_MINOR 1
76    
77 root 1.6 /*
78     * struct member types:
79     * private: you can look at them, but not change them, and they might not mean anything to you.
80     * ro: can be read anytime, but only changed when the watcher isn't active
81     * rw: can be read and modified anytime, even when the watcher is active
82     */
83    
84 root 1.1 /* shared by all watchers */
85     #define EV_WATCHER(type) \
86     int active; /* private */ \
87     int pending; /* private */ \
88 root 1.21 int priority; /* ro */ \
89 root 1.6 EV_COMMON; /* rw */ \
90 root 1.27 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
91 root 1.1
92     #define EV_WATCHER_LIST(type) \
93     EV_WATCHER (type); \
94 root 1.26 struct ev_watcher_list *next /* private */
95 root 1.1
96 root 1.6 #define EV_WATCHER_TIME(type) \
97     EV_WATCHER (type); \
98     ev_tstamp at /* private */
99    
100 root 1.7 /* base class, nothing to see here unless you subclass */
101     struct ev_watcher {
102     EV_WATCHER (ev_watcher);
103     };
104    
105     /* base class, nothing to see here unless you subclass */
106     struct ev_watcher_list {
107     EV_WATCHER_LIST (ev_watcher_list);
108     };
109    
110     /* base class, nothing to see here unless you subclass */
111     struct ev_watcher_time {
112     EV_WATCHER_TIME (ev_watcher_time);
113     };
114    
115 root 1.6 /* invoked after a specific time, repeatable (based on monotonic clock) */
116 root 1.17 /* revent EV_TIMEOUT */
117 root 1.1 struct ev_timer
118     {
119 root 1.6 EV_WATCHER_TIME (ev_timer);
120 root 1.1
121     ev_tstamp repeat; /* rw */
122 root 1.6 };
123    
124     /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
125 root 1.17 /* revent EV_PERIODIC */
126 root 1.6 struct ev_periodic
127     {
128     EV_WATCHER_TIME (ev_periodic);
129    
130     ev_tstamp interval; /* rw */
131 root 1.1 };
132    
133 root 1.5 /* invoked when fd is either EV_READable or EV_WRITEable */
134 root 1.17 /* revent EV_READ, EV_WRITE */
135 root 1.1 struct ev_io
136     {
137     EV_WATCHER_LIST (ev_io);
138    
139     int fd; /* ro */
140     int events; /* ro */
141     };
142    
143 root 1.5 /* invoked when the given signal has been received */
144 root 1.17 /* revent EV_SIGNAL */
145 root 1.1 struct ev_signal
146     {
147     EV_WATCHER_LIST (ev_signal);
148    
149     int signum; /* ro */
150     };
151    
152 root 1.5 /* invoked when the nothing else needs to be done, keeps the process from blocking */
153 root 1.17 /* revent EV_IDLE */
154 root 1.5 struct ev_idle
155     {
156     EV_WATCHER (ev_idle);
157     };
158    
159 root 1.11 /* invoked for each run of the mainloop, just before the blocking call */
160     /* you can still change events in any way you like */
161 root 1.17 /* revent EV_PREPARE */
162 root 1.11 struct ev_prepare
163     {
164     EV_WATCHER (ev_prepare);
165     };
166    
167     /* invoked for each run of the mainloop, just after the blocking call */
168 root 1.17 /* revent EV_CHECK */
169 root 1.5 struct ev_check
170     {
171     EV_WATCHER (ev_check);
172     };
173    
174 root 1.12 /* invoked when sigchld is received and waitpid indicates the givne pid */
175 root 1.17 /* revent EV_CHILD */
176 root 1.25 /* does not support priorities */
177 root 1.12 struct ev_child
178     {
179     EV_WATCHER_LIST (ev_child);
180    
181 root 1.24 int pid; /* ro */
182     int rpid; /* rw, holds the received pid */
183     int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
184 root 1.12 };
185    
186 root 1.22 #define EVMETHOD_AUTO 0 /* consults environment */
187     #define EVMETHOD_SELECT 1
188     #define EVMETHOD_POLL 2
189     #define EVMETHOD_EPOLL 4
190     #define EVMETHOD_KQUEUE 8
191 root 1.23 #define EVMETHOD_DEVPOLL 16 /* NYI */
192     #define EVMETHOD_PORT 32 /* NYI */
193 root 1.22 #define EVMETHOD_ANY ~0 /* any method, do not consult env */
194 root 1.9 #if EV_PROTOTYPES
195 root 1.27 int ev_method (EV_P);
196     int ev_init (EV_P_ int methods); /* returns ev_method */
197 root 1.14 int ev_version_major (void);
198     int ev_version_minor (void);
199 root 1.1
200 root 1.5 /* these three calls are suitable for plugging into pthread_atfork */
201 root 1.18 void ev_fork_prepare (void);
202     void ev_fork_parent (void);
203     void ev_fork_child (void);
204 root 1.1
205     ev_tstamp ev_time (void);
206 root 1.9 #endif
207 root 1.1
208     #define EVLOOP_NONBLOCK 1 /* do not block/wait */
209     #define EVLOOP_ONESHOT 2 /* block *once* only */
210 root 1.9 #if EV_PROTOTYPES
211 root 1.27 void ev_loop (EV_P_ int flags);
212     void ev_unloop (EV_P_ int status); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
213    
214     ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
215    
216     /*
217     * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
218     * keeps one reference. if you have a long-runing watcher you never unregister that
219     * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
220     */
221     void ev_ref (EV_P);
222     void ev_unref (EV_P);
223 root 1.1
224 root 1.9 /* convinience function, wait for a single event, without registering an event watcher */
225     /* if timeout is < 0, do wait indefinitely */
226 root 1.27 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
227 root 1.9 #endif
228    
229 root 1.2 /* these may evaluate ev multiple times, and the other arguments at most once */
230 root 1.16 /* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
231 root 1.21 #define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
232 root 1.3
233 root 1.16 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
234     #define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
235     #define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
236     #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
237     #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
238     #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
239     #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
240     #define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
241    
242     #define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
243     #define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
244     #define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
245     #define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
246     #define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
247     #define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
248     #define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
249     #define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
250 root 1.1
251 root 1.21 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
252     #define ev_set_priority(ev,pri) (ev)->priority = pri
253 root 1.1
254 root 1.5 /* stopping (enabling, adding) a watcher does nothing if it is already running */
255     /* stopping (disabling, deleting) a watcher does nothing unless its already running */
256 root 1.9 #if EV_PROTOTYPES
257 root 1.27 void ev_io_start (EV_P_ struct ev_io *w);
258     void ev_io_stop (EV_P_ struct ev_io *w);
259 root 1.6
260 root 1.27 void ev_timer_start (EV_P_ struct ev_timer *w);
261     void ev_timer_stop (EV_P_ struct ev_timer *w);
262     void ev_timer_again (EV_P_ struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
263 root 1.1
264 root 1.27 void ev_periodic_start (EV_P_ struct ev_periodic *w);
265     void ev_periodic_stop (EV_P_ struct ev_periodic *w);
266 root 1.1
267 root 1.27 void ev_signal_start (EV_P_ struct ev_signal *w);
268     void ev_signal_stop (EV_P_ struct ev_signal *w);
269 root 1.1
270 root 1.27 void ev_idle_start (EV_P_ struct ev_idle *w);
271     void ev_idle_stop (EV_P_ struct ev_idle *w);
272 root 1.5
273 root 1.27 void ev_prepare_start (EV_P_ struct ev_prepare *w);
274     void ev_prepare_stop (EV_P_ struct ev_prepare *w);
275 root 1.11
276 root 1.27 void ev_check_start (EV_P_ struct ev_check *w);
277     void ev_check_stop (EV_P_ struct ev_check *w);
278 root 1.12
279 root 1.27 void ev_child_start (EV_P_ struct ev_child *w);
280     void ev_child_stop (EV_P_ struct ev_child *w);
281 root 1.9 #endif
282 root 1.5
283 root 1.19 #ifdef __cplusplus
284     }
285     #endif
286    
287 root 1.1 #endif
288