ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.166
Committed: Mon Apr 2 23:46:11 2012 UTC (12 years, 1 month ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.165: +5 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.10 /*
2 root 1.90 * libev native API header
3     *
4 root 1.164 * Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libev@schmorp.de>
5 root 1.10 * All rights reserved.
6     *
7 root 1.90 * Redistribution and use in source and binary forms, with or without modifica-
8     * tion, are permitted provided that the following conditions are met:
9 root 1.159 *
10 root 1.90 * 1. Redistributions of source code must retain the above copyright notice,
11     * this list of conditions and the following disclaimer.
12 root 1.159 *
13 root 1.90 * 2. Redistributions in binary form must reproduce the above copyright
14     * notice, this list of conditions and the following disclaimer in the
15     * documentation and/or other materials provided with the distribution.
16 root 1.159 *
17 root 1.90 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18     * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19     * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20     * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21     * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25     * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26     * OF THE POSSIBILITY OF SUCH DAMAGE.
27 root 1.10 *
28 root 1.90 * Alternatively, the contents of this file may be used under the terms of
29     * the GNU General Public License ("GPL") version 2 or any later version,
30     * in which case the provisions of the GPL are applicable instead of
31     * the above. If you wish to allow the use of your version of this file
32     * only under the terms of the GPL and not to allow others to use your
33     * version of this file under the BSD license, indicate your decision
34     * by deleting the provisions above and replace them with the notice
35     * and other provisions required by the GPL. If you do not delete the
36     * provisions above, a recipient may use your version of this file under
37     * either the BSD or the GPL.
38 root 1.10 */
39    
40 root 1.125 #ifndef EV_H_
41     #define EV_H_
42 root 1.1
43 root 1.19 #ifdef __cplusplus
44 root 1.147 # define EV_CPP(x) x
45     #else
46     # define EV_CPP(x)
47 root 1.19 #endif
48    
49 root 1.147 EV_CPP(extern "C" {)
50    
51 root 1.134 /*****************************************************************************/
52    
53 root 1.142 /* pre-4.0 compatibility */
54     #ifndef EV_COMPAT3
55     # define EV_COMPAT3 1
56     #endif
57    
58 root 1.134 #ifndef EV_FEATURES
59 root 1.166 # if defined __OPTIMIZE_SIZE__
60     # define EV_FEATURES 0x7c
61     # else
62     # define EV_FEATURES 0x7f
63     # endif
64 root 1.134 #endif
65    
66     #define EV_FEATURE_CODE ((EV_FEATURES) & 1)
67     #define EV_FEATURE_DATA ((EV_FEATURES) & 2)
68 root 1.136 #define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
69     #define EV_FEATURE_API ((EV_FEATURES) & 8)
70     #define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
71     #define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
72     #define EV_FEATURE_OS ((EV_FEATURES) & 64)
73 root 1.1
74 root 1.137 /* these priorities are inclusive, higher priorities will be invoked earlier */
75 root 1.21 #ifndef EV_MINPRI
76 root 1.136 # define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
77 root 1.21 #endif
78     #ifndef EV_MAXPRI
79 root 1.136 # define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
80 root 1.21 #endif
81    
82 root 1.29 #ifndef EV_MULTIPLICITY
83 root 1.136 # define EV_MULTIPLICITY EV_FEATURE_CONFIG
84 root 1.29 #endif
85    
86 root 1.69 #ifndef EV_PERIODIC_ENABLE
87 root 1.134 # define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
88 root 1.69 #endif
89    
90     #ifndef EV_STAT_ENABLE
91 root 1.134 # define EV_STAT_ENABLE EV_FEATURE_WATCHERS
92 root 1.69 #endif
93    
94 root 1.133 #ifndef EV_PREPARE_ENABLE
95 root 1.134 # define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
96 root 1.133 #endif
97    
98     #ifndef EV_CHECK_ENABLE
99 root 1.134 # define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
100 root 1.133 #endif
101    
102 root 1.78 #ifndef EV_IDLE_ENABLE
103 root 1.134 # define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
104 root 1.78 #endif
105    
106 root 1.72 #ifndef EV_FORK_ENABLE
107 root 1.151 # define EV_FORK_ENABLE EV_FEATURE_WATCHERS
108 root 1.150 #endif
109    
110     #ifndef EV_CLEANUP_ENABLE
111 root 1.152 # define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
112 root 1.72 #endif
113    
114 root 1.132 #ifndef EV_SIGNAL_ENABLE
115 root 1.134 # define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
116 root 1.132 #endif
117    
118     #ifndef EV_CHILD_ENABLE
119     # ifdef _WIN32
120     # define EV_CHILD_ENABLE 0
121     # else
122 root 1.134 # define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
123 root 1.132 #endif
124 root 1.69 #endif
125    
126 root 1.92 #ifndef EV_ASYNC_ENABLE
127 root 1.134 # define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
128 root 1.92 #endif
129    
130 root 1.132 #ifndef EV_EMBED_ENABLE
131 root 1.134 # define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
132 root 1.132 #endif
133    
134 root 1.115 #ifndef EV_WALK_ENABLE
135     # define EV_WALK_ENABLE 0 /* not yet */
136     #endif
137    
138 root 1.69 /*****************************************************************************/
139    
140 root 1.132 #if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
141     # undef EV_SIGNAL_ENABLE
142     # define EV_SIGNAL_ENABLE 1
143     #endif
144    
145 root 1.134 /*****************************************************************************/
146    
147     typedef double ev_tstamp;
148    
149     #ifndef EV_ATOMIC_T
150     # include <signal.h>
151     # define EV_ATOMIC_T sig_atomic_t volatile
152     #endif
153    
154 root 1.69 #if EV_STAT_ENABLE
155 root 1.103 # ifdef _WIN32
156     # include <time.h>
157     # include <sys/types.h>
158     # endif
159 root 1.69 # include <sys/stat.h>
160 root 1.50 #endif
161    
162 root 1.28 /* support multiple event loops? */
163 root 1.29 #if EV_MULTIPLICITY
164 root 1.28 struct ev_loop;
165 root 1.146 # define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
166 root 1.145 # define EV_P_ EV_P, /* a loop as first of multiple parameters */
167 root 1.146 # define EV_A loop /* a loop as sole argument to a function call */
168 root 1.145 # define EV_A_ EV_A, /* a loop as first of multiple arguments */
169 root 1.149 # define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
170 root 1.145 # define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
171 root 1.146 # define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
172 root 1.145 # define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
173 root 1.28 #else
174     # define EV_P void
175     # define EV_P_
176     # define EV_A
177     # define EV_A_
178 root 1.72 # define EV_DEFAULT
179     # define EV_DEFAULT_
180 root 1.96 # define EV_DEFAULT_UC
181     # define EV_DEFAULT_UC_
182     # undef EV_EMBED_ENABLE
183     #endif
184 root 1.69
185 root 1.146 /* EV_INLINE is used for functions in header files */
186 root 1.96 #if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
187     # define EV_INLINE static inline
188     #else
189     # define EV_INLINE static
190 root 1.28 #endif
191 root 1.27
192 root 1.162 #ifdef EV_API_STATIC
193     # define EV_API_DECL static
194     #else
195     # define EV_API_DECL extern
196     #endif
197    
198 root 1.160 /* EV_PROTOTYPES can be used to switch of prototype declarations */
199 root 1.137 #ifndef EV_PROTOTYPES
200     # define EV_PROTOTYPES 1
201     #endif
202    
203 root 1.96 /*****************************************************************************/
204    
205 root 1.137 #define EV_VERSION_MAJOR 4
206 root 1.164 #define EV_VERSION_MINOR 11
207 root 1.137
208 root 1.1 /* eventmask, revents, events... */
209 root 1.142 enum {
210 root 1.154 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
211 root 1.142 EV_NONE = 0x00, /* no events */
212     EV_READ = 0x01, /* ev_io detected read will not block */
213     EV_WRITE = 0x02, /* ev_io detected write will not block */
214     EV__IOFDSET = 0x80, /* internal use only */
215     EV_IO = EV_READ, /* alias for type-detection */
216     EV_TIMER = 0x00000100, /* timer timed out */
217 root 1.143 #if EV_COMPAT3
218 root 1.142 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
219 root 1.143 #endif
220 root 1.142 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
221     EV_SIGNAL = 0x00000400, /* signal was received */
222     EV_CHILD = 0x00000800, /* child/pid had status change */
223     EV_STAT = 0x00001000, /* stat data changed */
224     EV_IDLE = 0x00002000, /* event loop is idling */
225     EV_PREPARE = 0x00004000, /* event loop about to poll */
226     EV_CHECK = 0x00008000, /* event loop finished poll */
227     EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
228     EV_FORK = 0x00020000, /* event loop resumed in child */
229 root 1.150 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
230     EV_ASYNC = 0x00080000, /* async intra-loop signal */
231 root 1.142 EV_CUSTOM = 0x01000000, /* for use by user code */
232     EV_ERROR = 0x80000000 /* sent when an error occurs */
233     };
234 root 1.1
235 root 1.51 /* can be used to add custom fields to all watchers, while losing binary compatibility */
236 root 1.6 #ifndef EV_COMMON
237 root 1.52 # define EV_COMMON void *data;
238 root 1.6 #endif
239 root 1.14
240 root 1.44 #ifndef EV_CB_DECLARE
241 root 1.46 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
242 root 1.44 #endif
243     #ifndef EV_CB_INVOKE
244     # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
245     #endif
246    
247 root 1.137 /* not official, do not use */
248     #define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
249    
250 root 1.6 /*
251     * struct member types:
252 root 1.108 * private: you may look at them, but not change them,
253     * and they might not mean anything to you.
254     * ro: can be read anytime, but only changed when the watcher isn't active.
255     * rw: can be read and modified anytime, even when the watcher is active.
256 root 1.101 *
257     * some internal details that might be helpful for debugging:
258     *
259     * active is either 0, which means the watcher is not active,
260     * or the array index of the watcher (periodics, timers)
261     * or the array index + 1 (most other watchers)
262     * or simply 1 for watchers that aren't in some array.
263     * pending is either 0, in which case the watcher isn't,
264 root 1.108 * or the array index + 1 in the pendings array.
265 root 1.6 */
266    
267 root 1.117 #if EV_MINPRI == EV_MAXPRI
268     # define EV_DECL_PRIORITY
269 root 1.137 #elif !defined (EV_DECL_PRIORITY)
270 root 1.117 # define EV_DECL_PRIORITY int priority;
271     #endif
272    
273 root 1.1 /* shared by all watchers */
274     #define EV_WATCHER(type) \
275     int active; /* private */ \
276     int pending; /* private */ \
277 root 1.117 EV_DECL_PRIORITY /* private */ \
278 root 1.52 EV_COMMON /* rw */ \
279 root 1.44 EV_CB_DECLARE (type) /* private */
280 root 1.1
281     #define EV_WATCHER_LIST(type) \
282 root 1.52 EV_WATCHER (type) \
283     struct ev_watcher_list *next; /* private */
284 root 1.1
285 root 1.6 #define EV_WATCHER_TIME(type) \
286 root 1.52 EV_WATCHER (type) \
287     ev_tstamp at; /* private */
288 root 1.6
289 root 1.7 /* base class, nothing to see here unless you subclass */
290 root 1.66 typedef struct ev_watcher
291 root 1.44 {
292 root 1.52 EV_WATCHER (ev_watcher)
293 root 1.66 } ev_watcher;
294 root 1.7
295     /* base class, nothing to see here unless you subclass */
296 root 1.66 typedef struct ev_watcher_list
297 root 1.44 {
298 root 1.52 EV_WATCHER_LIST (ev_watcher_list)
299 root 1.66 } ev_watcher_list;
300 root 1.7
301     /* base class, nothing to see here unless you subclass */
302 root 1.66 typedef struct ev_watcher_time
303 root 1.44 {
304 root 1.52 EV_WATCHER_TIME (ev_watcher_time)
305 root 1.66 } ev_watcher_time;
306 root 1.7
307 root 1.70 /* invoked when fd is either EV_READable or EV_WRITEable */
308     /* revent EV_READ, EV_WRITE */
309     typedef struct ev_io
310     {
311     EV_WATCHER_LIST (ev_io)
312    
313     int fd; /* ro */
314     int events; /* ro */
315     } ev_io;
316    
317 root 1.6 /* invoked after a specific time, repeatable (based on monotonic clock) */
318 root 1.17 /* revent EV_TIMEOUT */
319 root 1.66 typedef struct ev_timer
320 root 1.1 {
321 root 1.52 EV_WATCHER_TIME (ev_timer)
322 root 1.1
323     ev_tstamp repeat; /* rw */
324 root 1.66 } ev_timer;
325 root 1.6
326     /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
327 root 1.17 /* revent EV_PERIODIC */
328 root 1.66 typedef struct ev_periodic
329 root 1.6 {
330 root 1.52 EV_WATCHER_TIME (ev_periodic)
331 root 1.6
332 root 1.82 ev_tstamp offset; /* rw */
333 root 1.6 ev_tstamp interval; /* rw */
334 root 1.40 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
335 root 1.66 } ev_periodic;
336 root 1.1
337 root 1.5 /* invoked when the given signal has been received */
338 root 1.17 /* revent EV_SIGNAL */
339 root 1.66 typedef struct ev_signal
340 root 1.1 {
341 root 1.52 EV_WATCHER_LIST (ev_signal)
342 root 1.1
343     int signum; /* ro */
344 root 1.66 } ev_signal;
345 root 1.1
346 root 1.70 /* invoked when sigchld is received and waitpid indicates the given pid */
347     /* revent EV_CHILD */
348     /* does not support priorities */
349     typedef struct ev_child
350     {
351     EV_WATCHER_LIST (ev_child)
352    
353 root 1.91 int flags; /* private */
354 root 1.70 int pid; /* ro */
355     int rpid; /* rw, holds the received pid */
356     int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
357     } ev_child;
358    
359     #if EV_STAT_ENABLE
360     /* st_nlink = 0 means missing file or other error */
361 root 1.74 # ifdef _WIN32
362 root 1.71 typedef struct _stati64 ev_statdata;
363 root 1.74 # else
364 root 1.70 typedef struct stat ev_statdata;
365 root 1.74 # endif
366 root 1.70
367     /* invoked each time the stat data changes for a given path */
368     /* revent EV_STAT */
369     typedef struct ev_stat
370     {
371 root 1.74 EV_WATCHER_LIST (ev_stat)
372 root 1.70
373     ev_timer timer; /* private */
374     ev_tstamp interval; /* ro */
375     const char *path; /* ro */
376     ev_statdata prev; /* ro */
377     ev_statdata attr; /* ro */
378 root 1.74
379     int wd; /* wd for inotify, fd for kqueue */
380 root 1.70 } ev_stat;
381     #endif
382    
383 root 1.78 #if EV_IDLE_ENABLE
384 root 1.5 /* invoked when the nothing else needs to be done, keeps the process from blocking */
385 root 1.17 /* revent EV_IDLE */
386 root 1.66 typedef struct ev_idle
387 root 1.5 {
388 root 1.52 EV_WATCHER (ev_idle)
389 root 1.66 } ev_idle;
390 root 1.78 #endif
391 root 1.5
392 root 1.11 /* invoked for each run of the mainloop, just before the blocking call */
393     /* you can still change events in any way you like */
394 root 1.17 /* revent EV_PREPARE */
395 root 1.66 typedef struct ev_prepare
396 root 1.11 {
397 root 1.52 EV_WATCHER (ev_prepare)
398 root 1.66 } ev_prepare;
399 root 1.11
400     /* invoked for each run of the mainloop, just after the blocking call */
401 root 1.17 /* revent EV_CHECK */
402 root 1.66 typedef struct ev_check
403 root 1.5 {
404 root 1.52 EV_WATCHER (ev_check)
405 root 1.66 } ev_check;
406 root 1.5
407 root 1.72 #if EV_FORK_ENABLE
408     /* the callback gets invoked before check in the child process when a fork was detected */
409 root 1.150 /* revent EV_FORK */
410 root 1.72 typedef struct ev_fork
411     {
412     EV_WATCHER (ev_fork)
413     } ev_fork;
414     #endif
415    
416 root 1.150 #if EV_CLEANUP_ENABLE
417     /* is invoked just before the loop gets destroyed */
418     /* revent EV_CLEANUP */
419     typedef struct ev_cleanup
420     {
421     EV_WATCHER (ev_cleanup)
422     } ev_cleanup;
423     #endif
424    
425 root 1.69 #if EV_EMBED_ENABLE
426 root 1.64 /* used to embed an event loop inside another */
427     /* the callback gets invoked when the event loop has handled events, and can be 0 */
428 root 1.66 typedef struct ev_embed
429 root 1.64 {
430     EV_WATCHER (ev_embed)
431    
432 root 1.86 struct ev_loop *other; /* ro */
433 root 1.87 ev_io io; /* private */
434     ev_prepare prepare; /* private */
435     ev_check check; /* unused */
436     ev_timer timer; /* unused */
437     ev_periodic periodic; /* unused */
438     ev_idle idle; /* unused */
439 root 1.106 ev_fork fork; /* private */
440 root 1.151 #if EV_CLEANUP_ENABLE
441 root 1.150 ev_cleanup cleanup; /* unused */
442 root 1.151 #endif
443 root 1.66 } ev_embed;
444 root 1.64 #endif
445    
446 root 1.92 #if EV_ASYNC_ENABLE
447     /* invoked when somebody calls ev_async_send on the watcher */
448     /* revent EV_ASYNC */
449     typedef struct ev_async
450     {
451     EV_WATCHER (ev_async)
452    
453     EV_ATOMIC_T sent; /* private */
454     } ev_async;
455 root 1.95
456 root 1.128 # define ev_async_pending(w) (+(w)->sent)
457 root 1.92 #endif
458    
459 root 1.41 /* the presence of this union forces similar struct layout */
460 root 1.35 union ev_any_watcher
461     {
462     struct ev_watcher w;
463     struct ev_watcher_list wl;
464 root 1.46
465 root 1.35 struct ev_io io;
466     struct ev_timer timer;
467     struct ev_periodic periodic;
468 root 1.72 struct ev_signal signal;
469 root 1.70 struct ev_child child;
470     #if EV_STAT_ENABLE
471     struct ev_stat stat;
472     #endif
473 root 1.78 #if EV_IDLE_ENABLE
474 root 1.35 struct ev_idle idle;
475 root 1.78 #endif
476 root 1.35 struct ev_prepare prepare;
477     struct ev_check check;
478 root 1.72 #if EV_FORK_ENABLE
479     struct ev_fork fork;
480     #endif
481 root 1.150 #if EV_CLEANUP_ENABLE
482     struct ev_cleanup cleanup;
483     #endif
484 root 1.69 #if EV_EMBED_ENABLE
485 root 1.64 struct ev_embed embed;
486 root 1.67 #endif
487 root 1.97 #if EV_ASYNC_ENABLE
488 root 1.92 struct ev_async async;
489     #endif
490 root 1.35 };
491    
492 root 1.142 /* flag bits for ev_default_loop and ev_loop_new */
493     enum {
494     /* the default */
495     EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
496     /* flag bits */
497     EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
498     EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
499     /* debugging/feature disable */
500     EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
501     #if EV_COMPAT3
502     EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
503     #endif
504 root 1.157 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
505     EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
506 root 1.142 };
507    
508 root 1.53 /* method bits to be ored together */
509 root 1.142 enum {
510     EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
511     EVBACKEND_POLL = 0x00000002U, /* !win */
512     EVBACKEND_EPOLL = 0x00000004U, /* linux */
513     EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
514     EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
515     EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
516 root 1.157 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
517     EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
518 root 1.142 };
519 root 1.29
520 root 1.9 #if EV_PROTOTYPES
521 root 1.162 EV_API_DECL int ev_version_major (void);
522     EV_API_DECL int ev_version_minor (void);
523 root 1.1
524 root 1.162 EV_API_DECL unsigned int ev_supported_backends (void);
525     EV_API_DECL unsigned int ev_recommended_backends (void);
526     EV_API_DECL unsigned int ev_embeddable_backends (void);
527 root 1.63
528 root 1.162 EV_API_DECL ev_tstamp ev_time (void);
529     EV_API_DECL void ev_sleep (ev_tstamp delay); /* sleep for a while */
530 root 1.29
531 root 1.36 /* Sets the allocation function to use, works like realloc.
532     * It is used to allocate and free memory.
533     * If it returns zero when memory needs to be allocated, the library might abort
534     * or take some potentially destructive action.
535     * The default is your system realloc function.
536     */
537 root 1.162 EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size));
538 root 1.36
539     /* set the callback function to call on a
540     * retryable syscall error
541     * (such as failed select, poll, epoll_wait)
542     */
543 root 1.162 EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg));
544 root 1.36
545 root 1.102 #if EV_MULTIPLICITY
546 root 1.148
547     /* the default loop is the only one that handles signals and child watchers */
548     /* you can call this as often as you like */
549 root 1.162 EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
550    
551 root 1.163 #ifdef EV_API_STATIC
552 root 1.162 EV_API_DECL struct ev_loop *ev_default_loop_ptr;
553 root 1.163 #endif
554 root 1.148
555 root 1.96 EV_INLINE struct ev_loop *
556 root 1.149 ev_default_loop_uc_ (void)
557 root 1.96 {
558     extern struct ev_loop *ev_default_loop_ptr;
559    
560     return ev_default_loop_ptr;
561     }
562    
563 root 1.148 EV_INLINE int
564     ev_is_default_loop (EV_P)
565 root 1.58 {
566 root 1.149 return EV_A == EV_DEFAULT_UC;
567 root 1.58 }
568 root 1.30
569     /* create and destroy alternative loops that don't handle signals */
570 root 1.162 EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
571 root 1.47
572 root 1.162 EV_API_DECL ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
573 root 1.47
574 root 1.102 #else
575 root 1.47
576 root 1.162 EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
577    
578     EV_API_DECL ev_tstamp ev_rt_now;
579 root 1.47
580 root 1.96 EV_INLINE ev_tstamp
581 root 1.52 ev_now (void)
582 root 1.47 {
583     return ev_rt_now;
584     }
585 root 1.29
586 root 1.148 /* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
587 root 1.96 EV_INLINE int
588 root 1.148 ev_is_default_loop (void)
589 root 1.94 {
590     return 1;
591     }
592    
593 root 1.148 #endif /* multiplicity */
594    
595 root 1.153 /* destroy event loops, also works for the default loop */
596 root 1.162 EV_API_DECL void ev_loop_destroy (EV_P);
597 root 1.153
598 root 1.149 /* this needs to be called after fork, to duplicate the loop */
599     /* when you want to re-use it in the child */
600 root 1.30 /* you can call it in either the parent or the child */
601     /* you can actually call it at any time, anywhere :) */
602 root 1.162 EV_API_DECL void ev_loop_fork (EV_P);
603 root 1.30
604 root 1.162 EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */
605 root 1.116
606 root 1.162 EV_API_DECL void ev_now_update (EV_P); /* update event loop time */
607 root 1.118
608 root 1.115 #if EV_WALK_ENABLE
609 root 1.112 /* walk (almost) all watchers in the loop of a given type, invoking the */
610     /* callback on every such watcher. The callback might stop the watcher, */
611     /* but do nothing else with the loop */
612 root 1.162 EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
613 root 1.112 #endif
614    
615 root 1.102 #endif /* prototypes */
616 root 1.1
617 root 1.142 /* ev_run flags values */
618     enum {
619     EVRUN_NOWAIT = 1, /* do not block/wait */
620     EVRUN_ONCE = 2 /* block *once* only */
621     };
622    
623     /* ev_break how values */
624     enum {
625     EVBREAK_CANCEL = 0, /* undo unloop */
626     EVBREAK_ONE = 1, /* unloop once */
627     EVBREAK_ALL = 2 /* unloop all loops */
628     };
629 root 1.29
630 root 1.9 #if EV_PROTOTYPES
631 root 1.165 EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
632 root 1.162 EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
633 root 1.27
634     /*
635     * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
636 root 1.119 * keeps one reference. if you have a long-running watcher you never unregister that
637 root 1.27 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
638     */
639 root 1.162 EV_API_DECL void ev_ref (EV_P);
640     EV_API_DECL void ev_unref (EV_P);
641 root 1.1
642 root 1.114 /*
643 root 1.119 * convenience function, wait for a single event, without registering an event watcher
644     * if timeout is < 0, do wait indefinitely
645     */
646 root 1.162 EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
647 root 1.119
648 root 1.134 # if EV_FEATURE_API
649 root 1.162 EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */
650     EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
651     EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */
652 root 1.138
653 root 1.162 EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
654     EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
655 root 1.119
656 root 1.120 /* advanced stuff for threading etc. support, see docs */
657 root 1.162 EV_API_DECL void ev_set_userdata (EV_P_ void *data);
658     EV_API_DECL void *ev_userdata (EV_P);
659     EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
660     EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
661 root 1.119
662 root 1.162 EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
663     EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
664 root 1.119
665     /*
666 root 1.114 * stop/start the timer handling.
667     */
668 root 1.162 EV_API_DECL void ev_suspend (EV_P);
669     EV_API_DECL void ev_resume (EV_P);
670 root 1.119 #endif
671 root 1.114
672 root 1.9 #endif
673    
674 root 1.2 /* these may evaluate ev multiple times, and the other arguments at most once */
675 root 1.45 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
676 root 1.78 #define ev_init(ev,cb_) do { \
677 root 1.117 ((ev_watcher *)(void *)(ev))->active = \
678     ((ev_watcher *)(void *)(ev))->pending = 0; \
679     ev_set_priority ((ev), 0); \
680 root 1.78 ev_set_cb ((ev), cb_); \
681 root 1.32 } while (0)
682 root 1.3
683 root 1.111 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
684 root 1.110 #define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
685     #define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
686     #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
687     #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
688     #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
689     #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
690     #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
691     #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
692     #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
693     #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
694 root 1.150 #define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
695 root 1.140 #define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
696 root 1.110
697     #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
698     #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
699     #define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
700     #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
701     #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
702     #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
703     #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
704     #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
705     #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
706     #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
707     #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
708 root 1.150 #define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
709 root 1.110 #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
710    
711     #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
712     #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
713    
714     #define ev_cb(ev) (ev)->cb /* rw */
715 root 1.117
716     #if EV_MINPRI == EV_MAXPRI
717     # define ev_priority(ev) ((ev), EV_MINPRI)
718     # define ev_set_priority(ev,pri) ((ev), (pri))
719     #else
720 root 1.128 # define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
721 root 1.131 # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
722 root 1.117 #endif
723 root 1.45
724 root 1.128 #define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
725 root 1.100
726 root 1.45 #ifndef ev_set_cb
727 root 1.110 # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
728 root 1.45 #endif
729 root 1.1
730 root 1.5 /* stopping (enabling, adding) a watcher does nothing if it is already running */
731     /* stopping (disabling, deleting) a watcher does nothing unless its already running */
732 root 1.9 #if EV_PROTOTYPES
733 root 1.41
734 root 1.161 /* feeds an event into a watcher as if the event actually occurred */
735 root 1.41 /* accepts any ev_watcher type */
736 root 1.162 EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents);
737     EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents);
738 root 1.132 #if EV_SIGNAL_ENABLE
739 root 1.162 EV_API_DECL void ev_feed_signal (int signum);
740     EV_API_DECL void ev_feed_signal_event (EV_P_ int signum);
741 root 1.132 #endif
742 root 1.162 EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
743     EV_API_DECL int ev_clear_pending (EV_P_ void *w);
744 root 1.41
745 root 1.162 EV_API_DECL void ev_io_start (EV_P_ ev_io *w);
746     EV_API_DECL void ev_io_stop (EV_P_ ev_io *w);
747 root 1.6
748 root 1.162 EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w);
749     EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w);
750 root 1.30 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
751 root 1.162 EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w);
752 root 1.123 /* return remaining time */
753 root 1.162 EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
754 root 1.1
755 root 1.69 #if EV_PERIODIC_ENABLE
756 root 1.162 EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w);
757     EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w);
758     EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w);
759 root 1.50 #endif
760 root 1.1
761 root 1.70 /* only supported in the default loop */
762 root 1.132 #if EV_SIGNAL_ENABLE
763 root 1.162 EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w);
764     EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w);
765 root 1.132 #endif
766 root 1.70
767     /* only supported in the default loop */
768 root 1.132 # if EV_CHILD_ENABLE
769 root 1.162 EV_API_DECL void ev_child_start (EV_P_ ev_child *w);
770     EV_API_DECL void ev_child_stop (EV_P_ ev_child *w);
771 root 1.132 # endif
772 root 1.70
773     # if EV_STAT_ENABLE
774 root 1.162 EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w);
775     EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w);
776     EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w);
777 root 1.70 # endif
778    
779 root 1.78 # if EV_IDLE_ENABLE
780 root 1.162 EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w);
781     EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w);
782 root 1.78 # endif
783 root 1.5
784 root 1.133 #if EV_PREPARE_ENABLE
785 root 1.162 EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w);
786     EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w);
787 root 1.133 #endif
788 root 1.11
789 root 1.133 #if EV_CHECK_ENABLE
790 root 1.162 EV_API_DECL void ev_check_start (EV_P_ ev_check *w);
791     EV_API_DECL void ev_check_stop (EV_P_ ev_check *w);
792 root 1.133 #endif
793 root 1.12
794 root 1.72 # if EV_FORK_ENABLE
795 root 1.162 EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w);
796     EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w);
797 root 1.72 # endif
798    
799 root 1.150 # if EV_CLEANUP_ENABLE
800 root 1.162 EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w);
801     EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w);
802 root 1.150 # endif
803    
804 root 1.69 # if EV_EMBED_ENABLE
805 root 1.64 /* only supported when loop to be embedded is in fact embeddable */
806 root 1.162 EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w);
807     EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w);
808     EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w);
809 root 1.64 # endif
810    
811 root 1.92 # if EV_ASYNC_ENABLE
812 root 1.162 EV_API_DECL void ev_async_start (EV_P_ ev_async *w);
813     EV_API_DECL void ev_async_stop (EV_P_ ev_async *w);
814     EV_API_DECL void ev_async_send (EV_P_ ev_async *w);
815 root 1.92 # endif
816    
817 root 1.141 #if EV_COMPAT3
818     #define EVLOOP_NONBLOCK EVRUN_NOWAIT
819     #define EVLOOP_ONESHOT EVRUN_ONCE
820     #define EVUNLOOP_CANCEL EVBREAK_CANCEL
821     #define EVUNLOOP_ONE EVBREAK_ONE
822     #define EVUNLOOP_ALL EVBREAK_ALL
823     #if EV_PROTOTYPES
824     EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
825     EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
826 root 1.149 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
827     EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
828 root 1.141 #if EV_FEATURE_API
829 root 1.155 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
830     EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
831     EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
832 root 1.141 #endif
833     #endif
834     #else
835     typedef struct ev_loop ev_loop;
836     #endif
837    
838 root 1.9 #endif
839 root 1.5
840 root 1.147 EV_CPP(})
841 root 1.19
842 root 1.1 #endif
843