ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.3 by root, Tue Oct 30 23:10:33 2007 UTC vs.
Revision 1.191 by root, Thu Jun 20 22:44:59 2019 UTC

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

Diff Legend

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