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

Comparing libev/ev.h (file contents):
Revision 1.56 by root, Mon Nov 12 07:58:13 2007 UTC vs.
Revision 1.68 by root, Sat Nov 24 09:48:38 2007 UTC

… …
69# define EV_DEFAULT_A 69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_ 70# define EV_DEFAULT_A_
71#endif 71#endif
72 72
73/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
74#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1L /* guaranteed to be invalid */
75#define EV_NONE 0x00 75#define EV_NONE 0x00L
76#define EV_READ 0x01 /* io only */ 76#define EV_READ 0x01L /* io only */
77#define EV_WRITE 0x02 /* io only */ 77#define EV_WRITE 0x02L /* io only */
78#define EV_TIMEOUT 0x000100 /* timer only */ 78#define EV_TIMEOUT 0x000100L /* timer only */
79#define EV_PERIODIC 0x000200 /* periodic timer only */ 79#define EV_PERIODIC 0x000200L /* periodic timer only */
80#define EV_SIGNAL 0x000400 /* signal only */ 80#define EV_SIGNAL 0x000400L /* signal only */
81#define EV_IDLE 0x000800 /* idle only */ 81#define EV_IDLE 0x000800L /* idle only */
82#define EV_CHECK 0x001000 /* check only */ 82#define EV_CHECK 0x001000L /* check only */
83#define EV_PREPARE 0x002000 /* prepare only */ 83#define EV_PREPARE 0x002000L /* prepare only */
84#define EV_CHILD 0x004000 /* child/pid only */ 84#define EV_CHILD 0x004000L /* child/pid only */
85#define EV_EMBED 0x008000L /* embedded event loop */
85#define EV_ERROR 0x800000 /* sent when an error occurs */ 86#define EV_ERROR 0x800000L /* sent when an error occurs */
86 87
87/* can be used to add custom fields to all watchers, while losing binary compatibility */ 88/* can be used to add custom fields to all watchers, while losing binary compatibility */
88#ifndef EV_COMMON 89#ifndef EV_COMMON
89# define EV_COMMON void *data; 90# define EV_COMMON void *data;
90#endif 91#endif
… …
124#define EV_WATCHER_TIME(type) \ 125#define EV_WATCHER_TIME(type) \
125 EV_WATCHER (type) \ 126 EV_WATCHER (type) \
126 ev_tstamp at; /* private */ 127 ev_tstamp at; /* private */
127 128
128/* base class, nothing to see here unless you subclass */ 129/* base class, nothing to see here unless you subclass */
129struct ev_watcher 130typedef struct ev_watcher
130{ 131{
131 EV_WATCHER (ev_watcher) 132 EV_WATCHER (ev_watcher)
132}; 133} ev_watcher;
133 134
134/* base class, nothing to see here unless you subclass */ 135/* base class, nothing to see here unless you subclass */
135struct ev_watcher_list 136typedef struct ev_watcher_list
136{ 137{
137 EV_WATCHER_LIST (ev_watcher_list) 138 EV_WATCHER_LIST (ev_watcher_list)
138}; 139} ev_watcher_list;
139 140
140/* base class, nothing to see here unless you subclass */ 141/* base class, nothing to see here unless you subclass */
141struct ev_watcher_time 142typedef struct ev_watcher_time
142{ 143{
143 EV_WATCHER_TIME (ev_watcher_time) 144 EV_WATCHER_TIME (ev_watcher_time)
144}; 145} ev_watcher_time;
145 146
146/* invoked after a specific time, repeatable (based on monotonic clock) */ 147/* invoked after a specific time, repeatable (based on monotonic clock) */
147/* revent EV_TIMEOUT */ 148/* revent EV_TIMEOUT */
148struct ev_timer 149typedef struct ev_timer
149{ 150{
150 EV_WATCHER_TIME (ev_timer) 151 EV_WATCHER_TIME (ev_timer)
151 152
152 ev_tstamp repeat; /* rw */ 153 ev_tstamp repeat; /* rw */
153}; 154} ev_timer;
154 155
155/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 156/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
156/* revent EV_PERIODIC */ 157/* revent EV_PERIODIC */
157struct ev_periodic 158typedef struct ev_periodic
158{ 159{
159 EV_WATCHER_TIME (ev_periodic) 160 EV_WATCHER_TIME (ev_periodic)
160 161
161 ev_tstamp interval; /* rw */ 162 ev_tstamp interval; /* rw */
162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 163 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
163}; 164} ev_periodic;
164 165
165/* invoked when fd is either EV_READable or EV_WRITEable */ 166/* invoked when fd is either EV_READable or EV_WRITEable */
166/* revent EV_READ, EV_WRITE */ 167/* revent EV_READ, EV_WRITE */
167struct ev_io 168typedef struct ev_io
168{ 169{
169 EV_WATCHER_LIST (ev_io) 170 EV_WATCHER_LIST (ev_io)
170 171
171 int fd; /* ro */ 172 int fd; /* ro */
172 int events; /* ro */ 173 int events; /* ro */
173}; 174} ev_io;
174 175
175/* invoked when the given signal has been received */ 176/* invoked when the given signal has been received */
176/* revent EV_SIGNAL */ 177/* revent EV_SIGNAL */
177struct ev_signal 178typedef struct ev_signal
178{ 179{
179 EV_WATCHER_LIST (ev_signal) 180 EV_WATCHER_LIST (ev_signal)
180 181
181 int signum; /* ro */ 182 int signum; /* ro */
182}; 183} ev_signal;
183 184
184/* invoked when the nothing else needs to be done, keeps the process from blocking */ 185/* invoked when the nothing else needs to be done, keeps the process from blocking */
185/* revent EV_IDLE */ 186/* revent EV_IDLE */
186struct ev_idle 187typedef struct ev_idle
187{ 188{
188 EV_WATCHER (ev_idle) 189 EV_WATCHER (ev_idle)
189}; 190} ev_idle;
190 191
191/* invoked for each run of the mainloop, just before the blocking call */ 192/* invoked for each run of the mainloop, just before the blocking call */
192/* you can still change events in any way you like */ 193/* you can still change events in any way you like */
193/* revent EV_PREPARE */ 194/* revent EV_PREPARE */
194struct ev_prepare 195typedef struct ev_prepare
195{ 196{
196 EV_WATCHER (ev_prepare) 197 EV_WATCHER (ev_prepare)
197}; 198} ev_prepare;
198 199
199/* invoked for each run of the mainloop, just after the blocking call */ 200/* invoked for each run of the mainloop, just after the blocking call */
200/* revent EV_CHECK */ 201/* revent EV_CHECK */
201struct ev_check 202typedef struct ev_check
202{ 203{
203 EV_WATCHER (ev_check) 204 EV_WATCHER (ev_check)
204}; 205} ev_check;
205 206
206/* invoked when sigchld is received and waitpid indicates the given pid */ 207/* invoked when sigchld is received and waitpid indicates the given pid */
207/* revent EV_CHILD */ 208/* revent EV_CHILD */
208/* does not support priorities */ 209/* does not support priorities */
209struct ev_child 210typedef struct ev_child
210{ 211{
211 EV_WATCHER_LIST (ev_child) 212 EV_WATCHER_LIST (ev_child)
212 213
213 int pid; /* ro */ 214 int pid; /* ro */
214 int rpid; /* rw, holds the received pid */ 215 int rpid; /* rw, holds the received pid */
215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
216}; 217} ev_child;
218
219#if EV_MULTIPLICITY
220/* used to embed an event loop inside another */
221/* the callback gets invoked when the event loop has handled events, and can be 0 */
222typedef struct ev_embed
223{
224 EV_WATCHER (ev_embed)
225
226 ev_io io; /* private */
227 struct ev_loop *loop; /* ro */
228} ev_embed;
229#endif
217 230
218/* the presence of this union forces similar struct layout */ 231/* the presence of this union forces similar struct layout */
219union ev_any_watcher 232union ev_any_watcher
220{ 233{
221 struct ev_watcher w; 234 struct ev_watcher w;
… …
227 struct ev_idle idle; 240 struct ev_idle idle;
228 struct ev_prepare prepare; 241 struct ev_prepare prepare;
229 struct ev_check check; 242 struct ev_check check;
230 struct ev_signal signal; 243 struct ev_signal signal;
231 struct ev_child child; 244 struct ev_child child;
245#if EV_MULTIPLICITY
246 struct ev_embed embed;
247#endif
232}; 248};
233 249
234/* bits for ev_default_loop and ev_loop_new */ 250/* bits for ev_default_loop and ev_loop_new */
235/* the default */ 251/* the default */
236#define EVFLAG_AUTO 0x00000000 /* not quite a mask */ 252#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
237 253/* flag bits */
254#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
238/* method bits to be ored together */ 255/* method bits to be ored together */
239#define EVMETHOD_SELECT 0x00000001 /* about anywhere */ 256#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
240#define EVMETHOD_POLL 0x00000002 /* !win */ 257#define EVBACKEND_POLL 0x00000002UL /* !win */
241#define EVMETHOD_EPOLL 0x00000004 /* linux */ 258#define EVBACKEND_EPOLL 0x00000004UL /* linux */
242#define EVMETHOD_KQUEUE 0x00000008 /* bsd */ 259#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
243#define EVMETHOD_DEVPOLL 0x00000010 /* solaris 8 */ /* NYI */ 260#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
244#define EVMETHOD_PORT 0x00000020 /* solaris 10 */ /* NYI */ 261#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
245
246/* flag bits */
247#define EVFLAG_NOENV 0x01000000 /* do NOT consult environment */
248 262
249#if EV_PROTOTYPES 263#if EV_PROTOTYPES
250int ev_version_major (void); 264int ev_version_major (void);
251int ev_version_minor (void); 265int ev_version_minor (void);
266
267unsigned int ev_supported_backends (void);
268unsigned int ev_recommended_backends (void);
269unsigned int ev_embeddable_backends (void);
252 270
253ev_tstamp ev_time (void); 271ev_tstamp ev_time (void);
254 272
255/* Sets the allocation function to use, works like realloc. 273/* Sets the allocation function to use, works like realloc.
256 * It is used to allocate and free memory. 274 * It is used to allocate and free memory.
… …
267void ev_set_syserr_cb (void (*cb)(const char *msg)); 285void ev_set_syserr_cb (void (*cb)(const char *msg));
268 286
269# if EV_MULTIPLICITY 287# if EV_MULTIPLICITY
270/* the default loop is the only one that handles signals and child watchers */ 288/* the default loop is the only one that handles signals and child watchers */
271/* you can call this as often as you like */ 289/* you can call this as often as you like */
272struct ev_loop *ev_default_loop (unsigned int flags); /* returns default loop */ 290static struct ev_loop *
291ev_default_loop (unsigned int flags)
292{
293 extern struct ev_loop *ev_default_loop_ptr;
294 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
295
296 if (!ev_default_loop_ptr)
297 ev_default_loop_init (flags);
298
299 return ev_default_loop_ptr;
300}
273 301
274/* create and destroy alternative loops that don't handle signals */ 302/* create and destroy alternative loops that don't handle signals */
275struct ev_loop *ev_loop_new (unsigned int flags); 303struct ev_loop *ev_loop_new (unsigned int flags);
276void ev_loop_destroy (EV_P); 304void ev_loop_destroy (EV_P);
277void ev_loop_fork (EV_P); 305void ev_loop_fork (EV_P);
… …
296/* if you create alternative loops you have to call ev_loop_fork on them */ 324/* if you create alternative loops you have to call ev_loop_fork on them */
297/* you can call it in either the parent or the child */ 325/* you can call it in either the parent or the child */
298/* you can actually call it at any time, anywhere :) */ 326/* you can actually call it at any time, anywhere :) */
299void ev_default_fork (void); 327void ev_default_fork (void);
300 328
301unsigned int ev_method (EV_P); 329unsigned int ev_backend (EV_P);
302#endif 330#endif
303 331
304#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 332#define EVLOOP_NONBLOCK 1 /* do not block/wait */
305#define EVLOOP_ONESHOT 2 /* block *once* only */ 333#define EVLOOP_ONESHOT 2 /* block *once* only */
334#define EVUNLOOP_CANCEL 0 /* undo unloop */
306#define EVUNLOOP_ONCE 1 /* unloop once */ 335#define EVUNLOOP_ONE 1 /* unloop once */
307#define EVUNLOOP_ALL 2 /* unloop all loops */ 336#define EVUNLOOP_ALL 2 /* unloop all loops */
308 337
309#if EV_PROTOTYPES 338#if EV_PROTOTYPES
310void ev_loop (EV_P_ int flags); 339void ev_loop (EV_P_ int flags);
311void 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 */ 340void 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 */
… …
324#endif 353#endif
325 354
326/* these may evaluate ev multiple times, and the other arguments at most once */ 355/* these may evaluate ev multiple times, and the other arguments at most once */
327/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 356/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
328#define ev_init(ev,cb_) do { \ 357#define ev_init(ev,cb_) do { \
329 ((struct ev_watcher *)(void *)(ev))->active = \ 358 ((ev_watcher *)(void *)(ev))->active = \
330 ((struct ev_watcher *)(void *)(ev))->pending = \ 359 ((ev_watcher *)(void *)(ev))->pending = \
331 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 360 ((ev_watcher *)(void *)(ev))->priority = 0; \
332 ev_set_cb ((ev), cb_); \ 361 ev_set_cb ((ev), cb_); \
333} while (0) 362} while (0)
334 363
335#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 364#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
336#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 365#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
… …
338#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 367#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
339#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 368#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
340#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 369#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
341#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 370#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
342#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 371#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
372#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
343 373
344#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 374#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
345#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 375#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
346#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 376#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
347#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 377#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
348#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 378#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
349#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 379#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
350#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 380#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
351#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 381#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
382#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
352 383
353#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 384#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
354#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 385#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
355 386
356#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 387#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */
357#define ev_cb(ev) (ev)->cb /* rw */ 388#define ev_cb(ev) (ev)->cb /* rw */
358#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 389#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
359 390
360#ifndef ev_set_cb 391#ifndef ev_set_cb
361# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 392# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
… …
369/* accepts any ev_watcher type */ 400/* accepts any ev_watcher type */
370void ev_feed_event (EV_P_ void *w, int revents); 401void ev_feed_event (EV_P_ void *w, int revents);
371void ev_feed_fd_event (EV_P_ int fd, int revents); 402void ev_feed_fd_event (EV_P_ int fd, int revents);
372void ev_feed_signal_event (EV_P_ int signum); 403void ev_feed_signal_event (EV_P_ int signum);
373 404
374void ev_io_start (EV_P_ struct ev_io *w); 405void ev_io_start (EV_P_ ev_io *w);
375void ev_io_stop (EV_P_ struct ev_io *w); 406void ev_io_stop (EV_P_ ev_io *w);
376 407
377void ev_timer_start (EV_P_ struct ev_timer *w); 408void ev_timer_start (EV_P_ ev_timer *w);
378void ev_timer_stop (EV_P_ struct ev_timer *w); 409void ev_timer_stop (EV_P_ ev_timer *w);
379/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 410/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
380void ev_timer_again (EV_P_ struct ev_timer *w); 411void ev_timer_again (EV_P_ ev_timer *w);
381 412
382#if EV_PERIODICS 413#if EV_PERIODICS
383void ev_periodic_start (EV_P_ struct ev_periodic *w); 414void ev_periodic_start (EV_P_ ev_periodic *w);
384void ev_periodic_stop (EV_P_ struct ev_periodic *w); 415void ev_periodic_stop (EV_P_ ev_periodic *w);
385void ev_periodic_again (EV_P_ struct ev_periodic *w); 416void ev_periodic_again (EV_P_ ev_periodic *w);
386#endif 417#endif
387 418
388void ev_idle_start (EV_P_ struct ev_idle *w); 419void ev_idle_start (EV_P_ ev_idle *w);
389void ev_idle_stop (EV_P_ struct ev_idle *w); 420void ev_idle_stop (EV_P_ ev_idle *w);
390 421
391void ev_prepare_start (EV_P_ struct ev_prepare *w); 422void ev_prepare_start (EV_P_ ev_prepare *w);
392void ev_prepare_stop (EV_P_ struct ev_prepare *w); 423void ev_prepare_stop (EV_P_ ev_prepare *w);
393 424
394void ev_check_start (EV_P_ struct ev_check *w); 425void ev_check_start (EV_P_ ev_check *w);
395void ev_check_stop (EV_P_ struct ev_check *w); 426void ev_check_stop (EV_P_ ev_check *w);
396 427
397/* only supported in the default loop */ 428/* only supported in the default loop */
398void ev_signal_start (EV_P_ struct ev_signal *w); 429void ev_signal_start (EV_P_ ev_signal *w);
399void ev_signal_stop (EV_P_ struct ev_signal *w); 430void ev_signal_stop (EV_P_ ev_signal *w);
400 431
401/* only supported in the default loop */ 432/* only supported in the default loop */
402void ev_child_start (EV_P_ struct ev_child *w); 433void ev_child_start (EV_P_ ev_child *w);
403void ev_child_stop (EV_P_ struct ev_child *w); 434void ev_child_stop (EV_P_ ev_child *w);
435
436# if EV_MULTIPLICITY
437/* only supported when loop to be embedded is in fact embeddable */
438void ev_embed_start (EV_P_ ev_embed *w);
439void ev_embed_stop (EV_P_ ev_embed *w);
440void ev_embed_sweep (EV_P_ ev_embed *w);
441# endif
442
404#endif 443#endif
405 444
406#ifdef __cplusplus 445#ifdef __cplusplus
407} 446}
408#endif 447#endif

Diff Legend

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