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

Comparing libev/ev.h (file contents):
Revision 1.91 by root, Fri Jan 25 15:45:09 2008 UTC vs.
Revision 1.105 by root, Mon Sep 8 17:24:39 2008 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008 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 *
… …
76 76
77#ifndef EV_EMBED_ENABLE 77#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
79#endif 79#endif
80 80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
88#endif
89
81/*****************************************************************************/ 90/*****************************************************************************/
82 91
83#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
84# include <sys/stat.h> 97# include <sys/stat.h>
85#endif 98#endif
86 99
87/* support multiple event loops? */ 100/* support multiple event loops? */
88#if EV_MULTIPLICITY 101#if EV_MULTIPLICITY
89struct ev_loop; 102struct ev_loop;
90# define EV_P struct ev_loop *loop 103# define EV_P struct ev_loop *loop
91# define EV_P_ EV_P, 104# define EV_P_ EV_P,
92# define EV_A loop 105# define EV_A loop
93# 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,
94# define EV_DEFAULT ev_default_loop (0) 109# define EV_DEFAULT ev_default_loop (0)
95# define EV_DEFAULT_ EV_DEFAULT, 110# define EV_DEFAULT_ EV_DEFAULT,
96#else 111#else
97# define EV_P void 112# define EV_P void
98# define EV_P_ 113# define EV_P_
99# define EV_A 114# define EV_A
100# define EV_A_ 115# define EV_A_
101# define EV_DEFAULT 116# define EV_DEFAULT
102# define EV_DEFAULT_ 117# define EV_DEFAULT_
103 118# define EV_DEFAULT_UC
119# define EV_DEFAULT_UC_
104# undef EV_EMBED_ENABLE 120# undef EV_EMBED_ENABLE
105#endif 121#endif
106 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
107/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
108#define EV_UNDEF -1L /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
109#define EV_NONE 0x00L /* no events */ 133#define EV_NONE 0x00 /* no events */
110#define EV_READ 0x01L /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
111#define EV_WRITE 0x02L /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
112#define EV_IOFDSET 0x80L /* internal use only */ 136#define EV_IOFDSET 0x80 /* internal use only */
113#define EV_TIMEOUT 0x00000100L /* timer timed out */ 137#define EV_TIMEOUT 0x00000100 /* timer timed out */
114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 138#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
115#define EV_SIGNAL 0x00000400L /* signal was received */ 139#define EV_SIGNAL 0x00000400 /* signal was received */
116#define EV_CHILD 0x00000800L /* child/pid had status change */ 140#define EV_CHILD 0x00000800 /* child/pid had status change */
117#define EV_STAT 0x00001000L /* stat data changed */ 141#define EV_STAT 0x00001000 /* stat data changed */
118#define EV_IDLE 0x00002000L /* event loop is idling */ 142#define EV_IDLE 0x00002000 /* event loop is idling */
119#define EV_PREPARE 0x00004000L /* event loop about to poll */ 143#define EV_PREPARE 0x00004000 /* event loop about to poll */
120#define EV_CHECK 0x00008000L /* event loop finished poll */ 144#define EV_CHECK 0x00008000 /* event loop finished poll */
121#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 145#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
122#define EV_FORK 0x00020000L /* event loop resumed in child */ 146#define EV_FORK 0x00020000 /* event loop resumed in child */
147#define EV_ASYNC 0x00040000 /* async intra-loop signal */
123#define EV_ERROR 0x80000000L /* sent when an error occurs */ 148#define EV_ERROR 0x80000000 /* sent when an error occurs */
124 149
125/* 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 */
126#ifndef EV_COMMON 151#ifndef EV_COMMON
127# define EV_COMMON void *data; 152# define EV_COMMON void *data;
128#endif 153#endif
… …
143/* 168/*
144 * struct member types: 169 * struct member types:
145 * private: you can look at them, but not change them, and they might not mean anything to you. 170 * private: you can look at them, but not change them, and they might not mean anything to you.
146 * ro: can be read anytime, but only changed when the watcher isn't active 171 * ro: can be read anytime, but only changed when the watcher isn't active
147 * rw: can be read and modified anytime, even when the watcher is active 172 * rw: can be read and modified anytime, even when the watcher is active
173 *
174 * some internal details that might be helpful for debugging:
175 *
176 * active is either 0, which means the watcher is not active,
177 * or the array index of the watcher (periodics, timers)
178 * or the array index + 1 (most other watchers)
179 * or simply 1 for watchers that aren't in some array.
180 * pending is either 0, in which case the watcher isn't,
181 * or the array index + 1 in the pendings array.
148 */ 182 */
149 183
150/* shared by all watchers */ 184/* shared by all watchers */
151#define EV_WATCHER(type) \ 185#define EV_WATCHER(type) \
152 int active; /* private */ \ 186 int active; /* private */ \
… …
305 ev_idle idle; /* unused */ 339 ev_idle idle; /* unused */
306 ev_fork fork; /* unused */ 340 ev_fork fork; /* unused */
307} ev_embed; 341} ev_embed;
308#endif 342#endif
309 343
344#if EV_ASYNC_ENABLE
345/* invoked when somebody calls ev_async_send on the watcher */
346/* revent EV_ASYNC */
347typedef struct ev_async
348{
349 EV_WATCHER (ev_async)
350
351 EV_ATOMIC_T sent; /* private */
352} ev_async;
353
354# define ev_async_pending(w) ((w)->sent + 0)
355#endif
356
310/* the presence of this union forces similar struct layout */ 357/* the presence of this union forces similar struct layout */
311union ev_any_watcher 358union ev_any_watcher
312{ 359{
313 struct ev_watcher w; 360 struct ev_watcher w;
314 struct ev_watcher_list wl; 361 struct ev_watcher_list wl;
… …
330 struct ev_fork fork; 377 struct ev_fork fork;
331#endif 378#endif
332#if EV_EMBED_ENABLE 379#if EV_EMBED_ENABLE
333 struct ev_embed embed; 380 struct ev_embed embed;
334#endif 381#endif
382#if EV_ASYNC_ENABLE
383 struct ev_async async;
384#endif
335}; 385};
336 386
337/* bits for ev_default_loop and ev_loop_new */ 387/* bits for ev_default_loop and ev_loop_new */
338/* the default */ 388/* the default */
339#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 389#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
340/* flag bits */ 390/* flag bits */
341#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 391#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
342#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */ 392#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
343/* method bits to be ored together */ 393/* method bits to be ored together */
344#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 394#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
345#define EVBACKEND_POLL 0x00000002UL /* !win */ 395#define EVBACKEND_POLL 0x00000002U /* !win */
346#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 396#define EVBACKEND_EPOLL 0x00000004U /* linux */
347#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 397#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
348#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 398#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
349#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 399#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
350 400
351#if EV_PROTOTYPES 401#if EV_PROTOTYPES
352int ev_version_major (void); 402int ev_version_major (void);
353int ev_version_minor (void); 403int ev_version_minor (void);
354 404
… …
371 * retryable syscall error 421 * retryable syscall error
372 * (such as failed select, poll, epoll_wait) 422 * (such as failed select, poll, epoll_wait)
373 */ 423 */
374void ev_set_syserr_cb (void (*cb)(const char *msg)); 424void ev_set_syserr_cb (void (*cb)(const char *msg));
375 425
376# if EV_MULTIPLICITY 426#if EV_MULTIPLICITY
427EV_INLINE struct ev_loop *
428ev_default_loop_uc (void)
429{
430 extern struct ev_loop *ev_default_loop_ptr;
431
432 return ev_default_loop_ptr;
433}
434
377/* the default loop is the only one that handles signals and child watchers */ 435/* the default loop is the only one that handles signals and child watchers */
378/* you can call this as often as you like */ 436/* you can call this as often as you like */
379static struct ev_loop * 437EV_INLINE struct ev_loop *
380ev_default_loop (unsigned int flags) 438ev_default_loop (unsigned int flags)
381{ 439{
382 extern struct ev_loop *ev_default_loop_ptr; 440 struct ev_loop *loop = ev_default_loop_uc ();
441
442 if (!loop)
443 {
383 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 444 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
384 445
385 if (!ev_default_loop_ptr)
386 ev_default_loop_init (flags); 446 loop = ev_default_loop_init (flags);
447 }
387 448
388 return ev_default_loop_ptr; 449 return loop;
389} 450}
390 451
391/* create and destroy alternative loops that don't handle signals */ 452/* create and destroy alternative loops that don't handle signals */
392struct ev_loop *ev_loop_new (unsigned int flags); 453struct ev_loop *ev_loop_new (unsigned int flags);
393void ev_loop_destroy (EV_P); 454void ev_loop_destroy (EV_P);
394void ev_loop_fork (EV_P); 455void ev_loop_fork (EV_P);
456void ev_loop_verify (EV_P);
395 457
396ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 458ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
459void ev_now_update (EV_P);
397 460
398# else 461#else
399 462
400int ev_default_loop (unsigned int flags); /* returns true when successful */ 463int ev_default_loop (unsigned int flags); /* returns true when successful */
401 464
402static ev_tstamp 465EV_INLINE ev_tstamp
403ev_now (void) 466ev_now (void)
404{ 467{
405 extern ev_tstamp ev_rt_now; 468 extern ev_tstamp ev_rt_now;
406 469
407 return ev_rt_now; 470 return ev_rt_now;
408} 471}
472#endif /* multiplicity */
473
474EV_INLINE int
475ev_is_default_loop (EV_P)
476{
477#if EV_MULTIPLICITY
478 extern struct ev_loop *ev_default_loop_ptr;
479
480 return !!(EV_A == ev_default_loop_ptr);
481#else
482 return 1;
409# endif 483#endif
484}
410 485
411void ev_default_destroy (void); /* destroy the default loop */ 486void ev_default_destroy (void); /* destroy the default loop */
412/* this needs to be called after fork, to duplicate the default loop */ 487/* this needs to be called after fork, to duplicate the default loop */
413/* if you create alternative loops you have to call ev_loop_fork on them */ 488/* if you create alternative loops you have to call ev_loop_fork on them */
414/* you can call it in either the parent or the child */ 489/* you can call it in either the parent or the child */
415/* you can actually call it at any time, anywhere :) */ 490/* you can actually call it at any time, anywhere :) */
416void ev_default_fork (void); 491void ev_default_fork (void);
417 492
418unsigned int ev_backend (EV_P); /* backend in use by loop */ 493unsigned int ev_backend (EV_P); /* backend in use by loop */
419unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 494unsigned int ev_loop_count (EV_P); /* number of loop iterations */
420#endif 495#endif /* prototypes */
421 496
422#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 497#define EVLOOP_NONBLOCK 1 /* do not block/wait */
423#define EVLOOP_ONESHOT 2 /* block *once* only */ 498#define EVLOOP_ONESHOT 2 /* block *once* only */
424#define EVUNLOOP_CANCEL 0 /* undo unloop */ 499#define EVUNLOOP_CANCEL 0 /* undo unloop */
425#define EVUNLOOP_ONE 1 /* unloop once */ 500#define EVUNLOOP_ONE 1 /* unloop once */
… …
453 ((ev_watcher *)(void *)(ev))->priority = 0; \ 528 ((ev_watcher *)(void *)(ev))->priority = 0; \
454 ev_set_cb ((ev), cb_); \ 529 ev_set_cb ((ev), cb_); \
455} while (0) 530} while (0)
456 531
457#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 532#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
458#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 533#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
459#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 534#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
460#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 535#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
461#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 536#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
462#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 537#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
463#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 538#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
464#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 539#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
465#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 540#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
466#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 541#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
467#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 542#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
543#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
468 544
469#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 545#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
470#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 546#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
471#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 547#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
472#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 548#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
475#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 551#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
476#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 552#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
477#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 553#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
478#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 554#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
479#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 555#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
556#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
480 557
481#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 558#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
482#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 559#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
483 560
484#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 561#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
485#define ev_cb(ev) (ev)->cb /* rw */ 562#define ev_cb(ev) (ev)->cb /* rw */
486#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 563#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
564
565#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
487 566
488#ifndef ev_set_cb 567#ifndef ev_set_cb
489# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 568# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
490#endif 569#endif
491 570
… …
550void ev_embed_start (EV_P_ ev_embed *w); 629void ev_embed_start (EV_P_ ev_embed *w);
551void ev_embed_stop (EV_P_ ev_embed *w); 630void ev_embed_stop (EV_P_ ev_embed *w);
552void ev_embed_sweep (EV_P_ ev_embed *w); 631void ev_embed_sweep (EV_P_ ev_embed *w);
553# endif 632# endif
554 633
634# if EV_ASYNC_ENABLE
635void ev_async_start (EV_P_ ev_async *w);
636void ev_async_stop (EV_P_ ev_async *w);
637void ev_async_send (EV_P_ ev_async *w);
638# endif
639
555#endif 640#endif
556 641
557#ifdef __cplusplus 642#ifdef __cplusplus
558} 643}
559#endif 644#endif

Diff Legend

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