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

Comparing libev/ev.h (file contents):
Revision 1.93 by root, Fri Feb 1 13:08:54 2008 UTC vs.
Revision 1.110 by root, Wed Mar 4 14:33:10 2009 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
… …
88#endif 88#endif
89 89
90/*****************************************************************************/ 90/*****************************************************************************/
91 91
92#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
93# include <sys/stat.h> 97# include <sys/stat.h>
94#endif 98#endif
95 99
96/* support multiple event loops? */ 100/* support multiple event loops? */
97#if EV_MULTIPLICITY 101#if EV_MULTIPLICITY
98struct ev_loop; 102struct ev_loop;
99# define EV_P struct ev_loop *loop 103# define EV_P struct ev_loop *loop
100# define EV_P_ EV_P, 104# define EV_P_ EV_P,
101# define EV_A loop 105# define EV_A loop
102# define EV_A_ EV_A, 106# define EV_A_ EV_A,
107# define EV_DEFAULT_UC ev_default_loop_uc ()
108# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
103# define EV_DEFAULT ev_default_loop (0) 109# define EV_DEFAULT ev_default_loop (0)
104# define EV_DEFAULT_ EV_DEFAULT, 110# define EV_DEFAULT_ EV_DEFAULT,
105#else 111#else
106# define EV_P void 112# define EV_P void
107# define EV_P_ 113# define EV_P_
108# define EV_A 114# define EV_A
109# define EV_A_ 115# define EV_A_
110# define EV_DEFAULT 116# define EV_DEFAULT
111# define EV_DEFAULT_ 117# define EV_DEFAULT_
112 118# define EV_DEFAULT_UC
119# define EV_DEFAULT_UC_
113# undef EV_EMBED_ENABLE 120# undef EV_EMBED_ENABLE
114#endif 121#endif
115 122
123#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
124# define EV_INLINE static inline
125#else
126# define EV_INLINE static
127#endif
128
129/*****************************************************************************/
130
116/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
117#define EV_UNDEF -1L /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
118#define EV_NONE 0x00L /* no events */ 133#define EV_NONE 0x00 /* no events */
119#define EV_READ 0x01L /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
120#define EV_WRITE 0x02L /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
121#define EV_IOFDSET 0x80L /* internal use only */ 136#define EV_IOFDSET 0x80 /* internal use only */
122#define EV_TIMEOUT 0x00000100L /* timer timed out */ 137#define EV_TIMEOUT 0x00000100 /* timer timed out */
123#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 138#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
124#define EV_SIGNAL 0x00000400L /* signal was received */ 139#define EV_SIGNAL 0x00000400 /* signal was received */
125#define EV_CHILD 0x00000800L /* child/pid had status change */ 140#define EV_CHILD 0x00000800 /* child/pid had status change */
126#define EV_STAT 0x00001000L /* stat data changed */ 141#define EV_STAT 0x00001000 /* stat data changed */
127#define EV_IDLE 0x00002000L /* event loop is idling */ 142#define EV_IDLE 0x00002000 /* event loop is idling */
128#define EV_PREPARE 0x00004000L /* event loop about to poll */ 143#define EV_PREPARE 0x00004000 /* event loop about to poll */
129#define EV_CHECK 0x00008000L /* event loop finished poll */ 144#define EV_CHECK 0x00008000 /* event loop finished poll */
130#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 145#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
131#define EV_FORK 0x00020000L /* event loop resumed in child */ 146#define EV_FORK 0x00020000 /* event loop resumed in child */
132#define EV_ASYNC 0x00040000L /* async intra-loop signal */ 147#define EV_ASYNC 0x00040000 /* async intra-loop signal */
133#define EV_ERROR 0x80000000L /* sent when an error occurs */ 148#define EV_ERROR 0x80000000 /* sent when an error occurs */
134 149
135/* can be used to add custom fields to all watchers, while losing binary compatibility */ 150/* can be used to add custom fields to all watchers, while losing binary compatibility */
136#ifndef EV_COMMON 151#ifndef EV_COMMON
137# define EV_COMMON void *data; 152# define EV_COMMON void *data;
138#endif 153#endif
… …
150# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 165# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
151#endif 166#endif
152 167
153/* 168/*
154 * struct member types: 169 * struct member types:
155 * private: you can look at them, but not change them, and they might not mean anything to you. 170 * private: you may look at them, but not change them,
171 * and they might not mean anything to you.
156 * ro: can be read anytime, but only changed when the watcher isn't active 172 * ro: can be read anytime, but only changed when the watcher isn't active.
157 * rw: can be read and modified anytime, even when the watcher is active 173 * rw: can be read and modified anytime, even when the watcher is active.
174 *
175 * some internal details that might be helpful for debugging:
176 *
177 * active is either 0, which means the watcher is not active,
178 * or the array index of the watcher (periodics, timers)
179 * or the array index + 1 (most other watchers)
180 * or simply 1 for watchers that aren't in some array.
181 * pending is either 0, in which case the watcher isn't,
182 * or the array index + 1 in the pendings array.
158 */ 183 */
159 184
160/* shared by all watchers */ 185/* shared by all watchers */
161#define EV_WATCHER(type) \ 186#define EV_WATCHER(type) \
162 int active; /* private */ \ 187 int active; /* private */ \
… …
311 ev_prepare prepare; /* private */ 336 ev_prepare prepare; /* private */
312 ev_check check; /* unused */ 337 ev_check check; /* unused */
313 ev_timer timer; /* unused */ 338 ev_timer timer; /* unused */
314 ev_periodic periodic; /* unused */ 339 ev_periodic periodic; /* unused */
315 ev_idle idle; /* unused */ 340 ev_idle idle; /* unused */
316 ev_fork fork; /* unused */ 341 ev_fork fork; /* private */
317} ev_embed; 342} ev_embed;
318#endif 343#endif
319 344
320#if EV_ASYNC_ENABLE 345#if EV_ASYNC_ENABLE
321/* invoked when somebody calls ev_async_send on the watcher */ 346/* invoked when somebody calls ev_async_send on the watcher */
… …
324{ 349{
325 EV_WATCHER (ev_async) 350 EV_WATCHER (ev_async)
326 351
327 EV_ATOMIC_T sent; /* private */ 352 EV_ATOMIC_T sent; /* private */
328} ev_async; 353} ev_async;
354
355# define ev_async_pending(w) ((w)->sent + 0)
329#endif 356#endif
330 357
331/* the presence of this union forces similar struct layout */ 358/* the presence of this union forces similar struct layout */
332union ev_any_watcher 359union ev_any_watcher
333{ 360{
… …
351 struct ev_fork fork; 378 struct ev_fork fork;
352#endif 379#endif
353#if EV_EMBED_ENABLE 380#if EV_EMBED_ENABLE
354 struct ev_embed embed; 381 struct ev_embed embed;
355#endif 382#endif
356#if EV_ASYND_ENABLE 383#if EV_ASYNC_ENABLE
357 struct ev_async async; 384 struct ev_async async;
358#endif 385#endif
359}; 386};
360 387
361/* bits for ev_default_loop and ev_loop_new */ 388/* bits for ev_default_loop and ev_loop_new */
362/* the default */ 389/* the default */
363#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 390#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
364/* flag bits */ 391/* flag bits */
365#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 392#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
366#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */ 393#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
367/* method bits to be ored together */ 394/* method bits to be ored together */
368#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 395#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
369#define EVBACKEND_POLL 0x00000002UL /* !win */ 396#define EVBACKEND_POLL 0x00000002U /* !win */
370#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 397#define EVBACKEND_EPOLL 0x00000004U /* linux */
371#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 398#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
372#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 399#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
373#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 400#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
374 401
375#if EV_PROTOTYPES 402#if EV_PROTOTYPES
376int ev_version_major (void); 403int ev_version_major (void);
377int ev_version_minor (void); 404int ev_version_minor (void);
378 405
… …
395 * retryable syscall error 422 * retryable syscall error
396 * (such as failed select, poll, epoll_wait) 423 * (such as failed select, poll, epoll_wait)
397 */ 424 */
398void ev_set_syserr_cb (void (*cb)(const char *msg)); 425void ev_set_syserr_cb (void (*cb)(const char *msg));
399 426
400# if EV_MULTIPLICITY 427#if EV_MULTIPLICITY
428EV_INLINE struct ev_loop *
429ev_default_loop_uc (void)
430{
431 extern struct ev_loop *ev_default_loop_ptr;
432
433 return ev_default_loop_ptr;
434}
435
401/* the default loop is the only one that handles signals and child watchers */ 436/* the default loop is the only one that handles signals and child watchers */
402/* you can call this as often as you like */ 437/* you can call this as often as you like */
403static struct ev_loop * 438EV_INLINE struct ev_loop *
404ev_default_loop (unsigned int flags) 439ev_default_loop (unsigned int flags)
405{ 440{
406 extern struct ev_loop *ev_default_loop_ptr; 441 struct ev_loop *loop = ev_default_loop_uc ();
442
443 if (!loop)
444 {
407 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 445 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
408 446
409 if (!ev_default_loop_ptr)
410 ev_default_loop_init (flags); 447 loop = ev_default_loop_init (flags);
448 }
411 449
412 return ev_default_loop_ptr; 450 return loop;
413} 451}
414 452
415/* create and destroy alternative loops that don't handle signals */ 453/* create and destroy alternative loops that don't handle signals */
416struct ev_loop *ev_loop_new (unsigned int flags); 454struct ev_loop *ev_loop_new (unsigned int flags);
417void ev_loop_destroy (EV_P); 455void ev_loop_destroy (EV_P);
418void ev_loop_fork (EV_P); 456void ev_loop_fork (EV_P);
457void ev_loop_verify (EV_P);
419 458
420ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 459ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
460void ev_now_update (EV_P);
421 461
422# else 462#else
423 463
424int ev_default_loop (unsigned int flags); /* returns true when successful */ 464int ev_default_loop (unsigned int flags); /* returns true when successful */
425 465
426static ev_tstamp 466EV_INLINE ev_tstamp
427ev_now (void) 467ev_now (void)
428{ 468{
429 extern ev_tstamp ev_rt_now; 469 extern ev_tstamp ev_rt_now;
430 470
431 return ev_rt_now; 471 return ev_rt_now;
432} 472}
473#endif /* multiplicity */
474
475EV_INLINE int
476ev_is_default_loop (EV_P)
477{
478#if EV_MULTIPLICITY
479 extern struct ev_loop *ev_default_loop_ptr;
480
481 return !!(EV_A == ev_default_loop_ptr);
482#else
483 return 1;
433# endif 484#endif
485}
434 486
435void ev_default_destroy (void); /* destroy the default loop */ 487void ev_default_destroy (void); /* destroy the default loop */
436/* this needs to be called after fork, to duplicate the default loop */ 488/* this needs to be called after fork, to duplicate the default loop */
437/* if you create alternative loops you have to call ev_loop_fork on them */ 489/* if you create alternative loops you have to call ev_loop_fork on them */
438/* you can call it in either the parent or the child */ 490/* you can call it in either the parent or the child */
439/* you can actually call it at any time, anywhere :) */ 491/* you can actually call it at any time, anywhere :) */
440void ev_default_fork (void); 492void ev_default_fork (void);
441 493
442unsigned int ev_backend (EV_P); /* backend in use by loop */ 494unsigned int ev_backend (EV_P); /* backend in use by loop */
443unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 495unsigned int ev_loop_count (EV_P); /* number of loop iterations */
444#endif 496#endif /* prototypes */
445 497
446#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 498#define EVLOOP_NONBLOCK 1 /* do not block/wait */
447#define EVLOOP_ONESHOT 2 /* block *once* only */ 499#define EVLOOP_ONESHOT 2 /* block *once* only */
448#define EVUNLOOP_CANCEL 0 /* undo unloop */ 500#define EVUNLOOP_CANCEL 0 /* undo unloop */
449#define EVUNLOOP_ONE 1 /* unloop once */ 501#define EVUNLOOP_ONE 1 /* unloop once */
… …
462 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 514 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
463 */ 515 */
464void ev_ref (EV_P); 516void ev_ref (EV_P);
465void ev_unref (EV_P); 517void ev_unref (EV_P);
466 518
467/* convinience function, wait for a single event, without registering an event watcher */ 519/* convenience function, wait for a single event, without registering an event watcher */
468/* if timeout is < 0, do wait indefinitely */ 520/* if timeout is < 0, do wait indefinitely */
469void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 521void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
470#endif 522#endif
471 523
472/* these may evaluate ev multiple times, and the other arguments at most once */ 524/* these may evaluate ev multiple times, and the other arguments at most once */
… …
476 ((ev_watcher *)(void *)(ev))->pending = \ 528 ((ev_watcher *)(void *)(ev))->pending = \
477 ((ev_watcher *)(void *)(ev))->priority = 0; \ 529 ((ev_watcher *)(void *)(ev))->priority = 0; \
478 ev_set_cb ((ev), cb_); \ 530 ev_set_cb ((ev), cb_); \
479} while (0) 531} while (0)
480 532
481#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 533#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
482#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 534#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
483#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 535#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
484#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 536#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
485#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 537#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
486#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 538#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
487#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 539#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
488#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 540#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
489#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 541#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
490#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 542#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
491#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 543#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
492#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 544#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
493 545
494#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 546#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
495#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 547#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
496#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 548#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
497#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 549#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
498#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) 550#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
499#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 551#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
500#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 552#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
501#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 553#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
502#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 554#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
503#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 555#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
504#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 556#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
505#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 557#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
506 558
507#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 559#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
508#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 560#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
509 561
510#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 562#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
511#define ev_cb(ev) (ev)->cb /* rw */ 563#define ev_cb(ev) (ev)->cb /* rw */
512#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 564#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
565
566#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
513 567
514#ifndef ev_set_cb 568#ifndef ev_set_cb
515# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 569# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
516#endif 570#endif
517 571
518/* stopping (enabling, adding) a watcher does nothing if it is already running */ 572/* stopping (enabling, adding) a watcher does nothing if it is already running */
519/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 573/* stopping (disabling, deleting) a watcher does nothing unless its already running */
520#if EV_PROTOTYPES 574#if EV_PROTOTYPES

Diff Legend

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