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.180 by root, Sun Nov 9 09:00:16 2014 UTC

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

Diff Legend

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