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

Comparing libev/ev.h (file contents):
Revision 1.42 by root, Fri Nov 9 15:15:21 2007 UTC vs.
Revision 1.52 by root, Mon Nov 12 00:31:08 2007 UTC

… …
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 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. 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 28 */
29 29
30#ifndef EV_H 30#ifndef EV_H__
31#define EV_H 31#define EV_H__
32 32
33#ifdef __cplusplus 33#ifdef __cplusplus
34extern "C" { 34extern "C" {
35#endif 35#endif
36 36
… …
44# define EV_MAXPRI +2 44# define EV_MAXPRI +2
45#endif 45#endif
46 46
47#ifndef EV_MULTIPLICITY 47#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1 48# define EV_MULTIPLICITY 1
49#endif
50
51#ifndef EV_PERIODICS
52# define EV_PERIODICS 1
49#endif 53#endif
50 54
51/* support multiple event loops? */ 55/* support multiple event loops? */
52#if EV_MULTIPLICITY 56#if EV_MULTIPLICITY
53struct ev_loop; 57struct ev_loop;
54# define EV_P struct ev_loop *loop 58# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P, 59# define EV_P_ EV_P,
56# define EV_A loop 60# define EV_A loop
57# define EV_A_ EV_A, 61# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A,
58#else 64#else
59# define EV_P void 65# define EV_P void
60# define EV_P_ 66# define EV_P_
61# define EV_A 67# define EV_A
62# define EV_A_ 68# define EV_A_
69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_
63#endif 71#endif
64 72
65/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
66#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1 /* guaranteed to be invalid */
67#define EV_NONE 0x00 75#define EV_NONE 0x00
68#define EV_READ 0x01 76#define EV_READ 0x01 /* io only */
69#define EV_WRITE 0x02 77#define EV_WRITE 0x02 /* io only */
70#define EV_TIMEOUT 0x000100 78#define EV_TIMEOUT 0x000100 /* timer only */
71#define EV_PERIODIC 0x000200 79#define EV_PERIODIC 0x000200 /* periodic timer only */
72#define EV_SIGNAL 0x000400 80#define EV_SIGNAL 0x000400 /* signal only */
73#define EV_IDLE 0x000800 81#define EV_IDLE 0x000800 /* idle only */
74#define EV_CHECK 0x001000 82#define EV_CHECK 0x001000 /* check only */
75#define EV_PREPARE 0x002000 83#define EV_PREPARE 0x002000 /* prepare only */
76#define EV_CHILD 0x004000 84#define EV_CHILD 0x004000 /* child/pid only */
77#define EV_ERROR 0x800000 /* sent when an error occurs */ 85#define EV_ERROR 0x800000 /* sent when an error occurs */
78 86
79/* can be used to add custom fields to all watchers */ 87/* can be used to add custom fields to all watchers, while losing binary compatibility */
80#ifndef EV_COMMON 88#ifndef EV_COMMON
81# define EV_COMMON void *data 89# define EV_COMMON void *data;
82#endif 90#endif
83#ifndef EV_PROTOTYPES 91#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1 92# define EV_PROTOTYPES 1
85#endif 93#endif
86 94
87#define EV_VERSION_MAJOR 1 95#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1 96#define EV_VERSION_MINOR 1
97
98#ifndef EV_CB_DECLARE
99# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
100#endif
101#ifndef EV_CB_INVOKE
102# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
103#endif
89 104
90/* 105/*
91 * struct member types: 106 * struct member types:
92 * private: you can look at them, but not change them, and they might not mean anything to you. 107 * 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 108 * ro: can be read anytime, but only changed when the watcher isn't active
… …
97/* shared by all watchers */ 112/* shared by all watchers */
98#define EV_WATCHER(type) \ 113#define EV_WATCHER(type) \
99 int active; /* private */ \ 114 int active; /* private */ \
100 int pending; /* private */ \ 115 int pending; /* private */ \
101 int priority; /* private */ \ 116 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 117 EV_COMMON /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */ 118 EV_CB_DECLARE (type) /* private */
104 119
105#define EV_WATCHER_LIST(type) \ 120#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 121 EV_WATCHER (type) \
107 struct ev_watcher_list *next /* private */ 122 struct ev_watcher_list *next; /* private */
108 123
109#define EV_WATCHER_TIME(type) \ 124#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \ 125 EV_WATCHER (type) \
111 ev_tstamp at /* private */ 126 ev_tstamp at; /* private */
112 127
113/* base class, nothing to see here unless you subclass */ 128/* base class, nothing to see here unless you subclass */
114struct ev_watcher { 129struct ev_watcher
130{
115 EV_WATCHER (ev_watcher); 131 EV_WATCHER (ev_watcher)
116}; 132};
117 133
118/* base class, nothing to see here unless you subclass */ 134/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list { 135struct ev_watcher_list
136{
120 EV_WATCHER_LIST (ev_watcher_list); 137 EV_WATCHER_LIST (ev_watcher_list)
121}; 138};
122 139
123/* base class, nothing to see here unless you subclass */ 140/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time { 141struct ev_watcher_time
142{
125 EV_WATCHER_TIME (ev_watcher_time); 143 EV_WATCHER_TIME (ev_watcher_time)
126}; 144};
127 145
128/* invoked after a specific time, repeatable (based on monotonic clock) */ 146/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */ 147/* revent EV_TIMEOUT */
130struct ev_timer 148struct ev_timer
131{ 149{
132 EV_WATCHER_TIME (ev_timer); 150 EV_WATCHER_TIME (ev_timer)
133 151
134 ev_tstamp repeat; /* rw */ 152 ev_tstamp repeat; /* rw */
135}; 153};
136 154
137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 155/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */ 156/* revent EV_PERIODIC */
139struct ev_periodic 157struct ev_periodic
140{ 158{
141 EV_WATCHER_TIME (ev_periodic); 159 EV_WATCHER_TIME (ev_periodic)
142 160
143 ev_tstamp interval; /* rw */ 161 ev_tstamp interval; /* rw */
144 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
145}; 163};
146 164
147/* invoked when fd is either EV_READable or EV_WRITEable */ 165/* invoked when fd is either EV_READable or EV_WRITEable */
148/* revent EV_READ, EV_WRITE */ 166/* revent EV_READ, EV_WRITE */
149struct ev_io 167struct ev_io
150{ 168{
151 EV_WATCHER_LIST (ev_io); 169 EV_WATCHER_LIST (ev_io)
152 170
153 int fd; /* ro */ 171 int fd; /* ro */
154 int events; /* ro */ 172 int events; /* ro */
155}; 173};
156 174
157/* invoked when the given signal has been received */ 175/* invoked when the given signal has been received */
158/* revent EV_SIGNAL */ 176/* revent EV_SIGNAL */
159struct ev_signal 177struct ev_signal
160{ 178{
161 EV_WATCHER_LIST (ev_signal); 179 EV_WATCHER_LIST (ev_signal)
162 180
163 int signum; /* ro */ 181 int signum; /* ro */
164}; 182};
165 183
166/* invoked when the nothing else needs to be done, keeps the process from blocking */ 184/* invoked when the nothing else needs to be done, keeps the process from blocking */
167/* revent EV_IDLE */ 185/* revent EV_IDLE */
168struct ev_idle 186struct ev_idle
169{ 187{
170 EV_WATCHER (ev_idle); 188 EV_WATCHER (ev_idle)
171}; 189};
172 190
173/* invoked for each run of the mainloop, just before the blocking call */ 191/* invoked for each run of the mainloop, just before the blocking call */
174/* you can still change events in any way you like */ 192/* you can still change events in any way you like */
175/* revent EV_PREPARE */ 193/* revent EV_PREPARE */
176struct ev_prepare 194struct ev_prepare
177{ 195{
178 EV_WATCHER (ev_prepare); 196 EV_WATCHER (ev_prepare)
179}; 197};
180 198
181/* invoked for each run of the mainloop, just after the blocking call */ 199/* invoked for each run of the mainloop, just after the blocking call */
182/* revent EV_CHECK */ 200/* revent EV_CHECK */
183struct ev_check 201struct ev_check
184{ 202{
185 EV_WATCHER (ev_check); 203 EV_WATCHER (ev_check)
186}; 204};
187 205
188/* invoked when sigchld is received and waitpid indicates the givne pid */ 206/* invoked when sigchld is received and waitpid indicates the givne pid */
189/* revent EV_CHILD */ 207/* revent EV_CHILD */
190/* does not support priorities */ 208/* does not support priorities */
191struct ev_child 209struct ev_child
192{ 210{
193 EV_WATCHER_LIST (ev_child); 211 EV_WATCHER_LIST (ev_child)
194 212
195 int pid; /* ro */ 213 int pid; /* ro */
196 int rpid; /* rw, holds the received pid */ 214 int rpid; /* rw, holds the received pid */
197 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
198}; 216};
… …
200/* the presence of this union forces similar struct layout */ 218/* the presence of this union forces similar struct layout */
201union ev_any_watcher 219union ev_any_watcher
202{ 220{
203 struct ev_watcher w; 221 struct ev_watcher w;
204 struct ev_watcher_list wl; 222 struct ev_watcher_list wl;
223
205 struct ev_io io; 224 struct ev_io io;
206 struct ev_timer timer; 225 struct ev_timer timer;
207 struct ev_periodic periodic; 226 struct ev_periodic periodic;
208 struct ev_signal signal;
209 struct ev_idle idle; 227 struct ev_idle idle;
210 struct ev_child child;
211 struct ev_prepare prepare; 228 struct ev_prepare prepare;
212 struct ev_check check; 229 struct ev_check check;
230 struct ev_signal signal;
231 struct ev_child child;
213}; 232};
214 233
215#define EVMETHOD_AUTO 0 /* consults environment */ 234#define EVMETHOD_AUTO 0 /* consults environment */
216#define EVMETHOD_SELECT 1 235#define EVMETHOD_SELECT 1
217#define EVMETHOD_POLL 2 236#define EVMETHOD_POLL 2
… …
249 268
250/* create and destroy alternative loops that don't handle signals */ 269/* create and destroy alternative loops that don't handle signals */
251struct ev_loop *ev_loop_new (int methods); 270struct ev_loop *ev_loop_new (int methods);
252void ev_loop_destroy (EV_P); 271void ev_loop_destroy (EV_P);
253void ev_loop_fork (EV_P); 272void ev_loop_fork (EV_P);
273
274ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
275
254# else 276# else
277
255int ev_default_loop (int methods); /* returns true when successful */ 278int ev_default_loop (int methods); /* returns true when successful */
279
280static ev_tstamp
281ev_now (void)
282{
283 extern ev_tstamp ev_rt_now;
284
285 return ev_rt_now;
286}
256# endif 287# endif
257 288
258void ev_default_destroy (void); /* destroy the default loop */ 289void ev_default_destroy (void); /* destroy the default loop */
259/* this needs to be called after fork, to duplicate the default loop */ 290/* this needs to be called after fork, to duplicate the default loop */
260/* if you create alternative loops you have to call ev_loop_fork on them */ 291/* if you create alternative loops you have to call ev_loop_fork on them */
… …
271#define EVUNLOOP_ALL 2 /* unloop all loops */ 302#define EVUNLOOP_ALL 2 /* unloop all loops */
272 303
273#if EV_PROTOTYPES 304#if EV_PROTOTYPES
274void ev_loop (EV_P_ int flags); 305void ev_loop (EV_P_ int flags);
275void 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 */ 306void 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 */
276
277ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
278 307
279/* 308/*
280 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 309 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
281 * keeps one reference. if you have a long-runing watcher you never unregister that 310 * keeps one reference. if you have a long-runing watcher you never unregister that
282 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 311 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
288/* if timeout is < 0, do wait indefinitely */ 317/* if timeout is < 0, do wait indefinitely */
289void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 318void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
290#endif 319#endif
291 320
292/* these may evaluate ev multiple times, and the other arguments at most once */ 321/* these may evaluate ev multiple times, and the other arguments at most once */
293/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 322/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
294#define ev_watcher_init(ev,cb_) do { \ 323#define ev_init(ev,cb_) do { \
295 ((struct ev_watcher *)(void *)(ev))->active = \ 324 ((struct ev_watcher *)(void *)(ev))->active = \
296 ((struct ev_watcher *)(void *)(ev))->pending = \ 325 ((struct ev_watcher *)(void *)(ev))->pending = \
297 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 326 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
298 (ev)->cb = (cb_); \ 327 ev_set_cb ((ev), cb_); \
299} while (0) 328} while (0)
300 329
301#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 330#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
302#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 331#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
303#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 332#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
… …
305#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 334#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
306#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 335#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
307#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 336#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
308#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 337#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
309 338
310#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 339#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
311#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 340#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
312#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 341#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
313#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 342#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
314#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 343#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
315#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 344#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
316#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 345#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
317#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 346#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
318 347
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 348#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
320#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 349#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
321 350
322#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 351#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
323#define ev_cb(ev) (ev)->cb /* rw */ 352#define ev_cb(ev) (ev)->cb /* rw */
324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 353#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
354
355#ifndef ev_set_cb
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 356# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
357#endif
326 358
327/* stopping (enabling, adding) a watcher does nothing if it is already running */ 359/* stopping (enabling, adding) a watcher does nothing if it is already running */
328/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 360/* stopping (disabling, deleting) a watcher does nothing unless its already running */
329#if EV_PROTOTYPES 361#if EV_PROTOTYPES
330 362
… …
340void ev_timer_start (EV_P_ struct ev_timer *w); 372void ev_timer_start (EV_P_ struct ev_timer *w);
341void ev_timer_stop (EV_P_ struct ev_timer *w); 373void ev_timer_stop (EV_P_ struct ev_timer *w);
342/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 374/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
343void ev_timer_again (EV_P_ struct ev_timer *w); 375void ev_timer_again (EV_P_ struct ev_timer *w);
344 376
377#if EV_PERIODICS
345void ev_periodic_start (EV_P_ struct ev_periodic *w); 378void ev_periodic_start (EV_P_ struct ev_periodic *w);
346void ev_periodic_stop (EV_P_ struct ev_periodic *w); 379void ev_periodic_stop (EV_P_ struct ev_periodic *w);
347void ev_periodic_again (EV_P_ struct ev_periodic *w); 380void ev_periodic_again (EV_P_ struct ev_periodic *w);
381#endif
348 382
349void ev_idle_start (EV_P_ struct ev_idle *w); 383void ev_idle_start (EV_P_ struct ev_idle *w);
350void ev_idle_stop (EV_P_ struct ev_idle *w); 384void ev_idle_stop (EV_P_ struct ev_idle *w);
351 385
352void ev_prepare_start (EV_P_ struct ev_prepare *w); 386void ev_prepare_start (EV_P_ struct ev_prepare *w);

Diff Legend

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