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

Comparing libev/ev.h (file contents):
Revision 1.3 by root, Tue Oct 30 23:10:33 2007 UTC vs.
Revision 1.9 by root, Wed Oct 31 13:57:34 2007 UTC

… …
3 3
4typedef double ev_tstamp; 4typedef double ev_tstamp;
5 5
6/* eventmask, revents, events... */ 6/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 7#define EV_UNDEF -1 /* guaranteed to be invalid */
8#define EV_NONE 0 8#define EV_NONE 0x00
9#define EV_READ 1 9#define EV_READ 0x01
10#define EV_WRITE 2 10#define EV_WRITE 0x02
11#define EV_TIMEOUT 4 11#define EV_TIMEOUT 0x04
12#define EV_SIGNAL 8 12#define EV_SIGNAL 0x08
13#define EV_IDLE 0x10
14#define EV_CHECK 0x20
15#define EV_ERROR (0x3f|0x80)
16
17/* can be used to add custom fields to all watchers */
18#ifndef EV_COMMON
19# define EV_COMMON void *data
20#endif
21#ifndef EV_PROTOTYPES
22# define EV_PROTOTYPES 1
23#endif
24
25/*
26 * struct member types:
27 * private: you can look at them, but not change them, and they might not mean anything to you.
28 * ro: can be read anytime, but only changed when the watcher isn't active
29 * rw: can be read and modified anytime, even when the watcher is active
30 */
13 31
14/* shared by all watchers */ 32/* shared by all watchers */
15#define EV_WATCHER(type) \ 33#define EV_WATCHER(type) \
16 int active; /* private */ \ 34 int active; /* private */ \
17 int pending; /* private */ \ 35 int pending; /* private */ \
18 void *data; /* rw */ \ 36 EV_COMMON; /* rw */ \
19 void (*cb)(struct type *, int revents) /* rw */ 37 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
20 38
21#define EV_WATCHER_LIST(type) \ 39#define EV_WATCHER_LIST(type) \
22 EV_WATCHER (type); \ 40 EV_WATCHER (type); \
23 struct type *next /* private */ 41 struct type *next /* private */
24 42
43#define EV_WATCHER_TIME(type) \
44 EV_WATCHER (type); \
45 ev_tstamp at /* private */
46
47/* base class, nothing to see here unless you subclass */
48struct ev_watcher {
49 EV_WATCHER (ev_watcher);
50};
51
52/* base class, nothing to see here unless you subclass */
53struct ev_watcher_list {
54 EV_WATCHER_LIST (ev_watcher_list);
55};
56
57/* base class, nothing to see here unless you subclass */
58struct ev_watcher_time {
59 EV_WATCHER_TIME (ev_watcher_time);
60};
61
62/* invoked after a specific time, repeatable (based on monotonic clock) */
25struct ev_timer 63struct ev_timer
26{ 64{
27 EV_WATCHER_LIST (ev_timer); 65 EV_WATCHER_TIME (ev_timer);
28 66
29 ev_tstamp at; /* private */
30 ev_tstamp repeat; /* rw */ 67 ev_tstamp repeat; /* rw */
31 unsigned char is_abs; /* ro */
32}; 68};
33 69
70/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
71struct ev_periodic
72{
73 EV_WATCHER_TIME (ev_periodic);
74
75 ev_tstamp interval; /* rw */
76};
77
78/* invoked when fd is either EV_READable or EV_WRITEable */
34struct ev_io 79struct ev_io
35{ 80{
36 EV_WATCHER_LIST (ev_io); 81 EV_WATCHER_LIST (ev_io);
37 82
38 int fd; /* ro */ 83 int fd; /* ro */
39 int events; /* ro */ 84 int events; /* ro */
40}; 85};
41 86
87/* invoked when the given signal has been received */
42struct ev_signal 88struct ev_signal
43{ 89{
44 EV_WATCHER_LIST (ev_signal); 90 EV_WATCHER_LIST (ev_signal);
45 91
46 int signum; /* ro */ 92 int signum; /* ro */
47}; 93};
48 94
95/* invoked when the nothing else needs to be done, keeps the process from blocking */
96struct ev_idle
97{
98 EV_WATCHER (ev_idle);
99};
100
101/* invoked for each run of the mainloop, just before the next blocking vall is initiated */
102struct ev_check
103{
104 EV_WATCHER (ev_check);
105};
106
49#define EVMETHOD_NONE 0 107#define EVMETHOD_NONE 0
50#define EVMETHOD_SELECT 1 108#define EVMETHOD_SELECT 1
51#define EVMETHOD_EPOLL 2 109#define EVMETHOD_EPOLL 2
52int ev_init (int flags); 110#if EV_PROTOTYPES
53extern int ev_method; 111extern int ev_method;
112int ev_init (int flags); /* returns ev_method */
54 113
114/* these three calls are suitable for plugging into pthread_atfork */
55void ev_prefork (void); 115void ev_prefork (void);
56void ev_postfork_parent (void); 116void ev_postfork_parent (void);
57void ev_postfork_child (void); 117void ev_postfork_child (void);
58 118
59extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 119extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
60ev_tstamp ev_time (void); 120ev_tstamp ev_time (void);
121#endif
61 122
62#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 123#define EVLOOP_NONBLOCK 1 /* do not block/wait */
63#define EVLOOP_ONESHOT 2 /* block *once* only */ 124#define EVLOOP_ONESHOT 2 /* block *once* only */
125#if EV_PROTOTYPES
64void ev_loop (int flags); 126void ev_loop (int flags);
65extern int ev_loop_done; /* set to 1 to break out of event loop */ 127extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
128
129/* convinience function, wait for a single event, without registering an event watcher */
130/* if timeout is < 0, do wait indefinitely */
131void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
132#endif
66 133
67/* these may evaluate ev multiple times, and the other arguments at most once */ 134/* these may evaluate ev multiple times, and the other arguments at most once */
135/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
68#define evw_init(ev,cb_,data_) do { (ev)->active = 0; (ev)->cb = (cb_); (ev)->data = (void *)data_; } while (0) 136#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
69 137
70#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 138#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
71#define evtimer_set_rel(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); (ev)->is_abs = 0; } while (0) 139#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
72#define evtimer_set_abs(ev,at_,repeat_) do { (ev)->at = (at_); (ev)->repeat = (repeat_); (ev)->is_abs = 1; } while (0) 140#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
73#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 141#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
142#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
143#define evidle_set(ev) /* nop, yes, this is a serious in-joke */
144
145#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
146#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
147#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
148#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
149#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
150#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
74 151
75#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 152#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
76 153
154/* stopping (enabling, adding) a watcher does nothing if it is already running */
155/* stopping (disabling, deleting) a watcher does nothing unless its already running */
156#if EV_PROTOTYPES
77void evio_start (struct ev_io *w); 157void evio_start (struct ev_io *w);
78void evio_stop (struct ev_io *w); 158void evio_stop (struct ev_io *w);
79 159
80void evtimer_start (struct ev_timer *w); 160void evtimer_start (struct ev_timer *w);
81void evtimer_stop (struct ev_timer *w); 161void evtimer_stop (struct ev_timer *w);
162void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
82 163
164void evperiodic_start (struct ev_periodic *w);
165void evperiodic_stop (struct ev_periodic *w);
166
83void evsignal_start (struct ev_signal *w); 167void evsignal_start (struct ev_signal *w);
84void evsignal_stop (struct ev_signal *w); 168void evsignal_stop (struct ev_signal *w);
169
170void evidle_start (struct ev_idle *w);
171void evidle_stop (struct ev_idle *w);
172
173void evcheck_start (struct ev_check *w);
174void evcheck_stop (struct ev_check *w);
175#endif
85 176
86#endif 177#endif
87 178

Diff Legend

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