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