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

Comparing libev/ev.h (file contents):
Revision 1.45 by root, Fri Nov 9 21:48:23 2007 UTC vs.
Revision 1.56 by root, Mon Nov 12 07:58:13 2007 UTC

… …
46 46
47#ifndef EV_MULTIPLICITY 47#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1 48# define EV_MULTIPLICITY 1
49#endif 49#endif
50 50
51#ifndef EV_PERIODICS
52# define EV_PERIODICS 1
53#endif
54
51/* support multiple event loops? */ 55/* support multiple event loops? */
52#if EV_MULTIPLICITY 56#if EV_MULTIPLICITY
53struct ev_loop; 57struct ev_loop;
54# define EV_P struct ev_loop *loop 58# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P, 59# define EV_P_ EV_P,
56# define EV_A loop 60# define EV_A loop
57# define EV_A_ EV_A, 61# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A,
58#else 64#else
59# define EV_P void 65# define EV_P void
60# define EV_P_ 66# define EV_P_
61# define EV_A 67# define EV_A
62# define EV_A_ 68# define EV_A_
69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_
63#endif 71#endif
64 72
65/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
66#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1 /* guaranteed to be invalid */
67#define EV_NONE 0x00 75#define EV_NONE 0x00
68#define EV_READ 0x01 76#define EV_READ 0x01 /* io only */
69#define EV_WRITE 0x02 77#define EV_WRITE 0x02 /* io only */
70#define EV_TIMEOUT 0x000100 78#define EV_TIMEOUT 0x000100 /* timer only */
71#define EV_PERIODIC 0x000200 79#define EV_PERIODIC 0x000200 /* periodic timer only */
72#define EV_SIGNAL 0x000400 80#define EV_SIGNAL 0x000400 /* signal only */
73#define EV_IDLE 0x000800 81#define EV_IDLE 0x000800 /* idle only */
74#define EV_CHECK 0x001000 82#define EV_CHECK 0x001000 /* check only */
75#define EV_PREPARE 0x002000 83#define EV_PREPARE 0x002000 /* prepare only */
76#define EV_CHILD 0x004000 84#define EV_CHILD 0x004000 /* child/pid only */
77#define EV_ERROR 0x800000 /* sent when an error occurs */ 85#define EV_ERROR 0x800000 /* sent when an error occurs */
78 86
79/* can be used to add custom fields to all watchers */ 87/* can be used to add custom fields to all watchers, while losing binary compatibility */
80#ifndef EV_COMMON 88#ifndef EV_COMMON
81# define EV_COMMON void *data 89# define EV_COMMON void *data;
82#endif 90#endif
83#ifndef EV_PROTOTYPES 91#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1 92# define EV_PROTOTYPES 1
85#endif 93#endif
86 94
87#define EV_VERSION_MAJOR 1 95#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1 96#define EV_VERSION_MINOR 1
89 97
90#ifndef EV_CB_DECLARE 98#ifndef EV_CB_DECLARE
91# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents) 99# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
92#endif 100#endif
93#ifndef EV_CB_INVOKE 101#ifndef EV_CB_INVOKE
94# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 102# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
95#endif 103#endif
96 104
… …
104/* shared by all watchers */ 112/* shared by all watchers */
105#define EV_WATCHER(type) \ 113#define EV_WATCHER(type) \
106 int active; /* private */ \ 114 int active; /* private */ \
107 int pending; /* private */ \ 115 int pending; /* private */ \
108 int priority; /* private */ \ 116 int priority; /* private */ \
109 EV_COMMON; /* rw */ \ 117 EV_COMMON /* rw */ \
110 EV_CB_DECLARE (type) /* private */ 118 EV_CB_DECLARE (type) /* private */
111 119
112#define EV_WATCHER_LIST(type) \ 120#define EV_WATCHER_LIST(type) \
113 EV_WATCHER (type); \ 121 EV_WATCHER (type) \
114 struct ev_watcher_list *next /* private */ 122 struct ev_watcher_list *next; /* private */
115 123
116#define EV_WATCHER_TIME(type) \ 124#define EV_WATCHER_TIME(type) \
117 EV_WATCHER (type); \ 125 EV_WATCHER (type) \
118 ev_tstamp at /* private */ 126 ev_tstamp at; /* private */
119 127
120/* base class, nothing to see here unless you subclass */ 128/* base class, nothing to see here unless you subclass */
121struct ev_watcher 129struct ev_watcher
122{ 130{
123 EV_WATCHER (ev_watcher); 131 EV_WATCHER (ev_watcher)
124}; 132};
125 133
126/* base class, nothing to see here unless you subclass */ 134/* base class, nothing to see here unless you subclass */
127struct ev_watcher_list 135struct ev_watcher_list
128{ 136{
129 EV_WATCHER_LIST (ev_watcher_list); 137 EV_WATCHER_LIST (ev_watcher_list)
130}; 138};
131 139
132/* base class, nothing to see here unless you subclass */ 140/* base class, nothing to see here unless you subclass */
133struct ev_watcher_time 141struct ev_watcher_time
134{ 142{
135 EV_WATCHER_TIME (ev_watcher_time); 143 EV_WATCHER_TIME (ev_watcher_time)
136}; 144};
137 145
138/* invoked after a specific time, repeatable (based on monotonic clock) */ 146/* invoked after a specific time, repeatable (based on monotonic clock) */
139/* revent EV_TIMEOUT */ 147/* revent EV_TIMEOUT */
140struct ev_timer 148struct ev_timer
141{ 149{
142 EV_WATCHER_TIME (ev_timer); 150 EV_WATCHER_TIME (ev_timer)
143 151
144 ev_tstamp repeat; /* rw */ 152 ev_tstamp repeat; /* rw */
145}; 153};
146 154
147/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 155/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
148/* revent EV_PERIODIC */ 156/* revent EV_PERIODIC */
149struct ev_periodic 157struct ev_periodic
150{ 158{
151 EV_WATCHER_TIME (ev_periodic); 159 EV_WATCHER_TIME (ev_periodic)
152 160
153 ev_tstamp interval; /* rw */ 161 ev_tstamp interval; /* rw */
154 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
155}; 163};
156 164
157/* invoked when fd is either EV_READable or EV_WRITEable */ 165/* invoked when fd is either EV_READable or EV_WRITEable */
158/* revent EV_READ, EV_WRITE */ 166/* revent EV_READ, EV_WRITE */
159struct ev_io 167struct ev_io
160{ 168{
161 EV_WATCHER_LIST (ev_io); 169 EV_WATCHER_LIST (ev_io)
162 170
163 int fd; /* ro */ 171 int fd; /* ro */
164 int events; /* ro */ 172 int events; /* ro */
165}; 173};
166 174
167/* invoked when the given signal has been received */ 175/* invoked when the given signal has been received */
168/* revent EV_SIGNAL */ 176/* revent EV_SIGNAL */
169struct ev_signal 177struct ev_signal
170{ 178{
171 EV_WATCHER_LIST (ev_signal); 179 EV_WATCHER_LIST (ev_signal)
172 180
173 int signum; /* ro */ 181 int signum; /* ro */
174}; 182};
175 183
176/* invoked when the nothing else needs to be done, keeps the process from blocking */ 184/* invoked when the nothing else needs to be done, keeps the process from blocking */
177/* revent EV_IDLE */ 185/* revent EV_IDLE */
178struct ev_idle 186struct ev_idle
179{ 187{
180 EV_WATCHER (ev_idle); 188 EV_WATCHER (ev_idle)
181}; 189};
182 190
183/* invoked for each run of the mainloop, just before the blocking call */ 191/* invoked for each run of the mainloop, just before the blocking call */
184/* you can still change events in any way you like */ 192/* you can still change events in any way you like */
185/* revent EV_PREPARE */ 193/* revent EV_PREPARE */
186struct ev_prepare 194struct ev_prepare
187{ 195{
188 EV_WATCHER (ev_prepare); 196 EV_WATCHER (ev_prepare)
189}; 197};
190 198
191/* invoked for each run of the mainloop, just after the blocking call */ 199/* invoked for each run of the mainloop, just after the blocking call */
192/* revent EV_CHECK */ 200/* revent EV_CHECK */
193struct ev_check 201struct ev_check
194{ 202{
195 EV_WATCHER (ev_check); 203 EV_WATCHER (ev_check)
196}; 204};
197 205
198/* invoked when sigchld is received and waitpid indicates the givne pid */ 206/* invoked when sigchld is received and waitpid indicates the given pid */
199/* revent EV_CHILD */ 207/* revent EV_CHILD */
200/* does not support priorities */ 208/* does not support priorities */
201struct ev_child 209struct ev_child
202{ 210{
203 EV_WATCHER_LIST (ev_child); 211 EV_WATCHER_LIST (ev_child)
204 212
205 int pid; /* ro */ 213 int pid; /* ro */
206 int rpid; /* rw, holds the received pid */ 214 int rpid; /* rw, holds the received pid */
207 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
208}; 216};
… …
210/* the presence of this union forces similar struct layout */ 218/* the presence of this union forces similar struct layout */
211union ev_any_watcher 219union ev_any_watcher
212{ 220{
213 struct ev_watcher w; 221 struct ev_watcher w;
214 struct ev_watcher_list wl; 222 struct ev_watcher_list wl;
223
215 struct ev_io io; 224 struct ev_io io;
216 struct ev_timer timer; 225 struct ev_timer timer;
217 struct ev_periodic periodic; 226 struct ev_periodic periodic;
218 struct ev_signal signal;
219 struct ev_idle idle; 227 struct ev_idle idle;
220 struct ev_child child;
221 struct ev_prepare prepare; 228 struct ev_prepare prepare;
222 struct ev_check check; 229 struct ev_check check;
230 struct ev_signal signal;
231 struct ev_child child;
223}; 232};
224 233
225#define EVMETHOD_AUTO 0 /* consults environment */ 234/* bits for ev_default_loop and ev_loop_new */
226#define EVMETHOD_SELECT 1 235/* the default */
227#define EVMETHOD_POLL 2 236#define EVFLAG_AUTO 0x00000000 /* not quite a mask */
228#define EVMETHOD_EPOLL 4 237
229#define EVMETHOD_KQUEUE 8 238/* method bits to be ored together */
230#define EVMETHOD_DEVPOLL 16 /* NYI */ 239#define EVMETHOD_SELECT 0x00000001 /* about anywhere */
231#define EVMETHOD_PORT 32 /* NYI */ 240#define EVMETHOD_POLL 0x00000002 /* !win */
232#define EVMETHOD_WIN32 64 /* NYI */ 241#define EVMETHOD_EPOLL 0x00000004 /* linux */
233#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 242#define EVMETHOD_KQUEUE 0x00000008 /* bsd */
243#define EVMETHOD_DEVPOLL 0x00000010 /* solaris 8 */ /* NYI */
244#define EVMETHOD_PORT 0x00000020 /* solaris 10 */ /* NYI */
245
246/* flag bits */
247#define EVFLAG_NOENV 0x01000000 /* do NOT consult environment */
234 248
235#if EV_PROTOTYPES 249#if EV_PROTOTYPES
236int ev_version_major (void); 250int ev_version_major (void);
237int ev_version_minor (void); 251int ev_version_minor (void);
238 252
… …
253void ev_set_syserr_cb (void (*cb)(const char *msg)); 267void ev_set_syserr_cb (void (*cb)(const char *msg));
254 268
255# if EV_MULTIPLICITY 269# if EV_MULTIPLICITY
256/* the default loop is the only one that handles signals and child watchers */ 270/* the default loop is the only one that handles signals and child watchers */
257/* you can call this as often as you like */ 271/* you can call this as often as you like */
258struct ev_loop *ev_default_loop (int methods); /* returns default loop */ 272struct ev_loop *ev_default_loop (unsigned int flags); /* returns default loop */
259 273
260/* create and destroy alternative loops that don't handle signals */ 274/* create and destroy alternative loops that don't handle signals */
261struct ev_loop *ev_loop_new (int methods); 275struct ev_loop *ev_loop_new (unsigned int flags);
262void ev_loop_destroy (EV_P); 276void ev_loop_destroy (EV_P);
263void ev_loop_fork (EV_P); 277void ev_loop_fork (EV_P);
278
279ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
280
264# else 281# else
282
265int ev_default_loop (int methods); /* returns true when successful */ 283int ev_default_loop (unsigned int flags); /* returns true when successful */
284
285static ev_tstamp
286ev_now (void)
287{
288 extern ev_tstamp ev_rt_now;
289
290 return ev_rt_now;
291}
266# endif 292# endif
267 293
268void ev_default_destroy (void); /* destroy the default loop */ 294void ev_default_destroy (void); /* destroy the default loop */
269/* this needs to be called after fork, to duplicate the default loop */ 295/* this needs to be called after fork, to duplicate the default loop */
270/* if you create alternative loops you have to call ev_loop_fork on them */ 296/* if you create alternative loops you have to call ev_loop_fork on them */
271/* you can call it in either the parent or the child */ 297/* you can call it in either the parent or the child */
272/* you can actually call it at any time, anywhere :) */ 298/* you can actually call it at any time, anywhere :) */
273void ev_default_fork (void); 299void ev_default_fork (void);
274 300
275int ev_method (EV_P); 301unsigned int ev_method (EV_P);
276#endif 302#endif
277 303
278#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 304#define EVLOOP_NONBLOCK 1 /* do not block/wait */
279#define EVLOOP_ONESHOT 2 /* block *once* only */ 305#define EVLOOP_ONESHOT 2 /* block *once* only */
280#define EVUNLOOP_ONCE 1 /* unloop once */ 306#define EVUNLOOP_ONCE 1 /* unloop once */
281#define EVUNLOOP_ALL 2 /* unloop all loops */ 307#define EVUNLOOP_ALL 2 /* unloop all loops */
282 308
283#if EV_PROTOTYPES 309#if EV_PROTOTYPES
284void ev_loop (EV_P_ int flags); 310void ev_loop (EV_P_ int flags);
285void 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 */ 311void 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 */
286
287ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
288 312
289/* 313/*
290 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 314 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
291 * keeps one reference. if you have a long-runing watcher you never unregister that 315 * keeps one reference. if you have a long-runing watcher you never unregister that
292 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 316 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
353void ev_timer_start (EV_P_ struct ev_timer *w); 377void ev_timer_start (EV_P_ struct ev_timer *w);
354void ev_timer_stop (EV_P_ struct ev_timer *w); 378void ev_timer_stop (EV_P_ struct ev_timer *w);
355/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 379/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
356void ev_timer_again (EV_P_ struct ev_timer *w); 380void ev_timer_again (EV_P_ struct ev_timer *w);
357 381
382#if EV_PERIODICS
358void ev_periodic_start (EV_P_ struct ev_periodic *w); 383void ev_periodic_start (EV_P_ struct ev_periodic *w);
359void ev_periodic_stop (EV_P_ struct ev_periodic *w); 384void ev_periodic_stop (EV_P_ struct ev_periodic *w);
360void ev_periodic_again (EV_P_ struct ev_periodic *w); 385void ev_periodic_again (EV_P_ struct ev_periodic *w);
386#endif
361 387
362void ev_idle_start (EV_P_ struct ev_idle *w); 388void ev_idle_start (EV_P_ struct ev_idle *w);
363void ev_idle_stop (EV_P_ struct ev_idle *w); 389void ev_idle_stop (EV_P_ struct ev_idle *w);
364 390
365void ev_prepare_start (EV_P_ struct ev_prepare *w); 391void ev_prepare_start (EV_P_ struct ev_prepare *w);

Diff Legend

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