ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.5 by root, Wed Oct 31 07:24:17 2007 UTC vs.
Revision 1.40 by root, Thu Nov 8 00:44:17 2007 UTC

1/*
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
1#ifndef EV_H 30#ifndef EV_H
2#define EV_H 31#define EV_H
3 32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
4typedef double ev_tstamp; 37typedef double ev_tstamp;
5 38
39/* 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#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1
49#endif
50
51/* support multiple event loops? */
52#if EV_MULTIPLICITY
53struct ev_loop;
54# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P,
56# define EV_A loop
57# define EV_A_ EV_A,
58#else
59# define EV_P void
60# define EV_P_
61# define EV_A
62# define EV_A_
63#endif
64
6/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
8#define EV_NONE 0x00 67#define EV_NONE 0x00
9#define EV_READ 0x01 68#define EV_READ 0x01
10#define EV_WRITE 0x02 69#define EV_WRITE 0x02
11#define EV_TIMEOUT 0x04 70#define EV_TIMEOUT 0x000100
71#define EV_PERIODIC 0x000200
12#define EV_SIGNAL 0x08 72#define EV_SIGNAL 0x000400
13#define EV_IDLE 0x10 73#define EV_IDLE 0x000800
14#define EV_CHECK 0x20 74#define EV_CHECK 0x001000
75#define EV_PREPARE 0x002000
76#define EV_CHILD 0x004000
77#define EV_ERROR 0x800000 /* sent when an error occurs */
78
79/* can be used to add custom fields to all watchers */
80#ifndef EV_COMMON
81# define EV_COMMON void *data
82#endif
83#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1
85#endif
86
87#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1
89
90/*
91 * struct member types:
92 * private: you can look at them, but not change them, and they might not mean anything to you.
93 * ro: can be read anytime, but only changed when the watcher isn't active
94 * rw: can be read and modified anytime, even when the watcher is active
95 */
15 96
16/* shared by all watchers */ 97/* shared by all watchers */
17#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
18 int active; /* private */ \ 99 int active; /* private */ \
19 int pending; /* private */ \ 100 int pending; /* private */ \
20 void *data; /* rw */ \ 101 int priority; /* private */ \
102 EV_COMMON; /* rw */ \
21 void (*cb)(struct type *, int revents) /* rw */ /* gets invoked with an eventmask */ 103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */
22 104
23#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
24 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
25 struct type *next /* private */ 107 struct ev_watcher_list *next /* private */
26 108
27/* invoked at a specific time or after a specific time, repeatable */ 109#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \
111 ev_tstamp at /* private */
112
113/* base class, nothing to see here unless you subclass */
114struct ev_watcher {
115 EV_WATCHER (ev_watcher);
116};
117
118/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list {
120 EV_WATCHER_LIST (ev_watcher_list);
121};
122
123/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time {
125 EV_WATCHER_TIME (ev_watcher_time);
126};
127
128/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */
28struct ev_timer 130struct ev_timer
29{ 131{
30 EV_WATCHER_LIST (ev_timer); 132 EV_WATCHER_TIME (ev_timer);
31 133
32 ev_tstamp at; /* private */
33 ev_tstamp repeat; /* rw */ 134 ev_tstamp repeat; /* rw */
34 unsigned char is_abs; /* ro */ 135};
136
137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */
139struct ev_periodic
140{
141 EV_WATCHER_TIME (ev_periodic);
142
143 ev_tstamp interval; /* rw */
144 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
35}; 145};
36 146
37/* invoked when fd is either EV_READable or EV_WRITEable */ 147/* invoked when fd is either EV_READable or EV_WRITEable */
148/* revent EV_READ, EV_WRITE */
38struct ev_io 149struct ev_io
39{ 150{
40 EV_WATCHER_LIST (ev_io); 151 EV_WATCHER_LIST (ev_io);
41 152
42 int fd; /* ro */ 153 int fd; /* ro */
43 int events; /* ro */ 154 int events; /* ro */
44}; 155};
45 156
46/* invoked when the given signal has been received */ 157/* invoked when the given signal has been received */
158/* revent EV_SIGNAL */
47struct ev_signal 159struct ev_signal
48{ 160{
49 EV_WATCHER_LIST (ev_signal); 161 EV_WATCHER_LIST (ev_signal);
50 162
51 int signum; /* ro */ 163 int signum; /* ro */
52}; 164};
53 165
54/* invoked when the nothing else needs to be done, keeps the process from blocking */ 166/* invoked when the nothing else needs to be done, keeps the process from blocking */
167/* revent EV_IDLE */
55struct ev_idle 168struct ev_idle
56{ 169{
57 EV_WATCHER (ev_idle); 170 EV_WATCHER (ev_idle);
58}; 171};
59 172
60/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 173/* invoked for each run of the mainloop, just before the blocking call */
174/* you can still change events in any way you like */
175/* revent EV_PREPARE */
176struct ev_prepare
177{
178 EV_WATCHER (ev_prepare);
179};
180
181/* invoked for each run of the mainloop, just after the blocking call */
182/* revent EV_CHECK */
61struct ev_check 183struct ev_check
62{ 184{
63 EV_WATCHER (ev_check); 185 EV_WATCHER (ev_check);
64}; 186};
65 187
66#define EVMETHOD_NONE 0 188/* invoked when sigchld is received and waitpid indicates the givne pid */
189/* revent EV_CHILD */
190/* does not support priorities */
191struct ev_child
192{
193 EV_WATCHER_LIST (ev_child);
194
195 int pid; /* ro */
196 int rpid; /* rw, holds the received pid */
197 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
198};
199
200union ev_any_watcher
201{
202 struct ev_watcher w;
203 struct ev_watcher_list wl;
204 struct ev_io io;
205 struct ev_timer timer;
206 struct ev_periodic periodic;
207 struct ev_signal signal;
208 struct ev_idle idle;
209 struct ev_child child;
210 struct ev_prepare prepare;
211 struct ev_check check;
212};
213
214#define EVMETHOD_AUTO 0 /* consults environment */
67#define EVMETHOD_SELECT 1 215#define EVMETHOD_SELECT 1
68#define EVMETHOD_EPOLL 2 216#define EVMETHOD_POLL 2
69int ev_init (int flags); /* returns ev_method */ 217#define EVMETHOD_EPOLL 4
70extern int ev_method; 218#define EVMETHOD_KQUEUE 8
219#define EVMETHOD_DEVPOLL 16 /* NYI */
220#define EVMETHOD_PORT 32 /* NYI */
221#define EVMETHOD_WIN32 64 /* NYI */
222#define EVMETHOD_ANY ~0 /* any method, do not consult env */
71 223
72/* these three calls are suitable for plugging into pthread_atfork */ 224#if EV_PROTOTYPES
73void ev_prefork (void); 225int ev_version_major (void);
74void ev_postfork_parent (void); 226int ev_version_minor (void);
75void ev_postfork_child (void);
76 227
77extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
78ev_tstamp ev_time (void); 228ev_tstamp ev_time (void);
229
230/* Sets the allocation function to use, works like realloc.
231 * It is used to allocate and free memory.
232 * If it returns zero when memory needs to be allocated, the library might abort
233 * or take some potentially destructive action.
234 * The default is your system realloc function.
235 */
236void ev_set_allocator (void *(*cb)(void *ptr, long size));
237
238/* set the callback function to call on a
239 * retryable syscall error
240 * (such as failed select, poll, epoll_wait)
241 */
242void ev_set_syserr_cb (void (*cb)(const char *msg));
243
244# if EV_MULTIPLICITY
245/* the default loop is the only one that handles signals and child watchers */
246/* you can call this as often as you like */
247struct ev_loop *ev_default_loop (int methods); /* returns default loop */
248
249/* create and destroy alternative loops that don't handle signals */
250struct ev_loop *ev_loop_new (int methods);
251void ev_loop_destroy (EV_P);
252void ev_loop_fork (EV_P);
253# else
254int ev_default_loop (int methods); /* returns true when successful */
255# endif
256
257void ev_default_destroy (void); /* destroy the default loop */
258/* this needs to be called after fork, to duplicate the default loop */
259/* if you create alternative loops you have to call ev_loop_fork on them */
260/* you can call it in either the parent or the child */
261/* you can actually call it at any time, anywhere :) */
262void ev_default_fork (void);
263
264int ev_method (EV_P);
265#endif
79 266
80#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 267#define EVLOOP_NONBLOCK 1 /* do not block/wait */
81#define EVLOOP_ONESHOT 2 /* block *once* only */ 268#define EVLOOP_ONESHOT 2 /* block *once* only */
269#define EVUNLOOP_ONCE 1 /* unloop once */
270#define EVUNLOOP_ALL 2 /* unloop all loops */
271
272#if EV_PROTOTYPES
82void ev_loop (int flags); 273void ev_loop (EV_P_ int flags);
83extern int ev_loop_done; /* set to 1 to break out of event loop */ 274void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
275
276ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
277
278/*
279 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
280 * keeps one reference. if you have a long-runing watcher you never unregister that
281 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
282 */
283void ev_ref (EV_P);
284void ev_unref (EV_P);
285
286/* convinience function, wait for a single event, without registering an event watcher */
287/* if timeout is < 0, do wait indefinitely */
288void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
289#endif
84 290
85/* these may evaluate ev multiple times, and the other arguments at most once */ 291/* these may evaluate ev multiple times, and the other arguments at most once */
86#define evw_init(ev,cb_,data_) do { (ev)->active = 0; (ev)->cb = (cb_); (ev)->data = (void *)data_; } while (0) 292/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
293#define ev_watcher_init(ev,cb_) do { \
294 ((struct ev_watcher *)(void *)(ev))->active = \
295 ((struct ev_watcher *)(void *)(ev))->pending = \
296 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
297 (ev)->cb = (cb_); \
298} while (0)
87 299
88#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 300#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
89#define evtimer_set_rel(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); (ev)->is_abs = 0; } while (0) 301#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
90#define evtimer_set_abs(ev,at_,repeat_) do { (ev)->at = (at_); (ev)->repeat = (repeat_); (ev)->is_abs = 1; } while (0) 302#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
91#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 303#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
304#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
305#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
306#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
307#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
92 308
309#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
310#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
311#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
312#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
313#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
314#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
315#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
316#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
317
318#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
93#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 319#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
320
321#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
322#define ev_cb(ev) (ev)->cb /* rw */
323#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
324#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
94 325
95/* stopping (enabling, adding) a watcher does nothing if it is already running */ 326/* stopping (enabling, adding) a watcher does nothing if it is already running */
96/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 327/* stopping (disabling, deleting) a watcher does nothing unless its already running */
328#if EV_PROTOTYPES
97void evio_start (struct ev_io *w); 329void ev_io_start (EV_P_ struct ev_io *w);
98void evio_stop (struct ev_io *w); 330void ev_io_stop (EV_P_ struct ev_io *w);
99 331
100void evtimer_start (struct ev_timer *w); 332void ev_timer_start (EV_P_ struct ev_timer *w);
101void evtimer_stop (struct ev_timer *w); 333void ev_timer_stop (EV_P_ struct ev_timer *w);
334/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
335void ev_timer_again (EV_P_ struct ev_timer *w);
102 336
337void ev_periodic_start (EV_P_ struct ev_periodic *w);
338void ev_periodic_stop (EV_P_ struct ev_periodic *w);
339void ev_periodic_again (EV_P_ struct ev_periodic *w);
340
341void ev_idle_start (EV_P_ struct ev_idle *w);
342void ev_idle_stop (EV_P_ struct ev_idle *w);
343
344void ev_prepare_start (EV_P_ struct ev_prepare *w);
345void ev_prepare_stop (EV_P_ struct ev_prepare *w);
346
347void ev_check_start (EV_P_ struct ev_check *w);
348void ev_check_stop (EV_P_ struct ev_check *w);
349
350/* only supported in the default loop */
103void evsignal_start (struct ev_signal *w); 351void ev_signal_start (EV_P_ struct ev_signal *w);
104void evsignal_stop (struct ev_signal *w); 352void ev_signal_stop (EV_P_ struct ev_signal *w);
105 353
354/* only supported in the default loop */
106void evidle_start (struct ev_idle *w); 355void ev_child_start (EV_P_ struct ev_child *w);
107void evidle_stop (struct ev_idle *w); 356void ev_child_stop (EV_P_ struct ev_child *w);
108
109void evcheck_start (struct ev_check *w);
110void evcheck_stop (struct ev_check *w);
111
112#endif 357#endif
113 358
359#ifdef __cplusplus
360}
361#endif
362
363#endif
364

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines