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

Comparing libev/ev.h (file contents):
Revision 1.16 by root, Thu Nov 1 06:48:49 2007 UTC vs.
Revision 1.31 by root, Sun Nov 4 19:45:09 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
47#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1
49#endif
50
51/* support multiple event loops? */
52#if EV_MULTIPLICITY
53struct ev_loop;
54# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P,
56# define EV_A loop
57# define EV_A_ EV_A,
58#else
59# define EV_P void
60# define EV_P_
61# define EV_A
62# define EV_A_
63#endif
64
35/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x00 67#define EV_NONE 0x00
38#define EV_READ 0x01 68#define EV_READ 0x01
39#define EV_WRITE 0x02 69#define EV_WRITE 0x02
40#define EV_REIFY 0x04 /* private */
41#define EV_TIMEOUT 0x000100 70#define EV_TIMEOUT 0x000100
71#define EV_PERIODIC 0x000200
42#define EV_SIGNAL 0x000200 72#define EV_SIGNAL 0x000400
43#define EV_IDLE 0x000400 73#define EV_IDLE 0x000800
44#define EV_CHECK 0x000800 74#define EV_CHECK 0x001000
45#define EV_PREPARE 0x001000 75#define EV_PREPARE 0x002000
46#define EV_CHILD 0x002000 76#define EV_CHILD 0x004000
47#define EV_ERROR 0x800000 /* sent when an error occurs */ 77#define EV_ERROR 0x800000 /* sent when an error occurs */
48 78
49/* can be used to add custom fields to all watchers */ 79/* can be used to add custom fields to all watchers */
50#ifndef EV_COMMON 80#ifndef EV_COMMON
51# define EV_COMMON void *data 81# define EV_COMMON void *data
52#endif 82#endif
… …
66 96
67/* shared by all watchers */ 97/* shared by all watchers */
68#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
69 int active; /* private */ \ 99 int active; /* private */ \
70 int pending; /* private */ \ 100 int pending; /* private */ \
101 int priority; /* ro */ \
71 EV_COMMON; /* rw */ \ 102 EV_COMMON; /* rw */ \
72 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 103 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
73 104
74#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
75 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
76 struct type *next /* private */ 107 struct ev_watcher_list *next /* private */
77 108
78#define EV_WATCHER_TIME(type) \ 109#define EV_WATCHER_TIME(type) \
79 EV_WATCHER (type); \ 110 EV_WATCHER (type); \
80 ev_tstamp at /* private */ 111 ev_tstamp at /* private */
81 112
… …
93struct ev_watcher_time { 124struct ev_watcher_time {
94 EV_WATCHER_TIME (ev_watcher_time); 125 EV_WATCHER_TIME (ev_watcher_time);
95}; 126};
96 127
97/* invoked after a specific time, repeatable (based on monotonic clock) */ 128/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */
98struct ev_timer 130struct ev_timer
99{ 131{
100 EV_WATCHER_TIME (ev_timer); 132 EV_WATCHER_TIME (ev_timer);
101 133
102 ev_tstamp repeat; /* rw */ 134 ev_tstamp repeat; /* rw */
103}; 135};
104 136
105/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */
106struct ev_periodic 139struct ev_periodic
107{ 140{
108 EV_WATCHER_TIME (ev_periodic); 141 EV_WATCHER_TIME (ev_periodic);
109 142
110 ev_tstamp interval; /* rw */ 143 ev_tstamp interval; /* rw */
111}; 144};
112 145
113/* invoked when fd is either EV_READable or EV_WRITEable */ 146/* invoked when fd is either EV_READable or EV_WRITEable */
147/* revent EV_READ, EV_WRITE */
114struct ev_io 148struct ev_io
115{ 149{
116 EV_WATCHER_LIST (ev_io); 150 EV_WATCHER_LIST (ev_io);
117 151
118 int fd; /* ro */ 152 int fd; /* ro */
119 int events; /* ro */ 153 int events; /* ro */
120}; 154};
121 155
122/* invoked when the given signal has been received */ 156/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */
123struct ev_signal 158struct ev_signal
124{ 159{
125 EV_WATCHER_LIST (ev_signal); 160 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
126 164
127 int signum; /* ro */ 165 int signum; /* ro */
128}; 166};
129 167
130/* invoked when the nothing else needs to be done, keeps the process from blocking */ 168/* invoked when the nothing else needs to be done, keeps the process from blocking */
169/* revent EV_IDLE */
131struct ev_idle 170struct ev_idle
132{ 171{
133 EV_WATCHER (ev_idle); 172 EV_WATCHER (ev_idle);
134}; 173};
135 174
136/* invoked for each run of the mainloop, just before the blocking call */ 175/* invoked for each run of the mainloop, just before the blocking call */
137/* you can still change events in any way you like */ 176/* you can still change events in any way you like */
177/* revent EV_PREPARE */
138struct ev_prepare 178struct ev_prepare
139{ 179{
140 EV_WATCHER (ev_prepare); 180 EV_WATCHER (ev_prepare);
141}; 181};
142 182
143/* invoked for each run of the mainloop, just after the blocking call */ 183/* invoked for each run of the mainloop, just after the blocking call */
184/* revent EV_CHECK */
144struct ev_check 185struct ev_check
145{ 186{
146 EV_WATCHER (ev_check); 187 EV_WATCHER (ev_check);
147}; 188};
148 189
149/* invoked when sigchld is received and waitpid indicates the givne pid */ 190/* invoked when sigchld is received and waitpid indicates the givne pid */
191/* revent EV_CHILD */
192/* does not support priorities */
150struct ev_child 193struct ev_child
151{ 194{
152 EV_WATCHER_LIST (ev_child); 195 EV_WATCHER_LIST (ev_child);
153 196
154 int pid; /* ro */ 197 int pid; /* ro */
198 int rpid; /* rw, holds the received pid */
155 int status; /* rw, holds the exit status, use the macros from sys/wait.h */ 199 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
156}; 200};
157 201
158#define EVMETHOD_NONE 0 202#define EVMETHOD_AUTO 0 /* consults environment */
159#define EVMETHOD_SELECT 1 203#define EVMETHOD_SELECT 1
160#define EVMETHOD_EPOLL 2 204#define EVMETHOD_POLL 2
205#define EVMETHOD_EPOLL 4
206#define EVMETHOD_KQUEUE 8
207#define EVMETHOD_DEVPOLL 16 /* NYI */
208#define EVMETHOD_PORT 32 /* NYI */
209#define EVMETHOD_ANY ~0 /* any method, do not consult env */
210
161#if EV_PROTOTYPES 211#if EV_PROTOTYPES
162extern int ev_method;
163int ev_init (int flags); /* returns ev_method */
164int ev_version_major (void); 212int ev_version_major (void);
165int ev_version_minor (void); 213int ev_version_minor (void);
166 214
167/* these three calls are suitable for plugging into pthread_atfork */
168void ev_prefork (void);
169void ev_postfork_parent (void);
170void ev_postfork_child (void);
171
172extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
173ev_tstamp ev_time (void); 215ev_tstamp ev_time (void);
216
217# if EV_MULTIPLICITY
218/* the default loop is the only one that handles signals and child watchers */
219/* you can call this as often as you like */
220struct ev_loop *ev_default_loop (int methods); /* returns default loop */
221
222/* create and destroy alternative loops that don't handle signals */
223struct ev_loop *ev_loop_new (int methods);
224void ev_loop_destroy (EV_P);
225void ev_loop_fork (EV_P);
226# else
227int ev_default_loop (int methods); /* returns true when successful */
228# endif
229
230void ev_default_destroy (void); /* destroy the default loop */
231/* this needs to be called after fork, to duplicate the default loop */
232/* if you create alternative loops you have to call ev_loop_fork on them */
233/* you can call it in either the parent or the child */
234/* you can actually call it at any time, anywhere :) */
235void ev_default_fork (void);
236
237int ev_method (EV_P);
174#endif 238#endif
175 239
176#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 240#define EVLOOP_NONBLOCK 1 /* do not block/wait */
177#define EVLOOP_ONESHOT 2 /* block *once* only */ 241#define EVLOOP_ONESHOT 2 /* block *once* only */
242#define EVUNLOOP_ONCE 1 /* unloop once */
243#define EVUNLOOP_ALL 2 /* unloop all loops */
244
178#if EV_PROTOTYPES 245#if EV_PROTOTYPES
179void ev_loop (int flags); 246void ev_loop (EV_P_ int flags);
180extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 247void 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 */
248
249ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
250
251/*
252 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
253 * keeps one reference. if you have a long-runing watcher you never unregister that
254 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
255 */
256void ev_ref (EV_P);
257void ev_unref (EV_P);
181 258
182/* convinience function, wait for a single event, without registering an event watcher */ 259/* convinience function, wait for a single event, without registering an event watcher */
183/* if timeout is < 0, do wait indefinitely */ 260/* if timeout is < 0, do wait indefinitely */
184void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 261void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
185#endif 262#endif
186 263
187/* these may evaluate ev multiple times, and the other arguments at most once */ 264/* these may evaluate ev multiple times, and the other arguments at most once */
188/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 265/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
189#define ev_watcher_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) 266#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
190 267
191#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 268#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
192#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 269#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
193#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 270#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
194#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 271#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
… …
204#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 281#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
205#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 282#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
206#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 283#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
207#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 284#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
208 285
286#define ev_is_pending(ev) (0 + (ev)->pending) /* true when watcher is waiting for callback invocation */
209#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 287#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
288#define ev_set_priority(ev,pri) (ev)->priority = pri
210 289
211/* stopping (enabling, adding) a watcher does nothing if it is already running */ 290/* stopping (enabling, adding) a watcher does nothing if it is already running */
212/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 291/* stopping (disabling, deleting) a watcher does nothing unless its already running */
213#if EV_PROTOTYPES 292#if EV_PROTOTYPES
214void ev_io_start (struct ev_io *w); 293void ev_io_start (EV_P_ struct ev_io *w);
215void ev_io_stop (struct ev_io *w); 294void ev_io_stop (EV_P_ struct ev_io *w);
216 295
217void ev_timer_start (struct ev_timer *w); 296void ev_timer_start (EV_P_ struct ev_timer *w);
218void ev_timer_stop (struct ev_timer *w); 297void ev_timer_stop (EV_P_ struct ev_timer *w);
219void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 298/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
299void ev_timer_again (EV_P_ struct ev_timer *w);
220 300
221void ev_periodic_start (struct ev_periodic *w); 301void ev_periodic_start (EV_P_ struct ev_periodic *w);
222void ev_periodic_stop (struct ev_periodic *w); 302void ev_periodic_stop (EV_P_ struct ev_periodic *w);
223 303
224void ev_signal_start (struct ev_signal *w);
225void ev_signal_stop (struct ev_signal *w);
226
227void ev_idle_start (struct ev_idle *w); 304void ev_idle_start (EV_P_ struct ev_idle *w);
228void ev_idle_stop (struct ev_idle *w); 305void ev_idle_stop (EV_P_ struct ev_idle *w);
229 306
230void ev_prepare_start (struct ev_prepare *w); 307void ev_prepare_start (EV_P_ struct ev_prepare *w);
231void ev_prepare_stop (struct ev_prepare *w); 308void ev_prepare_stop (EV_P_ struct ev_prepare *w);
232 309
233void ev_check_start (struct ev_check *w); 310void ev_check_start (EV_P_ struct ev_check *w);
234void ev_check_stop (struct ev_check *w); 311void ev_check_stop (EV_P_ struct ev_check *w);
235 312
313/* only supported in the default loop */
314void ev_signal_start (EV_P_ struct ev_signal *w);
315void ev_signal_stop (EV_P_ struct ev_signal *w);
316
317/* only supported in the default loop */
236void ev_child_start (struct ev_child *w); 318void ev_child_start (EV_P_ struct ev_child *w);
237void ev_child_stop (struct ev_child *w); 319void ev_child_stop (EV_P_ struct ev_child *w);
238#endif 320#endif
239 321
322#ifdef __cplusplus
323}
240#endif 324#endif
241 325
326#endif
327

Diff Legend

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