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

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

Diff Legend

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