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

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

Diff Legend

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