]> git.llucax.com Git - software/libev.git/blob - ev.h
*** empty log message ***
[software/libev.git] / ev.h
1 /*
2  * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  *       notice, this list of conditions and the following disclaimer.
11  *
12  *     * Redistributions in binary form must reproduce the above
13  *       copyright notice, this list of conditions and the following
14  *       disclaimer in the documentation and/or other materials provided
15  *       with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
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.
28  */
29
30 #ifndef EV_H__
31 #define EV_H__
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 typedef double ev_tstamp;
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_PERIODIC_ENABLE
52 # define EV_PERIODIC_ENABLE 1
53 #endif
54
55 #ifndef EV_STAT_ENABLE
56 # define EV_STAT_ENABLE 1
57 #endif
58
59 #ifndef EV_FORK_ENABLE
60 # define EV_FORK_ENABLE 1
61 #endif
62
63 #ifndef EV_EMBED_ENABLE
64 # define EV_EMBED_ENABLE 1
65 #endif
66
67 /*****************************************************************************/
68
69 #if EV_STAT_ENABLE
70 # include <sys/stat.h>
71 #endif
72
73 /* support multiple event loops? */
74 #if EV_MULTIPLICITY
75 struct ev_loop;
76 # define EV_P struct ev_loop *loop
77 # define EV_P_ EV_P,
78 # define EV_A loop
79 # define EV_A_ EV_A,
80 # define EV_DEFAULT ev_default_loop (0)
81 # define EV_DEFAULT_ EV_DEFAULT,
82 #else
83 # define EV_P void
84 # define EV_P_
85 # define EV_A
86 # define EV_A_
87 # define EV_DEFAULT
88 # define EV_DEFAULT_
89
90 # undef EV_EMBED_ENABLE
91 #endif
92
93 /* eventmask, revents, events... */
94 #define EV_UNDEF            -1L /* guaranteed to be invalid */
95 #define EV_NONE           0x00L /* no events */
96 #define EV_READ           0x01L /* ev_io detected read will not block */
97 #define EV_WRITE          0x02L /* ev_io detected write will not block */
98 #define EV_TIMEOUT  0x00000100L /* timer timed out */
99 #define EV_PERIODIC 0x00000200L /* periodic timer timed out */
100 #define EV_SIGNAL   0x00000400L /* signal was received */
101 #define EV_CHILD    0x00000800L /* child/pid had status change */
102 #define EV_STAT     0x00001000L /* stat data changed */
103 #define EV_IDLE     0x00002000L /* event loop is idling */
104 #define EV_PREPARE  0x00004000L /* event loop about to poll */
105 #define EV_CHECK    0x00008000L /* event loop finished poll */
106 #define EV_EMBED    0x00010000L /* embedded event loop needs sweep */
107 #define EV_FORK     0x00020000L /* event loop resumed in child */
108 #define EV_ERROR    0x80000000L /* sent when an error occurs */
109
110 /* can be used to add custom fields to all watchers, while losing binary compatibility */
111 #ifndef EV_COMMON
112 # define EV_COMMON void *data;
113 #endif
114 #ifndef EV_PROTOTYPES
115 # define EV_PROTOTYPES 1
116 #endif
117
118 #define EV_VERSION_MAJOR 1
119 #define EV_VERSION_MINOR 1
120
121 #ifndef EV_CB_DECLARE
122 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
123 #endif
124 #ifndef EV_CB_INVOKE
125 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
126 #endif
127
128 /*
129  * struct member types:
130  * private: you can look at them, but not change them, and they might not mean anything to you.
131  * ro: can be read anytime, but only changed when the watcher isn't active
132  * rw: can be read and modified anytime, even when the watcher is active
133  */
134
135 /* shared by all watchers */
136 #define EV_WATCHER(type)                        \
137   int active; /* private */                     \
138   int pending; /* private */                    \
139   int priority; /* private */                   \
140   EV_COMMON /* rw */                            \
141   EV_CB_DECLARE (type) /* private */
142
143 #define EV_WATCHER_LIST(type)                   \
144   EV_WATCHER (type)                             \
145   struct ev_watcher_list *next; /* private */
146
147 #define EV_WATCHER_TIME(type)                   \
148   EV_WATCHER (type)                             \
149   ev_tstamp at;     /* private */
150
151 /* base class, nothing to see here unless you subclass */
152 typedef struct ev_watcher
153 {
154   EV_WATCHER (ev_watcher)
155 } ev_watcher;
156
157 /* base class, nothing to see here unless you subclass */
158 typedef struct ev_watcher_list
159 {
160   EV_WATCHER_LIST (ev_watcher_list)
161 } ev_watcher_list;
162
163 /* base class, nothing to see here unless you subclass */
164 typedef struct ev_watcher_time
165 {
166   EV_WATCHER_TIME (ev_watcher_time)
167 } ev_watcher_time;
168
169 /* invoked when fd is either EV_READable or EV_WRITEable */
170 /* revent EV_READ, EV_WRITE */
171 typedef struct ev_io
172 {
173   EV_WATCHER_LIST (ev_io)
174
175   int fd;     /* ro */
176   int events; /* ro */
177 } ev_io;
178
179 /* invoked after a specific time, repeatable (based on monotonic clock) */
180 /* revent EV_TIMEOUT */
181 typedef struct ev_timer
182 {
183   EV_WATCHER_TIME (ev_timer)
184
185   ev_tstamp repeat; /* rw */
186 } ev_timer;
187
188 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
189 /* revent EV_PERIODIC */
190 typedef struct ev_periodic
191 {
192   EV_WATCHER_TIME (ev_periodic)
193
194   ev_tstamp interval; /* rw */
195   ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
196 } ev_periodic;
197
198 /* invoked when the given signal has been received */
199 /* revent EV_SIGNAL */
200 typedef struct ev_signal
201 {
202   EV_WATCHER_LIST (ev_signal)
203
204   int signum; /* ro */
205 } ev_signal;
206
207 /* invoked when sigchld is received and waitpid indicates the given pid */
208 /* revent EV_CHILD */
209 /* does not support priorities */
210 typedef struct ev_child
211 {
212   EV_WATCHER_LIST (ev_child)
213
214   int pid;     /* ro */
215   int rpid;    /* rw, holds the received pid */
216   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
217 } ev_child;
218
219 #if EV_STAT_ENABLE
220 /* st_nlink = 0 means missing file or other error */
221 #ifdef _WIN32
222 typedef struct _stati64 ev_statdata;
223 #else
224 typedef struct stat ev_statdata;
225 #endif
226
227 /* invoked each time the stat data changes for a given path */
228 /* revent EV_STAT */
229 typedef struct ev_stat
230 {
231   EV_WATCHER (ev_stat)
232
233   ev_timer timer;     /* private */
234   ev_tstamp interval; /* ro */
235   const char *path;   /* ro */
236   ev_statdata prev;   /* ro */
237   ev_statdata attr;   /* ro */
238 } ev_stat;
239 #endif
240
241 /* invoked when the nothing else needs to be done, keeps the process from blocking */
242 /* revent EV_IDLE */
243 typedef struct ev_idle
244 {
245   EV_WATCHER (ev_idle)
246 } ev_idle;
247
248 /* invoked for each run of the mainloop, just before the blocking call */
249 /* you can still change events in any way you like */
250 /* revent EV_PREPARE */
251 typedef struct ev_prepare
252 {
253   EV_WATCHER (ev_prepare)
254 } ev_prepare;
255
256 /* invoked for each run of the mainloop, just after the blocking call */
257 /* revent EV_CHECK */
258 typedef struct ev_check
259 {
260   EV_WATCHER (ev_check)
261 } ev_check;
262
263 #if EV_FORK_ENABLE
264 /* the callback gets invoked before check in the child process when a fork was detected */
265 typedef struct ev_fork
266 {
267   EV_WATCHER (ev_fork)
268 } ev_fork;
269 #endif
270
271 #if EV_EMBED_ENABLE
272 /* used to embed an event loop inside another */
273 /* the callback gets invoked when the event loop has handled events, and can be 0 */
274 typedef struct ev_embed
275 {
276   EV_WATCHER (ev_embed)
277
278   ev_io io; /* private */
279   struct ev_loop *loop; /* ro */
280 } ev_embed;
281 #endif
282
283 /* the presence of this union forces similar struct layout */
284 union ev_any_watcher
285 {
286   struct ev_watcher w;
287   struct ev_watcher_list wl;
288
289   struct ev_io io;
290   struct ev_timer timer;
291   struct ev_periodic periodic;
292   struct ev_signal signal;
293   struct ev_child child;
294 #if EV_STAT_ENABLE
295   struct ev_stat stat;
296 #endif
297   struct ev_idle idle;
298   struct ev_prepare prepare;
299   struct ev_check check;
300 #if EV_FORK_ENABLE
301   struct ev_fork fork;
302 #endif
303 #if EV_EMBED_ENABLE
304   struct ev_embed embed;
305 #endif
306 };
307
308 /* bits for ev_default_loop and ev_loop_new */
309 /* the default */
310 #define EVFLAG_AUTO       0x00000000UL /* not quite a mask */
311 /* flag bits */
312 #define EVFLAG_NOENV      0x01000000UL /* do NOT consult environment */
313 /* method bits to be ored together */
314 #define EVBACKEND_SELECT  0x00000001UL /* about anywhere */
315 #define EVBACKEND_POLL    0x00000002UL /* !win */
316 #define EVBACKEND_EPOLL   0x00000004UL /* linux */
317 #define EVBACKEND_KQUEUE  0x00000008UL /* bsd */
318 #define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
319 #define EVBACKEND_PORT    0x00000020UL /* solaris 10 */
320
321 #if EV_PROTOTYPES
322 int ev_version_major (void);
323 int ev_version_minor (void);
324
325 unsigned int ev_supported_backends (void);
326 unsigned int ev_recommended_backends (void);
327 unsigned int ev_embeddable_backends (void);
328
329 ev_tstamp ev_time (void);
330
331 /* Sets the allocation function to use, works like realloc.
332  * It is used to allocate and free memory.
333  * If it returns zero when memory needs to be allocated, the library might abort
334  * or take some potentially destructive action.
335  * The default is your system realloc function.
336  */
337 void ev_set_allocator (void *(*cb)(void *ptr, long size));
338
339 /* set the callback function to call on a
340  * retryable syscall error
341  * (such as failed select, poll, epoll_wait)
342  */
343 void ev_set_syserr_cb (void (*cb)(const char *msg));
344
345 # if EV_MULTIPLICITY
346 /* the default loop is the only one that handles signals and child watchers */
347 /* you can call this as often as you like */
348 static struct ev_loop *
349 ev_default_loop (unsigned int flags)
350 {
351   extern struct ev_loop *ev_default_loop_ptr;
352   extern struct ev_loop *ev_default_loop_init (unsigned int flags);
353
354   if (!ev_default_loop_ptr)
355     ev_default_loop_init (flags);
356
357   return ev_default_loop_ptr;
358 }
359
360 /* create and destroy alternative loops that don't handle signals */
361 struct ev_loop *ev_loop_new (unsigned int flags);
362 void ev_loop_destroy (EV_P);
363 void ev_loop_fork (EV_P);
364
365 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
366
367 # else
368
369 int ev_default_loop (unsigned int flags); /* returns true when successful */
370
371 static ev_tstamp
372 ev_now (void)
373 {
374   extern ev_tstamp ev_rt_now;
375
376   return ev_rt_now;
377 }
378 # endif
379
380 void ev_default_destroy (void); /* destroy the default loop */
381 /* this needs to be called after fork, to duplicate the default loop */
382 /* if you create alternative loops you have to call ev_loop_fork on them */
383 /* you can call it in either the parent or the child */
384 /* you can actually call it at any time, anywhere :) */
385 void ev_default_fork (void);
386
387 unsigned int ev_backend (EV_P);
388 #endif
389
390 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
391 #define EVLOOP_ONESHOT  2 /* block *once* only */
392 #define EVUNLOOP_CANCEL 0 /* undo unloop */
393 #define EVUNLOOP_ONE    1 /* unloop once */
394 #define EVUNLOOP_ALL    2 /* unloop all loops */
395
396 #if EV_PROTOTYPES
397 void ev_loop (EV_P_ int flags);
398 void 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 */
399
400 /*
401  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
402  * keeps one reference. if you have a long-runing watcher you never unregister that
403  * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
404  */
405 void ev_ref   (EV_P);
406 void ev_unref (EV_P);
407
408 /* convinience function, wait for a single event, without registering an event watcher */
409 /* if timeout is < 0, do wait indefinitely */
410 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
411 #endif
412
413 /* these may evaluate ev multiple times, and the other arguments at most once */
414 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
415 #define ev_init(ev,cb_) do {                            \
416   ((ev_watcher *)(void *)(ev))->active   =      \
417   ((ev_watcher *)(void *)(ev))->pending  =      \
418   ((ev_watcher *)(void *)(ev))->priority = 0;   \
419   ev_set_cb ((ev), cb_);                                        \
420 } while (0)
421
422 #define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
423 #define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
424 #define ev_periodic_set(ev,at_,ival_,res_)  do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
425 #define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
426 #define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
427 #define ev_stat_set(ev,path_,interval_)     do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0)
428 #define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
429 #define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
430 #define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */
431 #define ev_embed_set(ev,loop_)              do { (ev)->loop = (loop_); } while (0)
432 #define ev_fork_set(ev)                     /* nop, yes, this is a serious in-joke */
433
434 #define ev_io_init(ev,cb,fd,events)         do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
435 #define ev_timer_init(ev,cb,after,repeat)   do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
436 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
437 #define ev_signal_init(ev,cb,signum)        do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
438 #define ev_child_init(ev,cb,pid)            do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
439 #define ev_stat_init(ev,cb,path,interval)   do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
440 #define ev_idle_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
441 #define ev_prepare_init(ev,cb)              do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
442 #define ev_check_init(ev,cb)                do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
443 #define ev_embed_init(ev,cb,loop)           do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
444 #define ev_fork_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
445
446 #define ev_is_pending(ev)                   (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
447 #define ev_is_active(ev)                    (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
448
449 #define ev_priority(ev)                     ((ev_watcher *)(void *)(ev))->priority /* rw */
450 #define ev_cb(ev)                           (ev)->cb /* rw */
451 #define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
452
453 #ifndef ev_set_cb
454 # define ev_set_cb(ev,cb_)                  ev_cb (ev) = (cb_)
455 #endif
456
457 /* stopping (enabling, adding) a watcher does nothing if it is already running */
458 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
459 #if EV_PROTOTYPES
460
461 /* feeds an event into a watcher as if the event actually occured */
462 /* accepts any ev_watcher type */
463 void ev_feed_event     (EV_P_ void *w, int revents);
464 void ev_feed_fd_event  (EV_P_ int fd, int revents);
465 void ev_feed_signal_event (EV_P_ int signum);
466
467 void ev_io_start       (EV_P_ ev_io *w);
468 void ev_io_stop        (EV_P_ ev_io *w);
469
470 void ev_timer_start    (EV_P_ ev_timer *w);
471 void ev_timer_stop     (EV_P_ ev_timer *w);
472 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
473 void ev_timer_again    (EV_P_ ev_timer *w);
474
475 #if EV_PERIODIC_ENABLE
476 void ev_periodic_start (EV_P_ ev_periodic *w);
477 void ev_periodic_stop  (EV_P_ ev_periodic *w);
478 void ev_periodic_again (EV_P_ ev_periodic *w);
479 #endif
480
481 /* only supported in the default loop */
482 void ev_signal_start   (EV_P_ ev_signal *w);
483 void ev_signal_stop    (EV_P_ ev_signal *w);
484
485 /* only supported in the default loop */
486 void ev_child_start    (EV_P_ ev_child *w);
487 void ev_child_stop     (EV_P_ ev_child *w);
488
489 # if EV_STAT_ENABLE
490 void ev_stat_start     (EV_P_ ev_stat *w);
491 void ev_stat_stop      (EV_P_ ev_stat *w);
492 void ev_stat_stat      (EV_P_ ev_stat *w);
493 # endif
494
495 void ev_idle_start     (EV_P_ ev_idle *w);
496 void ev_idle_stop      (EV_P_ ev_idle *w);
497
498 void ev_prepare_start  (EV_P_ ev_prepare *w);
499 void ev_prepare_stop   (EV_P_ ev_prepare *w);
500
501 void ev_check_start    (EV_P_ ev_check *w);
502 void ev_check_stop     (EV_P_ ev_check *w);
503
504 # if EV_FORK_ENABLE
505 void ev_fork_start     (EV_P_ ev_fork *w);
506 void ev_fork_stop      (EV_P_ ev_fork *w);
507 # endif
508
509 # if EV_EMBED_ENABLE
510 /* only supported when loop to be embedded is in fact embeddable */
511 void ev_embed_start    (EV_P_ ev_embed *w);
512 void ev_embed_stop     (EV_P_ ev_embed *w);
513 void ev_embed_sweep    (EV_P_ ev_embed *w);
514 # endif
515
516 #endif
517
518 #ifdef __cplusplus
519 }
520 #endif
521
522 #endif
523