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.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
161# 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))
162#endif 166#endif
163 167
164/* 168/*
165 * struct member types: 169 * struct member types:
166 * 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.
167 * 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.
168 * 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.
169 */ 183 */
170 184
171/* shared by all watchers */ 185/* shared by all watchers */
172#define EV_WATCHER(type) \ 186#define EV_WATCHER(type) \
173 int active; /* private */ \ 187 int active; /* private */ \
322 ev_prepare prepare; /* private */ 336 ev_prepare prepare; /* private */
323 ev_check check; /* unused */ 337 ev_check check; /* unused */
324 ev_timer timer; /* unused */ 338 ev_timer timer; /* unused */
325 ev_periodic periodic; /* unused */ 339 ev_periodic periodic; /* unused */
326 ev_idle idle; /* unused */ 340 ev_idle idle; /* unused */
327 ev_fork fork; /* unused */ 341 ev_fork fork; /* private */
328} ev_embed; 342} ev_embed;
329#endif 343#endif
330 344
331#if EV_ASYNC_ENABLE 345#if EV_ASYNC_ENABLE
332/* invoked when somebody calls ev_async_send on the watcher */ 346/* invoked when somebody calls ev_async_send on the watcher */
408 * retryable syscall error 422 * retryable syscall error
409 * (such as failed select, poll, epoll_wait) 423 * (such as failed select, poll, epoll_wait)
410 */ 424 */
411void ev_set_syserr_cb (void (*cb)(const char *msg)); 425void ev_set_syserr_cb (void (*cb)(const char *msg));
412 426
413# if EV_MULTIPLICITY 427#if EV_MULTIPLICITY
414EV_INLINE struct ev_loop * 428EV_INLINE struct ev_loop *
415ev_default_loop_uc (void) 429ev_default_loop_uc (void)
416{ 430{
417 extern struct ev_loop *ev_default_loop_ptr; 431 extern struct ev_loop *ev_default_loop_ptr;
418 432
438 452
439/* create and destroy alternative loops that don't handle signals */ 453/* create and destroy alternative loops that don't handle signals */
440struct ev_loop *ev_loop_new (unsigned int flags); 454struct ev_loop *ev_loop_new (unsigned int flags);
441void ev_loop_destroy (EV_P); 455void ev_loop_destroy (EV_P);
442void ev_loop_fork (EV_P); 456void ev_loop_fork (EV_P);
457void ev_loop_verify (EV_P);
443 458
444ev_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);
445 461
446# else 462#else
447 463
448int ev_default_loop (unsigned int flags); /* returns true when successful */ 464int ev_default_loop (unsigned int flags); /* returns true when successful */
449 465
450EV_INLINE ev_tstamp 466EV_INLINE ev_tstamp
451ev_now (void) 467ev_now (void)
452{ 468{
453 extern ev_tstamp ev_rt_now; 469 extern ev_tstamp ev_rt_now;
454 470
455 return ev_rt_now; 471 return ev_rt_now;
456} 472}
457# endif 473#endif /* multiplicity */
458 474
459EV_INLINE int 475EV_INLINE int
460ev_is_default_loop (EV_P) 476ev_is_default_loop (EV_P)
461{ 477{
462#if EV_MULTIPLICITY 478#if EV_MULTIPLICITY
475/* you can actually call it at any time, anywhere :) */ 491/* you can actually call it at any time, anywhere :) */
476void ev_default_fork (void); 492void ev_default_fork (void);
477 493
478unsigned int ev_backend (EV_P); /* backend in use by loop */ 494unsigned int ev_backend (EV_P); /* backend in use by loop */
479unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 495unsigned int ev_loop_count (EV_P); /* number of loop iterations */
480#endif 496#endif /* prototypes */
481 497
482#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 498#define EVLOOP_NONBLOCK 1 /* do not block/wait */
483#define EVLOOP_ONESHOT 2 /* block *once* only */ 499#define EVLOOP_ONESHOT 2 /* block *once* only */
484#define EVUNLOOP_CANCEL 0 /* undo unloop */ 500#define EVUNLOOP_CANCEL 0 /* undo unloop */
485#define EVUNLOOP_ONE 1 /* unloop once */ 501#define EVUNLOOP_ONE 1 /* unloop once */
498 * 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.
499 */ 515 */
500void ev_ref (EV_P); 516void ev_ref (EV_P);
501void ev_unref (EV_P); 517void ev_unref (EV_P);
502 518
503/* 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 */
504/* if timeout is < 0, do wait indefinitely */ 520/* 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); 521void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
506#endif 522#endif
507 523
508/* 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 */
512 ((ev_watcher *)(void *)(ev))->pending = \ 528 ((ev_watcher *)(void *)(ev))->pending = \
513 ((ev_watcher *)(void *)(ev))->priority = 0; \ 529 ((ev_watcher *)(void *)(ev))->priority = 0; \
514 ev_set_cb ((ev), cb_); \ 530 ev_set_cb ((ev), cb_); \
515} while (0) 531} while (0)
516 532
517#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)
518#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)
519#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)
520#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)
521#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)
522#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)
523#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 */
524#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 */
525#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 */
526#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)
527#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 */
528#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 544#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
529 545
530#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)
531#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)
532#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)
533#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)
534#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)
535#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)
536#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)
537#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)
538#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)
539#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)
540#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)
541#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)
542 558
543#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 */
544#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 */
545 561
546#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 562#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
547#define ev_cb(ev) (ev)->cb /* rw */ 563#define ev_cb(ev) (ev)->cb /* rw */
548#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.)
549 567
550#ifndef ev_set_cb 568#ifndef ev_set_cb
551# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 569# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
552#endif 570#endif
553 571
554/* 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 */
555/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 573/* stopping (disabling, deleting) a watcher does nothing unless its already running */
556#if EV_PROTOTYPES 574#if EV_PROTOTYPES

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines