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