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.111 by root, Mon Mar 16 21:15:06 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
… …
127/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
128#define EV_UNDEF -1 /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
129#define EV_NONE 0x00 /* no events */ 133#define EV_NONE 0x00 /* no events */
130#define EV_READ 0x01 /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
131#define EV_WRITE 0x02 /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
132#define EV_IOFDSET 0x80 /* internal use only */ 136#define EV__IOFDSET 0x80 /* internal use only */
137#define EV_IO EV_READ /* alias for type-detection */
133#define EV_TIMEOUT 0x00000100 /* timer timed out */ 138#define EV_TIMEOUT 0x00000100 /* timer timed out */
134#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 139#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
135#define EV_SIGNAL 0x00000400 /* signal was received */ 140#define EV_SIGNAL 0x00000400 /* signal was received */
136#define EV_CHILD 0x00000800 /* child/pid had status change */ 141#define EV_CHILD 0x00000800 /* child/pid had status change */
137#define EV_STAT 0x00001000 /* stat data changed */ 142#define EV_STAT 0x00001000 /* stat data changed */
… …
161# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 166# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
162#endif 167#endif
163 168
164/* 169/*
165 * struct member types: 170 * struct member types:
166 * private: you can look at them, but not change them, and they might not mean anything to you. 171 * private: you may look at them, but not change them,
172 * and they might not mean anything to you.
167 * ro: can be read anytime, but only changed when the watcher isn't active 173 * 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 174 * rw: can be read and modified anytime, even when the watcher is active.
175 *
176 * some internal details that might be helpful for debugging:
177 *
178 * active is either 0, which means the watcher is not active,
179 * or the array index of the watcher (periodics, timers)
180 * or the array index + 1 (most other watchers)
181 * or simply 1 for watchers that aren't in some array.
182 * pending is either 0, in which case the watcher isn't,
183 * or the array index + 1 in the pendings array.
169 */ 184 */
170 185
171/* shared by all watchers */ 186/* shared by all watchers */
172#define EV_WATCHER(type) \ 187#define EV_WATCHER(type) \
173 int active; /* private */ \ 188 int active; /* private */ \
… …
322 ev_prepare prepare; /* private */ 337 ev_prepare prepare; /* private */
323 ev_check check; /* unused */ 338 ev_check check; /* unused */
324 ev_timer timer; /* unused */ 339 ev_timer timer; /* unused */
325 ev_periodic periodic; /* unused */ 340 ev_periodic periodic; /* unused */
326 ev_idle idle; /* unused */ 341 ev_idle idle; /* unused */
327 ev_fork fork; /* unused */ 342 ev_fork fork; /* private */
328} ev_embed; 343} ev_embed;
329#endif 344#endif
330 345
331#if EV_ASYNC_ENABLE 346#if EV_ASYNC_ENABLE
332/* invoked when somebody calls ev_async_send on the watcher */ 347/* invoked when somebody calls ev_async_send on the watcher */
… …
408 * retryable syscall error 423 * retryable syscall error
409 * (such as failed select, poll, epoll_wait) 424 * (such as failed select, poll, epoll_wait)
410 */ 425 */
411void ev_set_syserr_cb (void (*cb)(const char *msg)); 426void ev_set_syserr_cb (void (*cb)(const char *msg));
412 427
413# if EV_MULTIPLICITY 428#if EV_MULTIPLICITY
414EV_INLINE struct ev_loop * 429EV_INLINE struct ev_loop *
415ev_default_loop_uc (void) 430ev_default_loop_uc (void)
416{ 431{
417 extern struct ev_loop *ev_default_loop_ptr; 432 extern struct ev_loop *ev_default_loop_ptr;
418 433
… …
438 453
439/* create and destroy alternative loops that don't handle signals */ 454/* create and destroy alternative loops that don't handle signals */
440struct ev_loop *ev_loop_new (unsigned int flags); 455struct ev_loop *ev_loop_new (unsigned int flags);
441void ev_loop_destroy (EV_P); 456void ev_loop_destroy (EV_P);
442void ev_loop_fork (EV_P); 457void ev_loop_fork (EV_P);
458void ev_loop_verify (EV_P);
443 459
444ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 460ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
461void ev_now_update (EV_P);
445 462
446# else 463#else
447 464
448int ev_default_loop (unsigned int flags); /* returns true when successful */ 465int ev_default_loop (unsigned int flags); /* returns true when successful */
449 466
450EV_INLINE ev_tstamp 467EV_INLINE ev_tstamp
451ev_now (void) 468ev_now (void)
452{ 469{
453 extern ev_tstamp ev_rt_now; 470 extern ev_tstamp ev_rt_now;
454 471
455 return ev_rt_now; 472 return ev_rt_now;
456} 473}
457# endif 474#endif /* multiplicity */
458 475
459EV_INLINE int 476EV_INLINE int
460ev_is_default_loop (EV_P) 477ev_is_default_loop (EV_P)
461{ 478{
462#if EV_MULTIPLICITY 479#if EV_MULTIPLICITY
… …
475/* you can actually call it at any time, anywhere :) */ 492/* you can actually call it at any time, anywhere :) */
476void ev_default_fork (void); 493void ev_default_fork (void);
477 494
478unsigned int ev_backend (EV_P); /* backend in use by loop */ 495unsigned int ev_backend (EV_P); /* backend in use by loop */
479unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 496unsigned int ev_loop_count (EV_P); /* number of loop iterations */
480#endif 497#endif /* prototypes */
481 498
482#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 499#define EVLOOP_NONBLOCK 1 /* do not block/wait */
483#define EVLOOP_ONESHOT 2 /* block *once* only */ 500#define EVLOOP_ONESHOT 2 /* block *once* only */
484#define EVUNLOOP_CANCEL 0 /* undo unloop */ 501#define EVUNLOOP_CANCEL 0 /* undo unloop */
485#define EVUNLOOP_ONE 1 /* unloop once */ 502#define EVUNLOOP_ONE 1 /* unloop once */
… …
498 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 515 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
499 */ 516 */
500void ev_ref (EV_P); 517void ev_ref (EV_P);
501void ev_unref (EV_P); 518void ev_unref (EV_P);
502 519
503/* convinience function, wait for a single event, without registering an event watcher */ 520/* convenience function, wait for a single event, without registering an event watcher */
504/* if timeout is < 0, do wait indefinitely */ 521/* if timeout is < 0, do wait indefinitely */
505void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 522void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
506#endif 523#endif
507 524
508/* these may evaluate ev multiple times, and the other arguments at most once */ 525/* these may evaluate ev multiple times, and the other arguments at most once */
… …
512 ((ev_watcher *)(void *)(ev))->pending = \ 529 ((ev_watcher *)(void *)(ev))->pending = \
513 ((ev_watcher *)(void *)(ev))->priority = 0; \ 530 ((ev_watcher *)(void *)(ev))->priority = 0; \
514 ev_set_cb ((ev), cb_); \ 531 ev_set_cb ((ev), cb_); \
515} while (0) 532} while (0)
516 533
517#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 534#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) 535#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) 536#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) 537#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) 538#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) 539#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 */ 540#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 */ 541#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 */ 542#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) 543#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 */ 544#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) 545#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
529 546
530#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 547#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) 548#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) 549#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) 550#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) 551#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) 552#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) 553#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) 554#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) 555#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) 556#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) 557#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) 558#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
542 559
543#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 560#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 */ 561#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
545 562
546#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 563#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
547#define ev_cb(ev) (ev)->cb /* rw */ 564#define ev_cb(ev) (ev)->cb /* rw */
548#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 565#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
566
567#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
549 568
550#ifndef ev_set_cb 569#ifndef ev_set_cb
551# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 570# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
552#endif 571#endif
553 572
554/* stopping (enabling, adding) a watcher does nothing if it is already running */ 573/* stopping (enabling, adding) a watcher does nothing if it is already running */
555/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 574/* stopping (disabling, deleting) a watcher does nothing unless its already running */
556#if EV_PROTOTYPES 575#if EV_PROTOTYPES

Diff Legend

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