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.62 by root, Thu Nov 22 12:28:27 2007 UTC

… …
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 28 */
29 29
30#ifndef EV_H 30#ifndef EV_H__
31#define EV_H 31#define EV_H__
32
33#ifdef __cplusplus
34extern "C" {
35#endif
32 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#ifndef EV_PERIODICS
52# define EV_PERIODICS 1
53#endif
54
55/* support multiple event loops? */
56#if EV_MULTIPLICITY
57struct ev_loop;
58# define EV_P struct ev_loop *loop
59# define EV_P_ EV_P,
60# define EV_A loop
61# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A,
64#else
65# define EV_P void
66# define EV_P_
67# define EV_A
68# define EV_A_
69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_
71#endif
72
35/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x00 75#define EV_NONE 0x00
38#define EV_READ 0x01 76#define EV_READ 0x01 /* io only */
39#define EV_WRITE 0x02 77#define EV_WRITE 0x02 /* io only */
40#define EV_TIMEOUT 0x04 78#define EV_TIMEOUT 0x000100 /* timer only */
41#define EV_SIGNAL 0x08 79#define EV_PERIODIC 0x000200 /* periodic timer only */
42#define EV_IDLE 0x10 80#define EV_SIGNAL 0x000400 /* signal only */
43#define EV_CHECK 0x20 81#define EV_IDLE 0x000800 /* idle only */
44#define EV_ERROR (0x3f|0x80) 82#define EV_CHECK 0x001000 /* check only */
83#define EV_PREPARE 0x002000 /* prepare only */
84#define EV_CHILD 0x004000 /* child/pid only */
85#define EV_ERROR 0x800000 /* sent when an error occurs */
45 86
46/* can be used to add custom fields to all watchers */ 87/* can be used to add custom fields to all watchers, while losing binary compatibility */
47#ifndef EV_COMMON 88#ifndef EV_COMMON
48# define EV_COMMON void *data 89# define EV_COMMON void *data;
49#endif 90#endif
50#ifndef EV_PROTOTYPES 91#ifndef EV_PROTOTYPES
51# define EV_PROTOTYPES 1 92# define EV_PROTOTYPES 1
93#endif
94
95#define EV_VERSION_MAJOR 1
96#define EV_VERSION_MINOR 1
97
98#ifndef EV_CB_DECLARE
99# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
100#endif
101#ifndef EV_CB_INVOKE
102# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
52#endif 103#endif
53 104
54/* 105/*
55 * struct member types: 106 * struct member types:
56 * private: you can look at them, but not change them, and they might not mean anything to you. 107 * private: you can look at them, but not change them, and they might not mean anything to you.
… …
60 111
61/* shared by all watchers */ 112/* shared by all watchers */
62#define EV_WATCHER(type) \ 113#define EV_WATCHER(type) \
63 int active; /* private */ \ 114 int active; /* private */ \
64 int pending; /* private */ \ 115 int pending; /* private */ \
116 int priority; /* private */ \
65 EV_COMMON; /* rw */ \ 117 EV_COMMON /* rw */ \
66 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 118 EV_CB_DECLARE (type) /* private */
67 119
68#define EV_WATCHER_LIST(type) \ 120#define EV_WATCHER_LIST(type) \
69 EV_WATCHER (type); \ 121 EV_WATCHER (type) \
70 struct type *next /* private */ 122 struct ev_watcher_list *next; /* private */
71 123
72#define EV_WATCHER_TIME(type) \ 124#define EV_WATCHER_TIME(type) \
73 EV_WATCHER (type); \ 125 EV_WATCHER (type) \
74 ev_tstamp at /* private */ 126 ev_tstamp at; /* private */
75 127
76/* base class, nothing to see here unless you subclass */ 128/* base class, nothing to see here unless you subclass */
77struct ev_watcher { 129struct ev_watcher
130{
78 EV_WATCHER (ev_watcher); 131 EV_WATCHER (ev_watcher)
79}; 132};
80 133
81/* base class, nothing to see here unless you subclass */ 134/* base class, nothing to see here unless you subclass */
82struct ev_watcher_list { 135struct ev_watcher_list
136{
83 EV_WATCHER_LIST (ev_watcher_list); 137 EV_WATCHER_LIST (ev_watcher_list)
84}; 138};
85 139
86/* base class, nothing to see here unless you subclass */ 140/* base class, nothing to see here unless you subclass */
87struct ev_watcher_time { 141struct ev_watcher_time
142{
88 EV_WATCHER_TIME (ev_watcher_time); 143 EV_WATCHER_TIME (ev_watcher_time)
89}; 144};
90 145
91/* invoked after a specific time, repeatable (based on monotonic clock) */ 146/* invoked after a specific time, repeatable (based on monotonic clock) */
147/* revent EV_TIMEOUT */
92struct ev_timer 148struct ev_timer
93{ 149{
94 EV_WATCHER_TIME (ev_timer); 150 EV_WATCHER_TIME (ev_timer)
95 151
96 ev_tstamp repeat; /* rw */ 152 ev_tstamp repeat; /* rw */
97}; 153};
98 154
99/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 155/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
156/* revent EV_PERIODIC */
100struct ev_periodic 157struct ev_periodic
101{ 158{
102 EV_WATCHER_TIME (ev_periodic); 159 EV_WATCHER_TIME (ev_periodic)
103 160
104 ev_tstamp interval; /* rw */ 161 ev_tstamp interval; /* rw */
162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
105}; 163};
106 164
107/* invoked when fd is either EV_READable or EV_WRITEable */ 165/* invoked when fd is either EV_READable or EV_WRITEable */
166/* revent EV_READ, EV_WRITE */
108struct ev_io 167struct ev_io
109{ 168{
110 EV_WATCHER_LIST (ev_io); 169 EV_WATCHER_LIST (ev_io)
111 170
112 int fd; /* ro */ 171 int fd; /* ro */
113 int events; /* ro */ 172 int events; /* ro */
114}; 173};
115 174
116/* invoked when the given signal has been received */ 175/* invoked when the given signal has been received */
176/* revent EV_SIGNAL */
117struct ev_signal 177struct ev_signal
118{ 178{
119 EV_WATCHER_LIST (ev_signal); 179 EV_WATCHER_LIST (ev_signal)
120 180
121 int signum; /* ro */ 181 int signum; /* ro */
122}; 182};
123 183
124/* invoked when the nothing else needs to be done, keeps the process from blocking */ 184/* invoked when the nothing else needs to be done, keeps the process from blocking */
185/* revent EV_IDLE */
125struct ev_idle 186struct ev_idle
126{ 187{
127 EV_WATCHER (ev_idle); 188 EV_WATCHER (ev_idle)
128}; 189};
129 190
130/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 191/* invoked for each run of the mainloop, just before the blocking call */
192/* you can still change events in any way you like */
193/* revent EV_PREPARE */
194struct ev_prepare
195{
196 EV_WATCHER (ev_prepare)
197};
198
199/* invoked for each run of the mainloop, just after the blocking call */
200/* revent EV_CHECK */
131struct ev_check 201struct ev_check
132{ 202{
133 EV_WATCHER (ev_check); 203 EV_WATCHER (ev_check)
134}; 204};
135 205
136#define EVMETHOD_NONE 0 206/* invoked when sigchld is received and waitpid indicates the given pid */
137#define EVMETHOD_SELECT 1 207/* revent EV_CHILD */
138#define EVMETHOD_EPOLL 2 208/* does not support priorities */
209struct ev_child
210{
211 EV_WATCHER_LIST (ev_child)
212
213 int pid; /* ro */
214 int rpid; /* rw, holds the received pid */
215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
216};
217
218/* the presence of this union forces similar struct layout */
219union ev_any_watcher
220{
221 struct ev_watcher w;
222 struct ev_watcher_list wl;
223
224 struct ev_io io;
225 struct ev_timer timer;
226 struct ev_periodic periodic;
227 struct ev_idle idle;
228 struct ev_prepare prepare;
229 struct ev_check check;
230 struct ev_signal signal;
231 struct ev_child child;
232};
233
234/* bits for ev_default_loop and ev_loop_new */
235/* the default */
236#define EVFLAG_AUTO 0x00000000 /* not quite a mask */
237
238/* method bits to be ored together */
239#define EVMETHOD_SELECT 0x00000001 /* about anywhere */
240#define EVMETHOD_POLL 0x00000002 /* !win */
241#define EVMETHOD_EPOLL 0x00000004 /* linux */
242#define EVMETHOD_KQUEUE 0x00000008 /* bsd */
243#define EVMETHOD_DEVPOLL 0x00000010 /* solaris 8 */ /* NYI */
244#define EVMETHOD_PORT 0x00000020 /* solaris 10 */
245#define EVMETHOD_ALL 0x0000ffff /* all methods, also future ones, or so */
246
247/* flag bits */
248#define EVFLAG_NOENV 0x01000000 /* do NOT consult environment */
249
139#if EV_PROTOTYPES 250#if EV_PROTOTYPES
140extern int ev_method; 251int ev_version_major (void);
141int ev_init (int flags); /* returns ev_method */ 252int ev_version_minor (void);
142 253
143/* these three calls are suitable for plugging into pthread_atfork */
144void ev_prefork (void);
145void ev_postfork_parent (void);
146void ev_postfork_child (void);
147
148extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
149ev_tstamp ev_time (void); 254ev_tstamp ev_time (void);
255
256/* Sets the allocation function to use, works like realloc.
257 * It is used to allocate and free memory.
258 * If it returns zero when memory needs to be allocated, the library might abort
259 * or take some potentially destructive action.
260 * The default is your system realloc function.
261 */
262void ev_set_allocator (void *(*cb)(void *ptr, long size));
263
264/* set the callback function to call on a
265 * retryable syscall error
266 * (such as failed select, poll, epoll_wait)
267 */
268void ev_set_syserr_cb (void (*cb)(const char *msg));
269
270# if EV_MULTIPLICITY
271/* the default loop is the only one that handles signals and child watchers */
272/* you can call this as often as you like */
273static struct ev_loop *
274ev_default_loop (unsigned int flags)
275{
276 extern struct ev_loop *ev_default_loop_ptr;
277 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
278
279 if (!ev_default_loop_ptr)
280 ev_default_loop_init (flags);
281
282 return ev_default_loop_ptr;
283}
284
285/* create and destroy alternative loops that don't handle signals */
286struct ev_loop *ev_loop_new (unsigned int flags);
287void ev_loop_destroy (EV_P);
288void ev_loop_fork (EV_P);
289
290ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
291
292# else
293
294int ev_default_loop (unsigned int flags); /* returns true when successful */
295
296static ev_tstamp
297ev_now (void)
298{
299 extern ev_tstamp ev_rt_now;
300
301 return ev_rt_now;
302}
303# endif
304
305void ev_default_destroy (void); /* destroy the default loop */
306/* this needs to be called after fork, to duplicate the default loop */
307/* if you create alternative loops you have to call ev_loop_fork on them */
308/* you can call it in either the parent or the child */
309/* you can actually call it at any time, anywhere :) */
310void ev_default_fork (void);
311
312unsigned int ev_method (EV_P);
150#endif 313#endif
151 314
152#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 315#define EVLOOP_NONBLOCK 1 /* do not block/wait */
153#define EVLOOP_ONESHOT 2 /* block *once* only */ 316#define EVLOOP_ONESHOT 2 /* block *once* only */
317#define EVUNLOOP_ONE 1 /* unloop once */
318#define EVUNLOOP_ALL 2 /* unloop all loops */
319
154#if EV_PROTOTYPES 320#if EV_PROTOTYPES
155void ev_loop (int flags); 321void ev_loop (EV_P_ int flags);
156extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 322void 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 */
323
324/*
325 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
326 * keeps one reference. if you have a long-runing watcher you never unregister that
327 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
328 */
329void ev_ref (EV_P);
330void ev_unref (EV_P);
157 331
158/* convinience function, wait for a single event, without registering an event watcher */ 332/* convinience function, wait for a single event, without registering an event watcher */
159/* if timeout is < 0, do wait indefinitely */ 333/* 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); 334void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
161#endif 335#endif
162 336
163/* these may evaluate ev multiple times, and the other arguments at most once */ 337/* 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 */ 338/* either use ev_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) 339#define ev_init(ev,cb_) do { \
340 ((struct ev_watcher *)(void *)(ev))->active = \
341 ((struct ev_watcher *)(void *)(ev))->pending = \
342 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
343 ev_set_cb ((ev), cb_); \
344} while (0)
166 345
167#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 346#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) 347#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) 348#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
170#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 349#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 */ 350#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
351#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
352#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
353#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
173 354
174#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 355#define ev_io_init(ev,cb,fd,events) do { ev_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) 356#define ev_timer_init(ev,cb,after,repeat) do { ev_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) 357#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
177#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 358#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
359#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
360#define ev_prepare_init(ev,cb) do { ev_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) 361#define ev_check_init(ev,cb) do { ev_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) 362#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
180 363
364#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
181#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 365#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
366
367#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
368#define ev_cb(ev) (ev)->cb /* rw */
369#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
370
371#ifndef ev_set_cb
372# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
373#endif
182 374
183/* stopping (enabling, adding) a watcher does nothing if it is already running */ 375/* stopping (enabling, adding) a watcher does nothing if it is already running */
184/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 376/* stopping (disabling, deleting) a watcher does nothing unless its already running */
185#if EV_PROTOTYPES 377#if EV_PROTOTYPES
378
379/* feeds an event into a watcher as if the event actually occured */
380/* accepts any ev_watcher type */
381void ev_feed_event (EV_P_ void *w, int revents);
382void ev_feed_fd_event (EV_P_ int fd, int revents);
383void ev_feed_signal_event (EV_P_ int signum);
384
186void evio_start (struct ev_io *w); 385void ev_io_start (EV_P_ struct ev_io *w);
187void evio_stop (struct ev_io *w); 386void ev_io_stop (EV_P_ struct ev_io *w);
188 387
189void evtimer_start (struct ev_timer *w); 388void ev_timer_start (EV_P_ struct ev_timer *w);
190void evtimer_stop (struct ev_timer *w); 389void ev_timer_stop (EV_P_ 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 */ 390/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
391void ev_timer_again (EV_P_ struct ev_timer *w);
192 392
393#if EV_PERIODICS
193void evperiodic_start (struct ev_periodic *w); 394void ev_periodic_start (EV_P_ struct ev_periodic *w);
194void evperiodic_stop (struct ev_periodic *w); 395void ev_periodic_stop (EV_P_ struct ev_periodic *w);
396void ev_periodic_again (EV_P_ struct ev_periodic *w);
397#endif
195 398
399void ev_idle_start (EV_P_ struct ev_idle *w);
400void ev_idle_stop (EV_P_ struct ev_idle *w);
401
402void ev_prepare_start (EV_P_ struct ev_prepare *w);
403void ev_prepare_stop (EV_P_ struct ev_prepare *w);
404
405void ev_check_start (EV_P_ struct ev_check *w);
406void ev_check_stop (EV_P_ struct ev_check *w);
407
408/* only supported in the default loop */
196void evsignal_start (struct ev_signal *w); 409void ev_signal_start (EV_P_ struct ev_signal *w);
197void evsignal_stop (struct ev_signal *w); 410void ev_signal_stop (EV_P_ struct ev_signal *w);
198 411
412/* only supported in the default loop */
199void evidle_start (struct ev_idle *w); 413void ev_child_start (EV_P_ struct ev_child *w);
200void evidle_stop (struct ev_idle *w); 414void ev_child_stop (EV_P_ struct ev_child *w);
201
202void evcheck_start (struct ev_check *w);
203void evcheck_stop (struct ev_check *w);
204#endif 415#endif
205 416
417#ifdef __cplusplus
418}
206#endif 419#endif
207 420
421#endif
422

Diff Legend

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