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

Comparing libev/ev.h (file contents):
Revision 1.99 by root, Wed Apr 16 01:37:14 2008 UTC vs.
Revision 1.118 by root, Thu Jul 9 09:11:20 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 *
… …
80 80
81#ifndef EV_ASYNC_ENABLE 81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1 82# define EV_ASYNC_ENABLE 1
83#endif 83#endif
84 84
85#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */
87#endif
88
85#ifndef EV_ATOMIC_T 89#ifndef EV_ATOMIC_T
86# include <signal.h> 90# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile 91# define EV_ATOMIC_T sig_atomic_t volatile
88#endif 92#endif
89 93
90/*****************************************************************************/ 94/*****************************************************************************/
91 95
92#if EV_STAT_ENABLE 96#if EV_STAT_ENABLE
97# ifdef _WIN32
98# include <time.h>
99# include <sys/types.h>
100# endif
93# include <sys/stat.h> 101# include <sys/stat.h>
94#endif 102#endif
95 103
96/* support multiple event loops? */ 104/* support multiple event loops? */
97#if EV_MULTIPLICITY 105#if EV_MULTIPLICITY
… …
127/* eventmask, revents, events... */ 135/* eventmask, revents, events... */
128#define EV_UNDEF -1 /* guaranteed to be invalid */ 136#define EV_UNDEF -1 /* guaranteed to be invalid */
129#define EV_NONE 0x00 /* no events */ 137#define EV_NONE 0x00 /* no events */
130#define EV_READ 0x01 /* ev_io detected read will not block */ 138#define EV_READ 0x01 /* ev_io detected read will not block */
131#define EV_WRITE 0x02 /* ev_io detected write will not block */ 139#define EV_WRITE 0x02 /* ev_io detected write will not block */
132#define EV_IOFDSET 0x80 /* internal use only */ 140#define EV__IOFDSET 0x80 /* internal use only */
141#define EV_IO EV_READ /* alias for type-detection */
133#define EV_TIMEOUT 0x00000100 /* timer timed out */ 142#define EV_TIMEOUT 0x00000100 /* timer timed out */
143#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
134#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 144#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
135#define EV_SIGNAL 0x00000400 /* signal was received */ 145#define EV_SIGNAL 0x00000400 /* signal was received */
136#define EV_CHILD 0x00000800 /* child/pid had status change */ 146#define EV_CHILD 0x00000800 /* child/pid had status change */
137#define EV_STAT 0x00001000 /* stat data changed */ 147#define EV_STAT 0x00001000 /* stat data changed */
138#define EV_IDLE 0x00002000 /* event loop is idling */ 148#define EV_IDLE 0x00002000 /* event loop is idling */
139#define EV_PREPARE 0x00004000 /* event loop about to poll */ 149#define EV_PREPARE 0x00004000 /* event loop about to poll */
140#define EV_CHECK 0x00008000 /* event loop finished poll */ 150#define EV_CHECK 0x00008000 /* event loop finished poll */
141#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 151#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
142#define EV_FORK 0x00020000 /* event loop resumed in child */ 152#define EV_FORK 0x00020000 /* event loop resumed in child */
143#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 153#define EV_ASYNC 0x00040000 /* async intra-loop signal */
154#define EV_CUSTOM 0x01000000 /* for use by user code */
144#define EV_ERROR 0x80000000 /* sent when an error occurs */ 155#define EV_ERROR 0x80000000 /* sent when an error occurs */
145 156
146/* can be used to add custom fields to all watchers, while losing binary compatibility */ 157/* can be used to add custom fields to all watchers, while losing binary compatibility */
147#ifndef EV_COMMON 158#ifndef EV_COMMON
148# define EV_COMMON void *data; 159# define EV_COMMON void *data;
… …
161# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 172# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
162#endif 173#endif
163 174
164/* 175/*
165 * struct member types: 176 * struct member types:
166 * private: you can look at them, but not change them, and they might not mean anything to you. 177 * private: you may look at them, but not change them,
178 * and they might not mean anything to you.
167 * ro: can be read anytime, but only changed when the watcher isn't active 179 * ro: can be read anytime, but only changed when the watcher isn't active.
168 * rw: can be read and modified anytime, even when the watcher is active 180 * rw: can be read and modified anytime, even when the watcher is active.
181 *
182 * some internal details that might be helpful for debugging:
183 *
184 * active is either 0, which means the watcher is not active,
185 * or the array index of the watcher (periodics, timers)
186 * or the array index + 1 (most other watchers)
187 * or simply 1 for watchers that aren't in some array.
188 * pending is either 0, in which case the watcher isn't,
189 * or the array index + 1 in the pendings array.
169 */ 190 */
191
192#if EV_MINPRI == EV_MAXPRI
193# define EV_DECL_PRIORITY
194#else
195# define EV_DECL_PRIORITY int priority;
196#endif
170 197
171/* shared by all watchers */ 198/* shared by all watchers */
172#define EV_WATCHER(type) \ 199#define EV_WATCHER(type) \
173 int active; /* private */ \ 200 int active; /* private */ \
174 int pending; /* private */ \ 201 int pending; /* private */ \
175 int priority; /* private */ \ 202 EV_DECL_PRIORITY /* private */ \
176 EV_COMMON /* rw */ \ 203 EV_COMMON /* rw */ \
177 EV_CB_DECLARE (type) /* private */ 204 EV_CB_DECLARE (type) /* private */
178 205
179#define EV_WATCHER_LIST(type) \ 206#define EV_WATCHER_LIST(type) \
180 EV_WATCHER (type) \ 207 EV_WATCHER (type) \
… …
322 ev_prepare prepare; /* private */ 349 ev_prepare prepare; /* private */
323 ev_check check; /* unused */ 350 ev_check check; /* unused */
324 ev_timer timer; /* unused */ 351 ev_timer timer; /* unused */
325 ev_periodic periodic; /* unused */ 352 ev_periodic periodic; /* unused */
326 ev_idle idle; /* unused */ 353 ev_idle idle; /* unused */
327 ev_fork fork; /* unused */ 354 ev_fork fork; /* private */
328} ev_embed; 355} ev_embed;
329#endif 356#endif
330 357
331#if EV_ASYNC_ENABLE 358#if EV_ASYNC_ENABLE
332/* invoked when somebody calls ev_async_send on the watcher */ 359/* invoked when somebody calls ev_async_send on the watcher */
… …
408 * retryable syscall error 435 * retryable syscall error
409 * (such as failed select, poll, epoll_wait) 436 * (such as failed select, poll, epoll_wait)
410 */ 437 */
411void ev_set_syserr_cb (void (*cb)(const char *msg)); 438void ev_set_syserr_cb (void (*cb)(const char *msg));
412 439
413# if EV_MULTIPLICITY 440#if EV_MULTIPLICITY
414EV_INLINE struct ev_loop * 441EV_INLINE struct ev_loop *
415ev_default_loop_uc (void) 442ev_default_loop_uc (void)
416{ 443{
417 extern struct ev_loop *ev_default_loop_ptr; 444 extern struct ev_loop *ev_default_loop_ptr;
418 445
… …
441void ev_loop_destroy (EV_P); 468void ev_loop_destroy (EV_P);
442void ev_loop_fork (EV_P); 469void ev_loop_fork (EV_P);
443 470
444ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 471ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
445 472
446# else 473#else
447 474
448int ev_default_loop (unsigned int flags); /* returns true when successful */ 475int ev_default_loop (unsigned int flags); /* returns true when successful */
449 476
450EV_INLINE ev_tstamp 477EV_INLINE ev_tstamp
451ev_now (void) 478ev_now (void)
452{ 479{
453 extern ev_tstamp ev_rt_now; 480 extern ev_tstamp ev_rt_now;
454 481
455 return ev_rt_now; 482 return ev_rt_now;
456} 483}
457# endif 484#endif /* multiplicity */
458 485
459EV_INLINE int 486EV_INLINE int
460ev_is_default_loop (EV_P) 487ev_is_default_loop (EV_P)
461{ 488{
462#if EV_MULTIPLICITY 489#if EV_MULTIPLICITY
… …
473/* if you create alternative loops you have to call ev_loop_fork on them */ 500/* if you create alternative loops you have to call ev_loop_fork on them */
474/* you can call it in either the parent or the child */ 501/* you can call it in either the parent or the child */
475/* you can actually call it at any time, anywhere :) */ 502/* you can actually call it at any time, anywhere :) */
476void ev_default_fork (void); 503void ev_default_fork (void);
477 504
478unsigned int ev_backend (EV_P); /* backend in use by loop */ 505unsigned int ev_backend (EV_P); /* backend in use by loop */
479unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 506unsigned int ev_loop_count (EV_P); /* number of loop iterations */
507unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
508void ev_loop_verify (EV_P); /* abort if loop data corrupted */
509
510void ev_now_update (EV_P); /* update event loop time */
511void ev_invoke_pending (EV_P); /* invoke all pending watchers */
512
513#if EV_WALK_ENABLE
514/* walk (almost) all watchers in the loop of a given type, invoking the */
515/* callback on every such watcher. The callback might stop the watcher, */
516/* but do nothing else with the loop */
517void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
480#endif 518#endif
519
520#endif /* prototypes */
481 521
482#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 522#define EVLOOP_NONBLOCK 1 /* do not block/wait */
483#define EVLOOP_ONESHOT 2 /* block *once* only */ 523#define EVLOOP_ONESHOT 2 /* block *once* only */
484#define EVUNLOOP_CANCEL 0 /* undo unloop */ 524#define EVUNLOOP_CANCEL 0 /* undo unloop */
485#define EVUNLOOP_ONE 1 /* unloop once */ 525#define EVUNLOOP_ONE 1 /* unloop once */
… …
498 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 538 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
499 */ 539 */
500void ev_ref (EV_P); 540void ev_ref (EV_P);
501void ev_unref (EV_P); 541void ev_unref (EV_P);
502 542
543/*
544 * stop/start the timer handling.
545 */
546void ev_suspend (EV_P);
547void ev_resume (EV_P);
548
549/*
503/* convinience function, wait for a single event, without registering an event watcher */ 550 * convenience function, wait for a single event, without registering an event watcher
504/* if timeout is < 0, do wait indefinitely */ 551 * if timeout is < 0, do wait indefinitely
552 */
505void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 553void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
506#endif 554#endif
507 555
508/* these may evaluate ev multiple times, and the other arguments at most once */ 556/* these may evaluate ev multiple times, and the other arguments at most once */
509/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 557/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
510#define ev_init(ev,cb_) do { \ 558#define ev_init(ev,cb_) do { \
511 ((ev_watcher *)(void *)(ev))->active = \ 559 ((ev_watcher *)(void *)(ev))->active = \
512 ((ev_watcher *)(void *)(ev))->pending = \ 560 ((ev_watcher *)(void *)(ev))->pending = 0; \
513 ((ev_watcher *)(void *)(ev))->priority = 0; \ 561 ev_set_priority ((ev), 0); \
514 ev_set_cb ((ev), cb_); \ 562 ev_set_cb ((ev), cb_); \
515} while (0) 563} while (0)
516 564
517#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 565#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
518#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 566#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
519#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 567#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
520#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 568#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
521#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 569#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
522#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 570#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
523#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 571#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
524#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 572#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
525#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 573#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
526#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 574#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
527#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 575#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
528#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 576#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
529 577
530#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 578#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
531#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 579#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
532#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 580#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
533#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 581#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
534#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) 582#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
535#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 583#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
536#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 584#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
537#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 585#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
538#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 586#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
539#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 587#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
540#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 588#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
541#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 589#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
542 590
543#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 591#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
544#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 592#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
545 593
594#define ev_cb(ev) (ev)->cb /* rw */
595
596#if EV_MINPRI == EV_MAXPRI
597# define ev_priority(ev) ((ev), EV_MINPRI)
598# define ev_set_priority(ev,pri) ((ev), (pri))
599#else
546#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 600# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
547#define ev_cb(ev) (ev)->cb /* rw */
548#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 601# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
602#endif
603
604#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
549 605
550#ifndef ev_set_cb 606#ifndef ev_set_cb
551# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 607# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
552#endif 608#endif
553 609
554/* stopping (enabling, adding) a watcher does nothing if it is already running */ 610/* stopping (enabling, adding) a watcher does nothing if it is already running */
555/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 611/* stopping (disabling, deleting) a watcher does nothing unless its already running */
556#if EV_PROTOTYPES 612#if EV_PROTOTYPES

Diff Legend

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