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

Comparing libev/ev.h (file contents):
Revision 1.10 by root, Wed Oct 31 14:44:15 2007 UTC vs.
Revision 1.23 by root, Fri Nov 2 22:03:00 2007 UTC

… …
28 */ 28 */
29 29
30#ifndef EV_H 30#ifndef EV_H
31#define EV_H 31#define EV_H
32 32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
33typedef double ev_tstamp; 37typedef double ev_tstamp;
34 38
39/* these priorities are inclusive, higher priorities will be called earlier */
40#ifndef EV_MINPRI
41# define EV_MINPRI -2
42#endif
43#ifndef EV_MAXPRI
44# define EV_MAXPRI +2
45#endif
46
35/* eventmask, revents, events... */ 47/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 48#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x00 49#define EV_NONE 0x00
38#define EV_READ 0x01 50#define EV_READ 0x01
39#define EV_WRITE 0x02 51#define EV_WRITE 0x02
40#define EV_TIMEOUT 0x04 52#define EV_TIMEOUT 0x000100
53#define EV_PERIODIC 0x000200
41#define EV_SIGNAL 0x08 54#define EV_SIGNAL 0x000400
42#define EV_IDLE 0x10 55#define EV_IDLE 0x000800
43#define EV_CHECK 0x20 56#define EV_CHECK 0x001000
44#define EV_ERROR (0x3f|0x80) 57#define EV_PREPARE 0x002000
58#define EV_CHILD 0x004000
59#define EV_ERROR 0x800000 /* sent when an error occurs */
45 60
46/* can be used to add custom fields to all watchers */ 61/* can be used to add custom fields to all watchers */
47#ifndef EV_COMMON 62#ifndef EV_COMMON
48# define EV_COMMON void *data 63# define EV_COMMON void *data
49#endif 64#endif
50#ifndef EV_PROTOTYPES 65#ifndef EV_PROTOTYPES
51# define EV_PROTOTYPES 1 66# define EV_PROTOTYPES 1
52#endif 67#endif
68
69#define EV_VERSION_MAJOR 1
70#define EV_VERSION_MINOR 1
53 71
54/* 72/*
55 * struct member types: 73 * struct member types:
56 * private: you can look at them, but not change them, and they might not mean anything to you. 74 * private: you can look at them, but not change them, and they might not mean anything to you.
57 * ro: can be read anytime, but only changed when the watcher isn't active 75 * ro: can be read anytime, but only changed when the watcher isn't active
… …
60 78
61/* shared by all watchers */ 79/* shared by all watchers */
62#define EV_WATCHER(type) \ 80#define EV_WATCHER(type) \
63 int active; /* private */ \ 81 int active; /* private */ \
64 int pending; /* private */ \ 82 int pending; /* private */ \
83 int priority; /* ro */ \
65 EV_COMMON; /* rw */ \ 84 EV_COMMON; /* rw */ \
66 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 85 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
67 86
68#define EV_WATCHER_LIST(type) \ 87#define EV_WATCHER_LIST(type) \
69 EV_WATCHER (type); \ 88 EV_WATCHER (type); \
… …
87struct ev_watcher_time { 106struct ev_watcher_time {
88 EV_WATCHER_TIME (ev_watcher_time); 107 EV_WATCHER_TIME (ev_watcher_time);
89}; 108};
90 109
91/* invoked after a specific time, repeatable (based on monotonic clock) */ 110/* invoked after a specific time, repeatable (based on monotonic clock) */
111/* revent EV_TIMEOUT */
92struct ev_timer 112struct ev_timer
93{ 113{
94 EV_WATCHER_TIME (ev_timer); 114 EV_WATCHER_TIME (ev_timer);
95 115
96 ev_tstamp repeat; /* rw */ 116 ev_tstamp repeat; /* rw */
97}; 117};
98 118
99/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 119/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
120/* revent EV_PERIODIC */
100struct ev_periodic 121struct ev_periodic
101{ 122{
102 EV_WATCHER_TIME (ev_periodic); 123 EV_WATCHER_TIME (ev_periodic);
103 124
104 ev_tstamp interval; /* rw */ 125 ev_tstamp interval; /* rw */
105}; 126};
106 127
107/* invoked when fd is either EV_READable or EV_WRITEable */ 128/* invoked when fd is either EV_READable or EV_WRITEable */
129/* revent EV_READ, EV_WRITE */
108struct ev_io 130struct ev_io
109{ 131{
110 EV_WATCHER_LIST (ev_io); 132 EV_WATCHER_LIST (ev_io);
111 133
112 int fd; /* ro */ 134 int fd; /* ro */
113 int events; /* ro */ 135 int events; /* ro */
114}; 136};
115 137
116/* invoked when the given signal has been received */ 138/* invoked when the given signal has been received */
139/* revent EV_SIGNAL */
117struct ev_signal 140struct ev_signal
118{ 141{
119 EV_WATCHER_LIST (ev_signal); 142 EV_WATCHER_LIST (ev_signal);
120 143
121 int signum; /* ro */ 144 int signum; /* ro */
122}; 145};
123 146
124/* invoked when the nothing else needs to be done, keeps the process from blocking */ 147/* invoked when the nothing else needs to be done, keeps the process from blocking */
148/* revent EV_IDLE */
125struct ev_idle 149struct ev_idle
126{ 150{
127 EV_WATCHER (ev_idle); 151 EV_WATCHER (ev_idle);
128}; 152};
129 153
130/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 154/* invoked for each run of the mainloop, just before the blocking call */
155/* you can still change events in any way you like */
156/* revent EV_PREPARE */
157struct ev_prepare
158{
159 EV_WATCHER (ev_prepare);
160};
161
162/* invoked for each run of the mainloop, just after the blocking call */
163/* revent EV_CHECK */
131struct ev_check 164struct ev_check
132{ 165{
133 EV_WATCHER (ev_check); 166 EV_WATCHER (ev_check);
134}; 167};
135 168
136#define EVMETHOD_NONE 0 169/* invoked when sigchld is received and waitpid indicates the givne pid */
170/* revent EV_CHILD */
171struct ev_child
172{
173 EV_WATCHER_LIST (ev_child);
174
175 int pid; /* ro */
176 int status; /* rw, holds the exit status, use the macros from sys/wait.h */
177};
178
179#define EVMETHOD_AUTO 0 /* consults environment */
137#define EVMETHOD_SELECT 1 180#define EVMETHOD_SELECT 1
138#define EVMETHOD_EPOLL 2 181#define EVMETHOD_POLL 2
182#define EVMETHOD_EPOLL 4
183#define EVMETHOD_KQUEUE 8
184#define EVMETHOD_DEVPOLL 16 /* NYI */
185#define EVMETHOD_PORT 32 /* NYI */
186#define EVMETHOD_ANY ~0 /* any method, do not consult env */
139#if EV_PROTOTYPES 187#if EV_PROTOTYPES
140extern int ev_method; 188extern int ev_method;
141int ev_init (int flags); /* returns ev_method */ 189int ev_init (int methods); /* returns ev_method */
190int ev_version_major (void);
191int ev_version_minor (void);
142 192
143/* these three calls are suitable for plugging into pthread_atfork */ 193/* these three calls are suitable for plugging into pthread_atfork */
144void ev_prefork (void); 194void ev_fork_prepare (void);
145void ev_postfork_parent (void); 195void ev_fork_parent (void);
146void ev_postfork_child (void); 196void ev_fork_child (void);
147 197
148extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 198extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
149ev_tstamp ev_time (void); 199ev_tstamp ev_time (void);
150#endif 200#endif
151 201
… …
159/* if timeout is < 0, do wait indefinitely */ 209/* if timeout is < 0, do wait indefinitely */
160void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 210void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
161#endif 211#endif
162 212
163/* these may evaluate ev multiple times, and the other arguments at most once */ 213/* these may evaluate ev multiple times, and the other arguments at most once */
164/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 214/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
165#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) 215#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
166 216
167#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 217#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
168#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 218#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
169#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 219#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
170#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 220#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
171#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
172#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ 221#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
222#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
223#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
224#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
173 225
174#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 226#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
175#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 227#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
176#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 228#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
177#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 229#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
230#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
231#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
178#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 232#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
179#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 233#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
180 234
181#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 235#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
236#define ev_set_priority(ev,pri) (ev)->priority = pri
182 237
183/* stopping (enabling, adding) a watcher does nothing if it is already running */ 238/* stopping (enabling, adding) a watcher does nothing if it is already running */
184/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 239/* stopping (disabling, deleting) a watcher does nothing unless its already running */
185#if EV_PROTOTYPES 240#if EV_PROTOTYPES
186void evio_start (struct ev_io *w); 241void ev_io_start (struct ev_io *w);
187void evio_stop (struct ev_io *w); 242void ev_io_stop (struct ev_io *w);
188 243
189void evtimer_start (struct ev_timer *w); 244void ev_timer_start (struct ev_timer *w);
190void evtimer_stop (struct ev_timer *w); 245void ev_timer_stop (struct ev_timer *w);
191void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 246void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
192 247
193void evperiodic_start (struct ev_periodic *w); 248void ev_periodic_start (struct ev_periodic *w);
194void evperiodic_stop (struct ev_periodic *w); 249void ev_periodic_stop (struct ev_periodic *w);
195 250
196void evsignal_start (struct ev_signal *w); 251void ev_signal_start (struct ev_signal *w);
197void evsignal_stop (struct ev_signal *w); 252void ev_signal_stop (struct ev_signal *w);
198 253
199void evidle_start (struct ev_idle *w); 254void ev_idle_start (struct ev_idle *w);
200void evidle_stop (struct ev_idle *w); 255void ev_idle_stop (struct ev_idle *w);
201 256
257void ev_prepare_start (struct ev_prepare *w);
258void ev_prepare_stop (struct ev_prepare *w);
259
202void evcheck_start (struct ev_check *w); 260void ev_check_start (struct ev_check *w);
203void evcheck_stop (struct ev_check *w); 261void ev_check_stop (struct ev_check *w);
204#endif
205 262
263void ev_child_start (struct ev_child *w);
264void ev_child_stop (struct ev_child *w);
206#endif 265#endif
207 266
267#ifdef __cplusplus
268}
269#endif
270
271#endif
272

Diff Legend

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