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

Comparing libev/ev.h (file contents):
Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC vs.
Revision 1.158 by root, Tue Jan 11 13:45:28 2011 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011 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 *
… …
101 101
102#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
104#endif 104#endif
105 105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
108#endif
109
106#ifndef EV_SIGNAL_ENABLE 110#ifndef EV_SIGNAL_ENABLE
107# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
108#endif 112#endif
109 113
110#ifndef EV_CHILD_ENABLE 114#ifndef EV_CHILD_ENABLE
… …
187#endif 191#endif
188 192
189/*****************************************************************************/ 193/*****************************************************************************/
190 194
191#define EV_VERSION_MAJOR 4 195#define EV_VERSION_MAJOR 4
192#define EV_VERSION_MINOR 0 196#define EV_VERSION_MINOR 3
193 197
194/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
195enum { 199enum {
196 EV_UNDEF = -1, /* guaranteed to be invalid */ 200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
197 EV_NONE = 0x00, /* no events */ 201 EV_NONE = 0x00, /* no events */
198 EV_READ = 0x01, /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
199 EV_WRITE = 0x02, /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
200 EV__IOFDSET = 0x80, /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
201 EV_IO = EV_READ, /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
… …
210 EV_IDLE = 0x00002000, /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
211 EV_PREPARE = 0x00004000, /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
212 EV_CHECK = 0x00008000, /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
213 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
214 EV_FORK = 0x00020000, /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
215 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
216 EV_CUSTOM = 0x01000000, /* for use by user code */ 221 EV_CUSTOM = 0x01000000, /* for use by user code */
217 EV_ERROR = 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
218}; 223};
219 224
220/* can be used to add custom fields to all watchers, while losing binary compatibility */ 225/* can be used to add custom fields to all watchers, while losing binary compatibility */
… …
389 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
390} ev_check; 395} ev_check;
391 396
392#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
393/* the callback gets invoked before check in the child process when a fork was detected */ 398/* the callback gets invoked before check in the child process when a fork was detected */
399/* revent EV_FORK */
394typedef struct ev_fork 400typedef struct ev_fork
395{ 401{
396 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
397} ev_fork; 403} ev_fork;
404#endif
405
406#if EV_CLEANUP_ENABLE
407/* is invoked just before the loop gets destroyed */
408/* revent EV_CLEANUP */
409typedef struct ev_cleanup
410{
411 EV_WATCHER (ev_cleanup)
412} ev_cleanup;
398#endif 413#endif
399 414
400#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
401/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
402/* the callback gets invoked when the event loop has handled events, and can be 0 */ 417/* the callback gets invoked when the event loop has handled events, and can be 0 */
… …
410 ev_check check; /* unused */ 425 ev_check check; /* unused */
411 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
412 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
413 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
414 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */
432#endif
415} ev_embed; 433} ev_embed;
416#endif 434#endif
417 435
418#if EV_ASYNC_ENABLE 436#if EV_ASYNC_ENABLE
419/* invoked when somebody calls ev_async_send on the watcher */ 437/* invoked when somebody calls ev_async_send on the watcher */
… …
447#endif 465#endif
448 struct ev_prepare prepare; 466 struct ev_prepare prepare;
449 struct ev_check check; 467 struct ev_check check;
450#if EV_FORK_ENABLE 468#if EV_FORK_ENABLE
451 struct ev_fork fork; 469 struct ev_fork fork;
470#endif
471#if EV_CLEANUP_ENABLE
472 struct ev_cleanup cleanup;
452#endif 473#endif
453#if EV_EMBED_ENABLE 474#if EV_EMBED_ENABLE
454 struct ev_embed embed; 475 struct ev_embed embed;
455#endif 476#endif
456#if EV_ASYNC_ENABLE 477#if EV_ASYNC_ENABLE
… …
468 /* debugging/feature disable */ 489 /* debugging/feature disable */
469 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 490 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
470#if EV_COMPAT3 491#if EV_COMPAT3
471 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 492 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
472#endif 493#endif
473 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ 494 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
495 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
474}; 496};
475 497
476/* method bits to be ored together */ 498/* method bits to be ored together */
477enum { 499enum {
478 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 500 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
479 EVBACKEND_POLL = 0x00000002U, /* !win */ 501 EVBACKEND_POLL = 0x00000002U, /* !win */
480 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 502 EVBACKEND_EPOLL = 0x00000004U, /* linux */
481 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 503 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
482 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 504 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
483 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 505 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
484 EVBACKEND_ALL = 0x0000003FU 506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
485}; 508};
486 509
487#if EV_PROTOTYPES 510#if EV_PROTOTYPES
488int ev_version_major (void); 511int ev_version_major (void);
489int ev_version_minor (void); 512int ev_version_minor (void);
… …
529 return EV_A == EV_DEFAULT_UC; 552 return EV_A == EV_DEFAULT_UC;
530} 553}
531 554
532/* create and destroy alternative loops that don't handle signals */ 555/* create and destroy alternative loops that don't handle signals */
533struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); 556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
534/* destroy event loops, also works for the default loop */
535void ev_loop_destroy (EV_P);
536 557
537ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 558ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
538 559
539#else 560#else
540 561
… …
554{ 575{
555 return 1; 576 return 1;
556} 577}
557 578
558#endif /* multiplicity */ 579#endif /* multiplicity */
580
581/* destroy event loops, also works for the default loop */
582void ev_loop_destroy (EV_P);
559 583
560/* this needs to be called after fork, to duplicate the loop */ 584/* this needs to be called after fork, to duplicate the loop */
561/* when you want to re-use it in the child */ 585/* when you want to re-use it in the child */
562/* you can call it in either the parent or the child */ 586/* you can call it in either the parent or the child */
563/* you can actually call it at any time, anywhere :) */ 587/* you can actually call it at any time, anywhere :) */
… …
651#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 675#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
652#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 676#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
653#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 677#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
654#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 678#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
655#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 679#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
680#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
656#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ 681#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
657 682
658#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 683#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
659#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 684#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
660#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 685#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
… …
664#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 689#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
665#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 690#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
666#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 691#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
667#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 692#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
668#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 693#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
694#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
669#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 695#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
670 696
671#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 697#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
672#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 698#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
673 699
… …
694/* feeds an event into a watcher as if the event actually occured */ 720/* feeds an event into a watcher as if the event actually occured */
695/* accepts any ev_watcher type */ 721/* accepts any ev_watcher type */
696void ev_feed_event (EV_P_ void *w, int revents); 722void ev_feed_event (EV_P_ void *w, int revents);
697void ev_feed_fd_event (EV_P_ int fd, int revents); 723void ev_feed_fd_event (EV_P_ int fd, int revents);
698#if EV_SIGNAL_ENABLE 724#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum);
699void ev_feed_signal_event (EV_P_ int signum); 726void ev_feed_signal_event (EV_P_ int signum);
700#endif 727#endif
701void ev_invoke (EV_P_ void *w, int revents); 728void ev_invoke (EV_P_ void *w, int revents);
702int ev_clear_pending (EV_P_ void *w); 729int ev_clear_pending (EV_P_ void *w);
703 730
… …
751#endif 778#endif
752 779
753# if EV_FORK_ENABLE 780# if EV_FORK_ENABLE
754void ev_fork_start (EV_P_ ev_fork *w); 781void ev_fork_start (EV_P_ ev_fork *w);
755void ev_fork_stop (EV_P_ ev_fork *w); 782void ev_fork_stop (EV_P_ ev_fork *w);
783# endif
784
785# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w);
756# endif 788# endif
757 789
758# if EV_EMBED_ENABLE 790# if EV_EMBED_ENABLE
759/* only supported when loop to be embedded is in fact embeddable */ 791/* only supported when loop to be embedded is in fact embeddable */
760void ev_embed_start (EV_P_ ev_embed *w); 792void ev_embed_start (EV_P_ ev_embed *w);
… …
778 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 810 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
779 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 811 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
780 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); } 812 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
781 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); } 813 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
782 #if EV_FEATURE_API 814 #if EV_FEATURE_API
783 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 815 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
784 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 816 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
785 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 817 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
786 #endif 818 #endif
787 #endif 819 #endif
788#else 820#else
789 typedef struct ev_loop ev_loop; 821 typedef struct ev_loop ev_loop;
790#endif 822#endif

Diff Legend

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