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

Comparing libev/ev.h (file contents):
Revision 1.132 by root, Wed Mar 10 08:19:39 2010 UTC vs.
Revision 1.141 by root, Thu Oct 21 12:32:47 2010 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010 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 *
… …
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
47typedef double ev_tstamp; 47/*****************************************************************************/
48 48
49#ifndef EV_FEATURES
50# define EV_FEATURES 0x7f
51#endif
52
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
55#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
56#define EV_FEATURE_API ((EV_FEATURES) & 8)
57#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
58#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
59#define EV_FEATURE_OS ((EV_FEATURES) & 64)
60
49/* these priorities are inclusive, higher priorities will be called earlier */ 61/* these priorities are inclusive, higher priorities will be invoked earlier */
50#ifndef EV_MINPRI 62#ifndef EV_MINPRI
51# define EV_MINPRI -2 63# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
52#endif 64#endif
53#ifndef EV_MAXPRI 65#ifndef EV_MAXPRI
54# define EV_MAXPRI +2 66# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
55#endif 67#endif
56 68
57#ifndef EV_MULTIPLICITY 69#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1 70# define EV_MULTIPLICITY EV_FEATURE_CONFIG
59#endif 71#endif
60 72
61#ifndef EV_PERIODIC_ENABLE 73#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1 74# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63#endif 75#endif
64 76
65#ifndef EV_STAT_ENABLE 77#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 78# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
79#endif
80
81#ifndef EV_PREPARE_ENABLE
82# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
83#endif
84
85#ifndef EV_CHECK_ENABLE
86# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
67#endif 87#endif
68 88
69#ifndef EV_IDLE_ENABLE 89#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 90# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71#endif 91#endif
72 92
73#ifndef EV_FORK_ENABLE 93#ifndef EV_FORK_ENABLE
74# define EV_FORK_ENABLE 1 94# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
75#endif 95#endif
76 96
77#ifndef EV_SIGNAL_ENABLE 97#ifndef EV_SIGNAL_ENABLE
78# define EV_SIGNAL_ENABLE 1 98# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
79#endif 99#endif
80 100
81#ifndef EV_CHILD_ENABLE 101#ifndef EV_CHILD_ENABLE
82# ifdef _WIN32 102# ifdef _WIN32
83# define EV_CHILD_ENABLE 0 103# define EV_CHILD_ENABLE 0
84# else 104# else
85# define EV_CHILD_ENABLE 1 105# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
86#endif 106#endif
87#endif 107#endif
88 108
89#ifndef EV_ASYNC_ENABLE 109#ifndef EV_ASYNC_ENABLE
90# define EV_ASYNC_ENABLE 1 110# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
91#endif 111#endif
92 112
93#ifndef EV_EMBED_ENABLE 113#ifndef EV_EMBED_ENABLE
94# define EV_EMBED_ENABLE 1 114# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
95#endif 115#endif
96 116
97#ifndef EV_WALK_ENABLE 117#ifndef EV_WALK_ENABLE
98# define EV_WALK_ENABLE 0 /* not yet */ 118# define EV_WALK_ENABLE 0 /* not yet */
99#endif 119#endif
120
121/*****************************************************************************/
122
123#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
124# undef EV_SIGNAL_ENABLE
125# define EV_SIGNAL_ENABLE 1
126#endif
127
128/*****************************************************************************/
129
130typedef double ev_tstamp;
100 131
101#ifndef EV_ATOMIC_T 132#ifndef EV_ATOMIC_T
102# include <signal.h> 133# include <signal.h>
103# define EV_ATOMIC_T sig_atomic_t volatile 134# define EV_ATOMIC_T sig_atomic_t volatile
104#endif
105
106/*****************************************************************************/
107
108#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
109# undef EV_SIGNAL_ENABLE
110# define EV_SIGNAL_ENABLE 1
111#endif 135#endif
112 136
113#if EV_STAT_ENABLE 137#if EV_STAT_ENABLE
114# ifdef _WIN32 138# ifdef _WIN32
115# include <time.h> 139# include <time.h>
… …
145# define EV_INLINE static inline 169# define EV_INLINE static inline
146#else 170#else
147# define EV_INLINE static 171# define EV_INLINE static
148#endif 172#endif
149 173
174#ifndef EV_PROTOTYPES
175# define EV_PROTOTYPES 1
176#endif
177
150/*****************************************************************************/ 178/*****************************************************************************/
151 179
180#define EV_VERSION_MAJOR 4
181#define EV_VERSION_MINOR 0
182
152/* eventmask, revents, events... */ 183/* eventmask, revents, events... */
184//TODO: enum?
153#define EV_UNDEF -1 /* guaranteed to be invalid */ 185#define EV_UNDEF -1 /* guaranteed to be invalid */
154#define EV_NONE 0x00 /* no events */ 186#define EV_NONE 0x00 /* no events */
155#define EV_READ 0x01 /* ev_io detected read will not block */ 187#define EV_READ 0x01 /* ev_io detected read will not block */
156#define EV_WRITE 0x02 /* ev_io detected write will not block */ 188#define EV_WRITE 0x02 /* ev_io detected write will not block */
157#define EV__IOFDSET 0x80 /* internal use only */ 189#define EV__IOFDSET 0x80 /* internal use only */
158#define EV_IO EV_READ /* alias for type-detection */ 190#define EV_IO EV_READ /* alias for type-detection */
159#define EV_TIMEOUT 0x00000100 /* timer timed out */ 191#define EV_TIMER 0x00000100 /* timer timed out */
160#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 192#define EV_TIMEOUT EV_TIMER /* pre 4.0 API compatibility */
161#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 193#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
162#define EV_SIGNAL 0x00000400 /* signal was received */ 194#define EV_SIGNAL 0x00000400 /* signal was received */
163#define EV_CHILD 0x00000800 /* child/pid had status change */ 195#define EV_CHILD 0x00000800 /* child/pid had status change */
164#define EV_STAT 0x00001000 /* stat data changed */ 196#define EV_STAT 0x00001000 /* stat data changed */
165#define EV_IDLE 0x00002000 /* event loop is idling */ 197#define EV_IDLE 0x00002000 /* event loop is idling */
… …
173 205
174/* can be used to add custom fields to all watchers, while losing binary compatibility */ 206/* can be used to add custom fields to all watchers, while losing binary compatibility */
175#ifndef EV_COMMON 207#ifndef EV_COMMON
176# define EV_COMMON void *data; 208# define EV_COMMON void *data;
177#endif 209#endif
178#ifndef EV_PROTOTYPES
179# define EV_PROTOTYPES 1
180#endif
181
182#define EV_VERSION_MAJOR 3
183#define EV_VERSION_MINOR 9
184 210
185#ifndef EV_CB_DECLARE 211#ifndef EV_CB_DECLARE
186# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 212# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
187#endif 213#endif
188#ifndef EV_CB_INVOKE 214#ifndef EV_CB_INVOKE
189# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 215# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
190#endif 216#endif
217
218/* not official, do not use */
219#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
191 220
192/* 221/*
193 * struct member types: 222 * struct member types:
194 * private: you may look at them, but not change them, 223 * private: you may look at them, but not change them,
195 * and they might not mean anything to you. 224 * and they might not mean anything to you.
… …
206 * or the array index + 1 in the pendings array. 235 * or the array index + 1 in the pendings array.
207 */ 236 */
208 237
209#if EV_MINPRI == EV_MAXPRI 238#if EV_MINPRI == EV_MAXPRI
210# define EV_DECL_PRIORITY 239# define EV_DECL_PRIORITY
211#else 240#elif !defined (EV_DECL_PRIORITY)
212# define EV_DECL_PRIORITY int priority; 241# define EV_DECL_PRIORITY int priority;
213#endif 242#endif
214 243
215/* shared by all watchers */ 244/* shared by all watchers */
216#define EV_WATCHER(type) \ 245#define EV_WATCHER(type) \
… …
413#if EV_ASYNC_ENABLE 442#if EV_ASYNC_ENABLE
414 struct ev_async async; 443 struct ev_async async;
415#endif 444#endif
416}; 445};
417 446
447//TODO: enum?
418/* bits for ev_default_loop and ev_loop_new */ 448/* bits for ev_default_loop and ev_loop_new */
419/* the default */ 449/* the default */
420#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 450#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
421/* flag bits */ 451/* flag bits */
422#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 452#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
423#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 453#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
424/* debugging/feature disable */ 454/* debugging/feature disable */
425#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 455#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
426#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ 456#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
427#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ 457#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
458//TODO: enum?
428/* method bits to be ored together */ 459/* method bits to be ored together */
429#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 460#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
430#define EVBACKEND_POLL 0x00000002U /* !win */ 461#define EVBACKEND_POLL 0x00000002U /* !win */
431#define EVBACKEND_EPOLL 0x00000004U /* linux */ 462#define EVBACKEND_EPOLL 0x00000004U /* linux */
432#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 463#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
… …
535void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 566void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
536#endif 567#endif
537 568
538#endif /* prototypes */ 569#endif /* prototypes */
539 570
571//TODO: enum?
540#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 572#define EVRUN_NOWAIT 1 /* do not block/wait */
541#define EVLOOP_ONESHOT 2 /* block *once* only */ 573#define EVRUN_ONCE 2 /* block *once* only */
574
542#define EVUNLOOP_CANCEL 0 /* undo unloop */ 575#define EVBREAK_CANCEL 0 /* undo unloop */
543#define EVUNLOOP_ONE 1 /* unloop once */ 576#define EVBREAK_ONE 1 /* unloop once */
544#define EVUNLOOP_ALL 2 /* unloop all loops */ 577#define EVBREAK_ALL 2 /* unloop all loops */
545 578
546#if EV_PROTOTYPES 579#if EV_PROTOTYPES
547void ev_loop (EV_P_ int flags); 580void ev_run (EV_P_ int flags);
548void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 581void ev_break (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
549 582
550/* 583/*
551 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 584 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
552 * keeps one reference. if you have a long-running watcher you never unregister that 585 * keeps one reference. if you have a long-running watcher you never unregister that
553 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 586 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
559 * convenience function, wait for a single event, without registering an event watcher 592 * convenience function, wait for a single event, without registering an event watcher
560 * if timeout is < 0, do wait indefinitely 593 * if timeout is < 0, do wait indefinitely
561 */ 594 */
562void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 595void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
563 596
564# if EV_MINIMAL < 2 597# if EV_FEATURE_API
565unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 598unsigned int ev_iteration (EV_P); /* number of loop iterations */
566unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 599unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
567void ev_loop_verify (EV_P); /* abort if loop data corrupted */ 600void ev_verify (EV_P); /* abort if loop data corrupted */
568 601
569void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 602void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
570void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 603void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
571 604
572/* advanced stuff for threading etc. support, see docs */ 605/* advanced stuff for threading etc. support, see docs */
… …
605#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 638#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
606#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 639#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
607#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 640#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
608#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 641#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
609#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 642#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
610#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 643#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
611 644
612#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 645#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
613#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 646#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
614#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 647#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
615#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 648#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
692# if EV_IDLE_ENABLE 725# if EV_IDLE_ENABLE
693void ev_idle_start (EV_P_ ev_idle *w); 726void ev_idle_start (EV_P_ ev_idle *w);
694void ev_idle_stop (EV_P_ ev_idle *w); 727void ev_idle_stop (EV_P_ ev_idle *w);
695# endif 728# endif
696 729
730#if EV_PREPARE_ENABLE
697void ev_prepare_start (EV_P_ ev_prepare *w); 731void ev_prepare_start (EV_P_ ev_prepare *w);
698void ev_prepare_stop (EV_P_ ev_prepare *w); 732void ev_prepare_stop (EV_P_ ev_prepare *w);
733#endif
699 734
735#if EV_CHECK_ENABLE
700void ev_check_start (EV_P_ ev_check *w); 736void ev_check_start (EV_P_ ev_check *w);
701void ev_check_stop (EV_P_ ev_check *w); 737void ev_check_stop (EV_P_ ev_check *w);
738#endif
702 739
703# if EV_FORK_ENABLE 740# if EV_FORK_ENABLE
704void ev_fork_start (EV_P_ ev_fork *w); 741void ev_fork_start (EV_P_ ev_fork *w);
705void ev_fork_stop (EV_P_ ev_fork *w); 742void ev_fork_stop (EV_P_ ev_fork *w);
706# endif 743# endif
… …
716void ev_async_start (EV_P_ ev_async *w); 753void ev_async_start (EV_P_ ev_async *w);
717void ev_async_stop (EV_P_ ev_async *w); 754void ev_async_stop (EV_P_ ev_async *w);
718void ev_async_send (EV_P_ ev_async *w); 755void ev_async_send (EV_P_ ev_async *w);
719# endif 756# endif
720 757
758/* pre-4.0 compatibility */
759#ifndef EV_COMPAT3
760# define EV_COMPAT3 1
761#endif
762
763#if EV_COMPAT3
764 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
765 #define EVLOOP_ONESHOT EVRUN_ONCE
766 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
767 #define EVUNLOOP_ONE EVBREAK_ONE
768 #define EVUNLOOP_ALL EVBREAK_ALL
769 #if EV_PROTOTYPES
770 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
771 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
772 #if EV_FEATURE_API
773 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
774 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
775 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
776 #endif
777 #endif
778#else
779 typedef struct ev_loop ev_loop;
780#endif
781
721#endif 782#endif
722 783
723#ifdef __cplusplus 784#ifdef __cplusplus
724} 785}
725#endif 786#endif

Diff Legend

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