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

Comparing libev/ev.h (file contents):
Revision 1.47 by root, Sat Nov 10 03:13:50 2007 UTC vs.
Revision 1.64 by root, Fri Nov 23 19:13:33 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 -1L /* guaranteed to be invalid */
67#define EV_NONE 0x00 75#define EV_NONE 0x00L
68#define EV_READ 0x01 76#define EV_READ 0x01L /* io only */
69#define EV_WRITE 0x02 77#define EV_WRITE 0x02L /* io only */
70#define EV_TIMEOUT 0x000100 78#define EV_TIMEOUT 0x000100L /* timer only */
71#define EV_PERIODIC 0x000200 79#define EV_PERIODIC 0x000200L /* periodic timer only */
72#define EV_SIGNAL 0x000400 80#define EV_SIGNAL 0x000400L /* signal only */
73#define EV_IDLE 0x000800 81#define EV_IDLE 0x000800L /* idle only */
74#define EV_CHECK 0x001000 82#define EV_CHECK 0x001000L /* check only */
75#define EV_PREPARE 0x002000 83#define EV_PREPARE 0x002000L /* prepare only */
76#define EV_CHILD 0x004000 84#define EV_CHILD 0x004000L /* child/pid only */
85#define EV_EMBED 0x008000L /* embedded event loop */
77#define EV_ERROR 0x800000 /* sent when an error occurs */ 86#define EV_ERROR 0x800000L /* sent when an error occurs */
78 87
79/* can be used to add custom fields to all watchers */ 88/* can be used to add custom fields to all watchers, while losing binary compatibility */
80#ifndef EV_COMMON 89#ifndef EV_COMMON
81# define EV_COMMON void *data 90# define EV_COMMON void *data;
82#endif 91#endif
83#ifndef EV_PROTOTYPES 92#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1 93# define EV_PROTOTYPES 1
85#endif 94#endif
86 95
… …
104/* shared by all watchers */ 113/* shared by all watchers */
105#define EV_WATCHER(type) \ 114#define EV_WATCHER(type) \
106 int active; /* private */ \ 115 int active; /* private */ \
107 int pending; /* private */ \ 116 int pending; /* private */ \
108 int priority; /* private */ \ 117 int priority; /* private */ \
109 EV_COMMON; /* rw */ \ 118 EV_COMMON /* rw */ \
110 EV_CB_DECLARE (type) /* private */ 119 EV_CB_DECLARE (type) /* private */
111 120
112#define EV_WATCHER_LIST(type) \ 121#define EV_WATCHER_LIST(type) \
113 EV_WATCHER (type); \ 122 EV_WATCHER (type) \
114 struct ev_watcher_list *next /* private */ 123 struct ev_watcher_list *next; /* private */
115 124
116#define EV_WATCHER_TIME(type) \ 125#define EV_WATCHER_TIME(type) \
117 EV_WATCHER (type); \ 126 EV_WATCHER (type) \
118 ev_tstamp at /* private */ 127 ev_tstamp at; /* private */
119 128
120/* base class, nothing to see here unless you subclass */ 129/* base class, nothing to see here unless you subclass */
121struct ev_watcher 130struct ev_watcher
122{ 131{
123 EV_WATCHER (ev_watcher); 132 EV_WATCHER (ev_watcher)
124}; 133};
125 134
126/* base class, nothing to see here unless you subclass */ 135/* base class, nothing to see here unless you subclass */
127struct ev_watcher_list 136struct ev_watcher_list
128{ 137{
129 EV_WATCHER_LIST (ev_watcher_list); 138 EV_WATCHER_LIST (ev_watcher_list)
130}; 139};
131 140
132/* base class, nothing to see here unless you subclass */ 141/* base class, nothing to see here unless you subclass */
133struct ev_watcher_time 142struct ev_watcher_time
134{ 143{
135 EV_WATCHER_TIME (ev_watcher_time); 144 EV_WATCHER_TIME (ev_watcher_time)
136}; 145};
137 146
138/* invoked after a specific time, repeatable (based on monotonic clock) */ 147/* invoked after a specific time, repeatable (based on monotonic clock) */
139/* revent EV_TIMEOUT */ 148/* revent EV_TIMEOUT */
140struct ev_timer 149struct ev_timer
141{ 150{
142 EV_WATCHER_TIME (ev_timer); 151 EV_WATCHER_TIME (ev_timer)
143 152
144 ev_tstamp repeat; /* rw */ 153 ev_tstamp repeat; /* rw */
145}; 154};
146 155
147/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 156/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
148/* revent EV_PERIODIC */ 157/* revent EV_PERIODIC */
149struct ev_periodic 158struct ev_periodic
150{ 159{
151 EV_WATCHER_TIME (ev_periodic); 160 EV_WATCHER_TIME (ev_periodic)
152 161
153 ev_tstamp interval; /* rw */ 162 ev_tstamp interval; /* rw */
154 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 163 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
155}; 164};
156 165
157/* invoked when fd is either EV_READable or EV_WRITEable */ 166/* invoked when fd is either EV_READable or EV_WRITEable */
158/* revent EV_READ, EV_WRITE */ 167/* revent EV_READ, EV_WRITE */
159struct ev_io 168struct ev_io
160{ 169{
161 EV_WATCHER_LIST (ev_io); 170 EV_WATCHER_LIST (ev_io)
162 171
163 int fd; /* ro */ 172 int fd; /* ro */
164 int events; /* ro */ 173 int events; /* ro */
165}; 174};
166 175
167/* invoked when the given signal has been received */ 176/* invoked when the given signal has been received */
168/* revent EV_SIGNAL */ 177/* revent EV_SIGNAL */
169struct ev_signal 178struct ev_signal
170{ 179{
171 EV_WATCHER_LIST (ev_signal); 180 EV_WATCHER_LIST (ev_signal)
172 181
173 int signum; /* ro */ 182 int signum; /* ro */
174}; 183};
175 184
176/* invoked when the nothing else needs to be done, keeps the process from blocking */ 185/* invoked when the nothing else needs to be done, keeps the process from blocking */
177/* revent EV_IDLE */ 186/* revent EV_IDLE */
178struct ev_idle 187struct ev_idle
179{ 188{
180 EV_WATCHER (ev_idle); 189 EV_WATCHER (ev_idle)
181}; 190};
182 191
183/* invoked for each run of the mainloop, just before the blocking call */ 192/* invoked for each run of the mainloop, just before the blocking call */
184/* you can still change events in any way you like */ 193/* you can still change events in any way you like */
185/* revent EV_PREPARE */ 194/* revent EV_PREPARE */
186struct ev_prepare 195struct ev_prepare
187{ 196{
188 EV_WATCHER (ev_prepare); 197 EV_WATCHER (ev_prepare)
189}; 198};
190 199
191/* invoked for each run of the mainloop, just after the blocking call */ 200/* invoked for each run of the mainloop, just after the blocking call */
192/* revent EV_CHECK */ 201/* revent EV_CHECK */
193struct ev_check 202struct ev_check
194{ 203{
195 EV_WATCHER (ev_check); 204 EV_WATCHER (ev_check)
196}; 205};
197 206
198/* invoked when sigchld is received and waitpid indicates the givne pid */ 207/* invoked when sigchld is received and waitpid indicates the given pid */
199/* revent EV_CHILD */ 208/* revent EV_CHILD */
200/* does not support priorities */ 209/* does not support priorities */
201struct ev_child 210struct ev_child
202{ 211{
203 EV_WATCHER_LIST (ev_child); 212 EV_WATCHER_LIST (ev_child)
204 213
205 int pid; /* ro */ 214 int pid; /* ro */
206 int rpid; /* rw, holds the received pid */ 215 int rpid; /* rw, holds the received pid */
207 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
208}; 217};
218
219#if EV_MULTIPLICITY
220/* used to embed an event loop inside another */
221/* the callback gets invoked when the event loop has handled events, and can be 0 */
222struct ev_embed
223{
224 EV_WATCHER (ev_embed)
225
226 struct ev_io io; /* private */
227 struct ev_loop *loop; /* ro */
228};
229#endif
209 230
210/* the presence of this union forces similar struct layout */ 231/* the presence of this union forces similar struct layout */
211union ev_any_watcher 232union ev_any_watcher
212{ 233{
213 struct ev_watcher w; 234 struct ev_watcher w;
… …
219 struct ev_idle idle; 240 struct ev_idle idle;
220 struct ev_prepare prepare; 241 struct ev_prepare prepare;
221 struct ev_check check; 242 struct ev_check check;
222 struct ev_signal signal; 243 struct ev_signal signal;
223 struct ev_child child; 244 struct ev_child child;
245 struct ev_embed embed;
224}; 246};
225 247
226#define EVMETHOD_AUTO 0 /* consults environment */ 248/* bits for ev_default_loop and ev_loop_new */
227#define EVMETHOD_SELECT 1 249/* the default */
228#define EVMETHOD_POLL 2 250#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
229#define EVMETHOD_EPOLL 4 251/* flag bits */
230#define EVMETHOD_KQUEUE 8 252#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
231#define EVMETHOD_DEVPOLL 16 /* NYI */ 253/* method bits to be ored together */
232#define EVMETHOD_PORT 32 /* NYI */ 254#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
233#define EVMETHOD_WIN32 64 /* NYI */ 255#define EVBACKEND_POLL 0x00000002UL /* !win */
234#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 256#define EVBACKEND_EPOLL 0x00000004UL /* linux */
257#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
258#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
259#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
235 260
236#if EV_PROTOTYPES 261#if EV_PROTOTYPES
237int ev_version_major (void); 262int ev_version_major (void);
238int ev_version_minor (void); 263int ev_version_minor (void);
264
265unsigned int ev_supported_backends (void);
266unsigned int ev_recommended_backends (void);
267unsigned int ev_embeddable_backends (void);
239 268
240ev_tstamp ev_time (void); 269ev_tstamp ev_time (void);
241 270
242/* Sets the allocation function to use, works like realloc. 271/* Sets the allocation function to use, works like realloc.
243 * It is used to allocate and free memory. 272 * It is used to allocate and free memory.
… …
254void ev_set_syserr_cb (void (*cb)(const char *msg)); 283void ev_set_syserr_cb (void (*cb)(const char *msg));
255 284
256# if EV_MULTIPLICITY 285# if EV_MULTIPLICITY
257/* the default loop is the only one that handles signals and child watchers */ 286/* the default loop is the only one that handles signals and child watchers */
258/* you can call this as often as you like */ 287/* you can call this as often as you like */
259struct ev_loop *ev_default_loop (int methods); /* returns default loop */ 288static struct ev_loop *
289ev_default_loop (unsigned int flags)
290{
291 extern struct ev_loop *ev_default_loop_ptr;
292 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
293
294 if (!ev_default_loop_ptr)
295 ev_default_loop_init (flags);
296
297 return ev_default_loop_ptr;
298}
260 299
261/* create and destroy alternative loops that don't handle signals */ 300/* create and destroy alternative loops that don't handle signals */
262struct ev_loop *ev_loop_new (int methods); 301struct ev_loop *ev_loop_new (unsigned int flags);
263void ev_loop_destroy (EV_P); 302void ev_loop_destroy (EV_P);
264void ev_loop_fork (EV_P); 303void ev_loop_fork (EV_P);
265 304
266ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 305ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
267 306
268# else 307# else
269 308
270int ev_default_loop (int methods); /* returns true when successful */ 309int ev_default_loop (unsigned int flags); /* returns true when successful */
271 310
272static ev_tstamp 311static ev_tstamp
273ev_now () 312ev_now (void)
274{ 313{
275 extern ev_rt_now; 314 extern ev_tstamp ev_rt_now;
276 315
277 return ev_rt_now; 316 return ev_rt_now;
278} 317}
279# endif 318# endif
280 319
… …
283/* if you create alternative loops you have to call ev_loop_fork on them */ 322/* if you create alternative loops you have to call ev_loop_fork on them */
284/* you can call it in either the parent or the child */ 323/* you can call it in either the parent or the child */
285/* you can actually call it at any time, anywhere :) */ 324/* you can actually call it at any time, anywhere :) */
286void ev_default_fork (void); 325void ev_default_fork (void);
287 326
288int ev_method (EV_P); 327unsigned int ev_backend (EV_P);
289#endif 328#endif
290 329
291#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 330#define EVLOOP_NONBLOCK 1 /* do not block/wait */
292#define EVLOOP_ONESHOT 2 /* block *once* only */ 331#define EVLOOP_ONESHOT 2 /* block *once* only */
293#define EVUNLOOP_ONCE 1 /* unloop once */ 332#define EVUNLOOP_ONE 1 /* unloop once */
294#define EVUNLOOP_ALL 2 /* unloop all loops */ 333#define EVUNLOOP_ALL 2 /* unloop all loops */
295 334
296#if EV_PROTOTYPES 335#if EV_PROTOTYPES
297void ev_loop (EV_P_ int flags); 336void ev_loop (EV_P_ int flags);
298void 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 */ 337void 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 */
… …
325#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 364#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
326#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 365#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
327#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 366#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
328#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 367#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
329#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 368#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
369#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
330 370
331#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 371#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
332#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 372#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
333#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 373#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
334#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 374#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
335#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 375#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
336#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 376#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
337#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 377#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
338#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 378#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
379#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
339 380
340#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 381#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
341#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 382#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
342 383
343#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 384#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
… …
364void ev_timer_start (EV_P_ struct ev_timer *w); 405void ev_timer_start (EV_P_ struct ev_timer *w);
365void ev_timer_stop (EV_P_ struct ev_timer *w); 406void ev_timer_stop (EV_P_ struct ev_timer *w);
366/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 407/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
367void ev_timer_again (EV_P_ struct ev_timer *w); 408void ev_timer_again (EV_P_ struct ev_timer *w);
368 409
410#if EV_PERIODICS
369void ev_periodic_start (EV_P_ struct ev_periodic *w); 411void ev_periodic_start (EV_P_ struct ev_periodic *w);
370void ev_periodic_stop (EV_P_ struct ev_periodic *w); 412void ev_periodic_stop (EV_P_ struct ev_periodic *w);
371void ev_periodic_again (EV_P_ struct ev_periodic *w); 413void ev_periodic_again (EV_P_ struct ev_periodic *w);
414#endif
372 415
373void ev_idle_start (EV_P_ struct ev_idle *w); 416void ev_idle_start (EV_P_ struct ev_idle *w);
374void ev_idle_stop (EV_P_ struct ev_idle *w); 417void ev_idle_stop (EV_P_ struct ev_idle *w);
375 418
376void ev_prepare_start (EV_P_ struct ev_prepare *w); 419void ev_prepare_start (EV_P_ struct ev_prepare *w);
… …
384void ev_signal_stop (EV_P_ struct ev_signal *w); 427void ev_signal_stop (EV_P_ struct ev_signal *w);
385 428
386/* only supported in the default loop */ 429/* only supported in the default loop */
387void ev_child_start (EV_P_ struct ev_child *w); 430void ev_child_start (EV_P_ struct ev_child *w);
388void ev_child_stop (EV_P_ struct ev_child *w); 431void ev_child_stop (EV_P_ struct ev_child *w);
432
433# if EV_MULTIPLICITY
434/* only supported when loop to be embedded is in fact embeddable */
435void ev_embed_start (EV_P_ struct ev_embed *w);
436void ev_embed_stop (EV_P_ struct ev_embed *w);
437# endif
438
389#endif 439#endif
390 440
391#ifdef __cplusplus 441#ifdef __cplusplus
392} 442}
393#endif 443#endif

Diff Legend

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