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

Comparing libev/ev.h (file contents):
Revision 1.90 by root, Tue Dec 25 07:05:45 2007 UTC vs.
Revision 1.104 by root, Thu Jun 19 07:06:35 2008 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008 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 *
… …
76 76
77#ifndef EV_EMBED_ENABLE 77#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
79#endif 79#endif
80 80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
88#endif
89
81/*****************************************************************************/ 90/*****************************************************************************/
82 91
83#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
93# ifdef _WIN32
94# include <time.h>
95# include <sys/types.h>
96# endif
84# include <sys/stat.h> 97# include <sys/stat.h>
85#endif 98#endif
86 99
87/* support multiple event loops? */ 100/* support multiple event loops? */
88#if EV_MULTIPLICITY 101#if EV_MULTIPLICITY
89struct ev_loop; 102struct ev_loop;
90# define EV_P struct ev_loop *loop 103# define EV_P struct ev_loop *loop
91# define EV_P_ EV_P, 104# define EV_P_ EV_P,
92# define EV_A loop 105# define EV_A loop
93# define EV_A_ EV_A, 106# define EV_A_ EV_A,
107# define EV_DEFAULT_UC ev_default_loop_uc ()
108# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
94# define EV_DEFAULT ev_default_loop (0) 109# define EV_DEFAULT ev_default_loop (0)
95# define EV_DEFAULT_ EV_DEFAULT, 110# define EV_DEFAULT_ EV_DEFAULT,
96#else 111#else
97# define EV_P void 112# define EV_P void
98# define EV_P_ 113# define EV_P_
99# define EV_A 114# define EV_A
100# define EV_A_ 115# define EV_A_
101# define EV_DEFAULT 116# define EV_DEFAULT
102# define EV_DEFAULT_ 117# define EV_DEFAULT_
103 118# define EV_DEFAULT_UC
119# define EV_DEFAULT_UC_
104# undef EV_EMBED_ENABLE 120# undef EV_EMBED_ENABLE
105#endif 121#endif
106 122
123#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
124# define EV_INLINE static inline
125#else
126# define EV_INLINE static
127#endif
128
129/*****************************************************************************/
130
107/* eventmask, revents, events... */ 131/* eventmask, revents, events... */
108#define EV_UNDEF -1L /* guaranteed to be invalid */ 132#define EV_UNDEF -1 /* guaranteed to be invalid */
109#define EV_NONE 0x00L /* no events */ 133#define EV_NONE 0x00 /* no events */
110#define EV_READ 0x01L /* ev_io detected read will not block */ 134#define EV_READ 0x01 /* ev_io detected read will not block */
111#define EV_WRITE 0x02L /* ev_io detected write will not block */ 135#define EV_WRITE 0x02 /* ev_io detected write will not block */
112#define EV_IOFDSET 0x80L /* internal use only */ 136#define EV_IOFDSET 0x80 /* internal use only */
113#define EV_TIMEOUT 0x00000100L /* timer timed out */ 137#define EV_TIMEOUT 0x00000100 /* timer timed out */
114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 138#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
115#define EV_SIGNAL 0x00000400L /* signal was received */ 139#define EV_SIGNAL 0x00000400 /* signal was received */
116#define EV_CHILD 0x00000800L /* child/pid had status change */ 140#define EV_CHILD 0x00000800 /* child/pid had status change */
117#define EV_STAT 0x00001000L /* stat data changed */ 141#define EV_STAT 0x00001000 /* stat data changed */
118#define EV_IDLE 0x00002000L /* event loop is idling */ 142#define EV_IDLE 0x00002000 /* event loop is idling */
119#define EV_PREPARE 0x00004000L /* event loop about to poll */ 143#define EV_PREPARE 0x00004000 /* event loop about to poll */
120#define EV_CHECK 0x00008000L /* event loop finished poll */ 144#define EV_CHECK 0x00008000 /* event loop finished poll */
121#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 145#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
122#define EV_FORK 0x00020000L /* event loop resumed in child */ 146#define EV_FORK 0x00020000 /* event loop resumed in child */
147#define EV_ASYNC 0x00040000 /* async intra-loop signal */
123#define EV_ERROR 0x80000000L /* sent when an error occurs */ 148#define EV_ERROR 0x80000000 /* sent when an error occurs */
124 149
125/* can be used to add custom fields to all watchers, while losing binary compatibility */ 150/* can be used to add custom fields to all watchers, while losing binary compatibility */
126#ifndef EV_COMMON 151#ifndef EV_COMMON
127# define EV_COMMON void *data; 152# define EV_COMMON void *data;
128#endif 153#endif
129#ifndef EV_PROTOTYPES 154#ifndef EV_PROTOTYPES
130# define EV_PROTOTYPES 1 155# define EV_PROTOTYPES 1
131#endif 156#endif
132 157
133#define EV_VERSION_MAJOR 2 158#define EV_VERSION_MAJOR 3
134#define EV_VERSION_MINOR 0 159#define EV_VERSION_MINOR 0
135 160
136#ifndef EV_CB_DECLARE 161#ifndef EV_CB_DECLARE
137# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 162# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
138#endif 163#endif
… …
143/* 168/*
144 * struct member types: 169 * struct member types:
145 * private: you can look at them, but not change them, and they might not mean anything to you. 170 * private: you can look at them, but not change them, and they might not mean anything to you.
146 * ro: can be read anytime, but only changed when the watcher isn't active 171 * ro: can be read anytime, but only changed when the watcher isn't active
147 * rw: can be read and modified anytime, even when the watcher is active 172 * rw: can be read and modified anytime, even when the watcher is active
173 *
174 * some internal details that might be helpful for debugging:
175 *
176 * active is either 0, which means the watcher is not active,
177 * or the array index of the watcher (periodics, timers)
178 * or the array index + 1 (most other watchers)
179 * or simply 1 for watchers that aren't in some array.
180 * pending is either 0, in which case the watcher isn't,
181 * or the array index + 1 in the pendings array.
148 */ 182 */
149 183
150/* shared by all watchers */ 184/* shared by all watchers */
151#define EV_WATCHER(type) \ 185#define EV_WATCHER(type) \
152 int active; /* private */ \ 186 int active; /* private */ \
… …
225/* does not support priorities */ 259/* does not support priorities */
226typedef struct ev_child 260typedef struct ev_child
227{ 261{
228 EV_WATCHER_LIST (ev_child) 262 EV_WATCHER_LIST (ev_child)
229 263
264 int flags; /* private */
230 int pid; /* ro */ 265 int pid; /* ro */
231 int rpid; /* rw, holds the received pid */ 266 int rpid; /* rw, holds the received pid */
232 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 267 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
233} ev_child; 268} ev_child;
234 269
… …
304 ev_idle idle; /* unused */ 339 ev_idle idle; /* unused */
305 ev_fork fork; /* unused */ 340 ev_fork fork; /* unused */
306} ev_embed; 341} ev_embed;
307#endif 342#endif
308 343
344#if EV_ASYNC_ENABLE
345/* invoked when somebody calls ev_async_send on the watcher */
346/* revent EV_ASYNC */
347typedef struct ev_async
348{
349 EV_WATCHER (ev_async)
350
351 EV_ATOMIC_T sent; /* private */
352} ev_async;
353
354# define ev_async_pending(w) ((w)->sent + 0)
355#endif
356
309/* the presence of this union forces similar struct layout */ 357/* the presence of this union forces similar struct layout */
310union ev_any_watcher 358union ev_any_watcher
311{ 359{
312 struct ev_watcher w; 360 struct ev_watcher w;
313 struct ev_watcher_list wl; 361 struct ev_watcher_list wl;
… …
329 struct ev_fork fork; 377 struct ev_fork fork;
330#endif 378#endif
331#if EV_EMBED_ENABLE 379#if EV_EMBED_ENABLE
332 struct ev_embed embed; 380 struct ev_embed embed;
333#endif 381#endif
382#if EV_ASYNC_ENABLE
383 struct ev_async async;
384#endif
334}; 385};
335 386
336/* bits for ev_default_loop and ev_loop_new */ 387/* bits for ev_default_loop and ev_loop_new */
337/* the default */ 388/* the default */
338#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 389#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
339/* flag bits */ 390/* flag bits */
340#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 391#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
341#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */ 392#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
342/* method bits to be ored together */ 393/* method bits to be ored together */
343#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 394#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
344#define EVBACKEND_POLL 0x00000002UL /* !win */ 395#define EVBACKEND_POLL 0x00000002U /* !win */
345#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 396#define EVBACKEND_EPOLL 0x00000004U /* linux */
346#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 397#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
347#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 398#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
348#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 399#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
349 400
350#if EV_PROTOTYPES 401#if EV_PROTOTYPES
351int ev_version_major (void); 402int ev_version_major (void);
352int ev_version_minor (void); 403int ev_version_minor (void);
353 404
… …
370 * retryable syscall error 421 * retryable syscall error
371 * (such as failed select, poll, epoll_wait) 422 * (such as failed select, poll, epoll_wait)
372 */ 423 */
373void ev_set_syserr_cb (void (*cb)(const char *msg)); 424void ev_set_syserr_cb (void (*cb)(const char *msg));
374 425
375# if EV_MULTIPLICITY 426#if EV_MULTIPLICITY
427EV_INLINE struct ev_loop *
428ev_default_loop_uc (void)
429{
430 extern struct ev_loop *ev_default_loop_ptr;
431
432 return ev_default_loop_ptr;
433}
434
376/* the default loop is the only one that handles signals and child watchers */ 435/* the default loop is the only one that handles signals and child watchers */
377/* you can call this as often as you like */ 436/* you can call this as often as you like */
378static struct ev_loop * 437EV_INLINE struct ev_loop *
379ev_default_loop (unsigned int flags) 438ev_default_loop (unsigned int flags)
380{ 439{
381 extern struct ev_loop *ev_default_loop_ptr; 440 struct ev_loop *loop = ev_default_loop_uc ();
441
442 if (!loop)
443 {
382 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 444 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
383 445
384 if (!ev_default_loop_ptr)
385 ev_default_loop_init (flags); 446 loop = ev_default_loop_init (flags);
447 }
386 448
387 return ev_default_loop_ptr; 449 return loop;
388} 450}
389 451
390/* create and destroy alternative loops that don't handle signals */ 452/* create and destroy alternative loops that don't handle signals */
391struct ev_loop *ev_loop_new (unsigned int flags); 453struct ev_loop *ev_loop_new (unsigned int flags);
392void ev_loop_destroy (EV_P); 454void ev_loop_destroy (EV_P);
393void ev_loop_fork (EV_P); 455void ev_loop_fork (EV_P);
456void ev_loop_verify (EV_P);
394 457
395ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 458ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
396 459
397# else 460#else
398 461
399int ev_default_loop (unsigned int flags); /* returns true when successful */ 462int ev_default_loop (unsigned int flags); /* returns true when successful */
400 463
401static ev_tstamp 464EV_INLINE ev_tstamp
402ev_now (void) 465ev_now (void)
403{ 466{
404 extern ev_tstamp ev_rt_now; 467 extern ev_tstamp ev_rt_now;
405 468
406 return ev_rt_now; 469 return ev_rt_now;
407} 470}
471#endif /* multiplicity */
472
473EV_INLINE int
474ev_is_default_loop (EV_P)
475{
476#if EV_MULTIPLICITY
477 extern struct ev_loop *ev_default_loop_ptr;
478
479 return !!(EV_A == ev_default_loop_ptr);
480#else
481 return 1;
408# endif 482#endif
483}
409 484
410void ev_default_destroy (void); /* destroy the default loop */ 485void ev_default_destroy (void); /* destroy the default loop */
411/* this needs to be called after fork, to duplicate the default loop */ 486/* this needs to be called after fork, to duplicate the default loop */
412/* if you create alternative loops you have to call ev_loop_fork on them */ 487/* if you create alternative loops you have to call ev_loop_fork on them */
413/* you can call it in either the parent or the child */ 488/* you can call it in either the parent or the child */
414/* you can actually call it at any time, anywhere :) */ 489/* you can actually call it at any time, anywhere :) */
415void ev_default_fork (void); 490void ev_default_fork (void);
416 491
417unsigned int ev_backend (EV_P); /* backend in use by loop */ 492unsigned int ev_backend (EV_P); /* backend in use by loop */
418unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 493unsigned int ev_loop_count (EV_P); /* number of loop iterations */
419#endif 494#endif /* prototypes */
420 495
421#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 496#define EVLOOP_NONBLOCK 1 /* do not block/wait */
422#define EVLOOP_ONESHOT 2 /* block *once* only */ 497#define EVLOOP_ONESHOT 2 /* block *once* only */
423#define EVUNLOOP_CANCEL 0 /* undo unloop */ 498#define EVUNLOOP_CANCEL 0 /* undo unloop */
424#define EVUNLOOP_ONE 1 /* unloop once */ 499#define EVUNLOOP_ONE 1 /* unloop once */
… …
452 ((ev_watcher *)(void *)(ev))->priority = 0; \ 527 ((ev_watcher *)(void *)(ev))->priority = 0; \
453 ev_set_cb ((ev), cb_); \ 528 ev_set_cb ((ev), cb_); \
454} while (0) 529} while (0)
455 530
456#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 531#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
457#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 532#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
458#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 533#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
459#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 534#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
460#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 535#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
461#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 536#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
462#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 537#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
463#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 538#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
464#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 539#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
465#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 540#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
466#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 541#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
542#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
467 543
468#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 544#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
469#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 545#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
470#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 546#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
471#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 547#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
472#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 548#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
473#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 549#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
474#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 550#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
475#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 551#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
476#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 552#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
477#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 553#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
478#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 554#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
555#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
479 556
480#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 557#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
481#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 558#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
482 559
483#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 560#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
484#define ev_cb(ev) (ev)->cb /* rw */ 561#define ev_cb(ev) (ev)->cb /* rw */
485#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 562#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
563
564#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
486 565
487#ifndef ev_set_cb 566#ifndef ev_set_cb
488# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 567# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
489#endif 568#endif
490 569
… …
549void ev_embed_start (EV_P_ ev_embed *w); 628void ev_embed_start (EV_P_ ev_embed *w);
550void ev_embed_stop (EV_P_ ev_embed *w); 629void ev_embed_stop (EV_P_ ev_embed *w);
551void ev_embed_sweep (EV_P_ ev_embed *w); 630void ev_embed_sweep (EV_P_ ev_embed *w);
552# endif 631# endif
553 632
633# if EV_ASYNC_ENABLE
634void ev_async_start (EV_P_ ev_async *w);
635void ev_async_stop (EV_P_ ev_async *w);
636void ev_async_send (EV_P_ ev_async *w);
637# endif
638
554#endif 639#endif
555 640
556#ifdef __cplusplus 641#ifdef __cplusplus
557} 642}
558#endif 643#endif

Diff Legend

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