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

Comparing libev/ev.h (file contents):
Revision 1.132 by root, Wed Mar 10 08:19:39 2010 UTC vs.
Revision 1.157 by root, Mon Jan 10 01:58:55 2011 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
39 39
40#ifndef EV_H_ 40#ifndef EV_H_
41#define EV_H_ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44# define EV_CPP(x) x
45#else
46# define EV_CPP(x)
47#endif
48
44extern "C" { 49EV_CPP(extern "C" {)
45#endif
46 50
47typedef double ev_tstamp; 51/*****************************************************************************/
48 52
53/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3
55# define EV_COMPAT3 1
56#endif
57
58#ifndef EV_FEATURES
59# define EV_FEATURES 0x7f
60#endif
61
62#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
63#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
64#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
65#define EV_FEATURE_API ((EV_FEATURES) & 8)
66#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
67#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
68#define EV_FEATURE_OS ((EV_FEATURES) & 64)
69
49/* these priorities are inclusive, higher priorities will be called earlier */ 70/* these priorities are inclusive, higher priorities will be invoked earlier */
50#ifndef EV_MINPRI 71#ifndef EV_MINPRI
51# define EV_MINPRI -2 72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
52#endif 73#endif
53#ifndef EV_MAXPRI 74#ifndef EV_MAXPRI
54# define EV_MAXPRI +2 75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
55#endif 76#endif
56 77
57#ifndef EV_MULTIPLICITY 78#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1 79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
59#endif 80#endif
60 81
61#ifndef EV_PERIODIC_ENABLE 82#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1 83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63#endif 84#endif
64 85
65#ifndef EV_STAT_ENABLE 86#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 87# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
88#endif
89
90#ifndef EV_PREPARE_ENABLE
91# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
92#endif
93
94#ifndef EV_CHECK_ENABLE
95# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
67#endif 96#endif
68 97
69#ifndef EV_IDLE_ENABLE 98#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71#endif 100#endif
72 101
73#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
74# define EV_FORK_ENABLE 1 103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
104#endif
105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
75#endif 108#endif
76 109
77#ifndef EV_SIGNAL_ENABLE 110#ifndef EV_SIGNAL_ENABLE
78# define EV_SIGNAL_ENABLE 1 111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
79#endif 112#endif
80 113
81#ifndef EV_CHILD_ENABLE 114#ifndef EV_CHILD_ENABLE
82# ifdef _WIN32 115# ifdef _WIN32
83# define EV_CHILD_ENABLE 0 116# define EV_CHILD_ENABLE 0
84# else 117# else
85# define EV_CHILD_ENABLE 1 118# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
86#endif 119#endif
87#endif 120#endif
88 121
89#ifndef EV_ASYNC_ENABLE 122#ifndef EV_ASYNC_ENABLE
90# define EV_ASYNC_ENABLE 1 123# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
91#endif 124#endif
92 125
93#ifndef EV_EMBED_ENABLE 126#ifndef EV_EMBED_ENABLE
94# define EV_EMBED_ENABLE 1 127# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
95#endif 128#endif
96 129
97#ifndef EV_WALK_ENABLE 130#ifndef EV_WALK_ENABLE
98# define EV_WALK_ENABLE 0 /* not yet */ 131# define EV_WALK_ENABLE 0 /* not yet */
99#endif 132#endif
133
134/*****************************************************************************/
135
136#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
137# undef EV_SIGNAL_ENABLE
138# define EV_SIGNAL_ENABLE 1
139#endif
140
141/*****************************************************************************/
142
143typedef double ev_tstamp;
100 144
101#ifndef EV_ATOMIC_T 145#ifndef EV_ATOMIC_T
102# include <signal.h> 146# include <signal.h>
103# define EV_ATOMIC_T sig_atomic_t volatile 147# define EV_ATOMIC_T sig_atomic_t volatile
104#endif
105
106/*****************************************************************************/
107
108#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
109# undef EV_SIGNAL_ENABLE
110# define EV_SIGNAL_ENABLE 1
111#endif 148#endif
112 149
113#if EV_STAT_ENABLE 150#if EV_STAT_ENABLE
114# ifdef _WIN32 151# ifdef _WIN32
115# include <time.h> 152# include <time.h>
119#endif 156#endif
120 157
121/* support multiple event loops? */ 158/* support multiple event loops? */
122#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
123struct ev_loop; 160struct ev_loop;
124# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
125# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
126# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
127# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
128# define EV_DEFAULT_UC ev_default_loop_uc () 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
129# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
130# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
131# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
132#else 169#else
133# define EV_P void 170# define EV_P void
134# define EV_P_ 171# define EV_P_
135# define EV_A 172# define EV_A
136# define EV_A_ 173# define EV_A_
139# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
140# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
141# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
142#endif 179#endif
143 180
181/* EV_INLINE is used for functions in header files */
144#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
145# define EV_INLINE static inline 183# define EV_INLINE static inline
146#else 184#else
147# define EV_INLINE static 185# define EV_INLINE static
148#endif 186#endif
149 187
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */
189#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1
191#endif
192
150/*****************************************************************************/ 193/*****************************************************************************/
151 194
195#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 1
197
152/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
153#define EV_UNDEF -1 /* guaranteed to be invalid */ 199enum {
200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
154#define EV_NONE 0x00 /* no events */ 201 EV_NONE = 0x00, /* no events */
155#define EV_READ 0x01 /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
156#define EV_WRITE 0x02 /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
157#define EV__IOFDSET 0x80 /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
158#define EV_IO EV_READ /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
159#define EV_TIMEOUT 0x00000100 /* timer timed out */ 206 EV_TIMER = 0x00000100, /* timer timed out */
160#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 207#if EV_COMPAT3
208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif
161#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
162#define EV_SIGNAL 0x00000400 /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
163#define EV_CHILD 0x00000800 /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
164#define EV_STAT 0x00001000 /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
165#define EV_IDLE 0x00002000 /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
166#define EV_PREPARE 0x00004000 /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
167#define EV_CHECK 0x00008000 /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
168#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
169#define EV_FORK 0x00020000 /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
170#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
171#define EV_CUSTOM 0x01000000 /* for use by user code */ 221 EV_CUSTOM = 0x01000000, /* for use by user code */
172#define EV_ERROR 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
223};
173 224
174/* can be used to add custom fields to all watchers, while losing binary compatibility */ 225/* can be used to add custom fields to all watchers, while losing binary compatibility */
175#ifndef EV_COMMON 226#ifndef EV_COMMON
176# define EV_COMMON void *data; 227# define EV_COMMON void *data;
177#endif 228#endif
178#ifndef EV_PROTOTYPES
179# define EV_PROTOTYPES 1
180#endif
181
182#define EV_VERSION_MAJOR 3
183#define EV_VERSION_MINOR 9
184 229
185#ifndef EV_CB_DECLARE 230#ifndef EV_CB_DECLARE
186# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 231# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
187#endif 232#endif
188#ifndef EV_CB_INVOKE 233#ifndef EV_CB_INVOKE
189# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 234# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
190#endif 235#endif
236
237/* not official, do not use */
238#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
191 239
192/* 240/*
193 * struct member types: 241 * struct member types:
194 * private: you may look at them, but not change them, 242 * private: you may look at them, but not change them,
195 * and they might not mean anything to you. 243 * and they might not mean anything to you.
206 * or the array index + 1 in the pendings array. 254 * or the array index + 1 in the pendings array.
207 */ 255 */
208 256
209#if EV_MINPRI == EV_MAXPRI 257#if EV_MINPRI == EV_MAXPRI
210# define EV_DECL_PRIORITY 258# define EV_DECL_PRIORITY
211#else 259#elif !defined (EV_DECL_PRIORITY)
212# define EV_DECL_PRIORITY int priority; 260# define EV_DECL_PRIORITY int priority;
213#endif 261#endif
214 262
215/* shared by all watchers */ 263/* shared by all watchers */
216#define EV_WATCHER(type) \ 264#define EV_WATCHER(type) \
346 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
347} ev_check; 395} ev_check;
348 396
349#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
350/* the callback gets invoked before check in the child process when a fork was detected */ 398/* the callback gets invoked before check in the child process when a fork was detected */
399/* revent EV_FORK */
351typedef struct ev_fork 400typedef struct ev_fork
352{ 401{
353 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
354} ev_fork; 403} ev_fork;
404#endif
405
406#if EV_CLEANUP_ENABLE
407/* is invoked just before the loop gets destroyed */
408/* revent EV_CLEANUP */
409typedef struct ev_cleanup
410{
411 EV_WATCHER (ev_cleanup)
412} ev_cleanup;
355#endif 413#endif
356 414
357#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
358/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
359/* the callback gets invoked when the event loop has handled events, and can be 0 */ 417/* the callback gets invoked when the event loop has handled events, and can be 0 */
367 ev_check check; /* unused */ 425 ev_check check; /* unused */
368 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
369 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
370 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
371 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */
432#endif
372} ev_embed; 433} ev_embed;
373#endif 434#endif
374 435
375#if EV_ASYNC_ENABLE 436#if EV_ASYNC_ENABLE
376/* invoked when somebody calls ev_async_send on the watcher */ 437/* invoked when somebody calls ev_async_send on the watcher */
405 struct ev_prepare prepare; 466 struct ev_prepare prepare;
406 struct ev_check check; 467 struct ev_check check;
407#if EV_FORK_ENABLE 468#if EV_FORK_ENABLE
408 struct ev_fork fork; 469 struct ev_fork fork;
409#endif 470#endif
471#if EV_CLEANUP_ENABLE
472 struct ev_cleanup cleanup;
473#endif
410#if EV_EMBED_ENABLE 474#if EV_EMBED_ENABLE
411 struct ev_embed embed; 475 struct ev_embed embed;
412#endif 476#endif
413#if EV_ASYNC_ENABLE 477#if EV_ASYNC_ENABLE
414 struct ev_async async; 478 struct ev_async async;
415#endif 479#endif
416}; 480};
417 481
418/* bits for ev_default_loop and ev_loop_new */ 482/* flag bits for ev_default_loop and ev_loop_new */
483enum {
419/* the default */ 484 /* the default */
420#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 485 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
421/* flag bits */ 486 /* flag bits */
422#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 487 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
423#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 488 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
424/* debugging/feature disable */ 489 /* debugging/feature disable */
425#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 490 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
491#if EV_COMPAT3
426#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ 492 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
493#endif
427#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ 494 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
495 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
496};
497
428/* method bits to be ored together */ 498/* method bits to be ored together */
499enum {
429#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 500 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
430#define EVBACKEND_POLL 0x00000002U /* !win */ 501 EVBACKEND_POLL = 0x00000002U, /* !win */
431#define EVBACKEND_EPOLL 0x00000004U /* linux */ 502 EVBACKEND_EPOLL = 0x00000004U, /* linux */
432#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 503 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
433#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 504 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
434#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 505 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
435#define EVBACKEND_ALL 0x0000003FU 506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508};
436 509
437#if EV_PROTOTYPES 510#if EV_PROTOTYPES
438int ev_version_major (void); 511int ev_version_major (void);
439int ev_version_minor (void); 512int ev_version_minor (void);
440 513
458 * (such as failed select, poll, epoll_wait) 531 * (such as failed select, poll, epoll_wait)
459 */ 532 */
460void ev_set_syserr_cb (void (*cb)(const char *msg)); 533void ev_set_syserr_cb (void (*cb)(const char *msg));
461 534
462#if EV_MULTIPLICITY 535#if EV_MULTIPLICITY
536
537/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
540
463EV_INLINE struct ev_loop * 541EV_INLINE struct ev_loop *
464ev_default_loop_uc (void) 542ev_default_loop_uc_ (void)
465{ 543{
466 extern struct ev_loop *ev_default_loop_ptr; 544 extern struct ev_loop *ev_default_loop_ptr;
467 545
468 return ev_default_loop_ptr; 546 return ev_default_loop_ptr;
469} 547}
470 548
471/* the default loop is the only one that handles signals and child watchers */ 549EV_INLINE int
472/* you can call this as often as you like */ 550ev_is_default_loop (EV_P)
473EV_INLINE struct ev_loop *
474ev_default_loop (unsigned int flags)
475{ 551{
476 struct ev_loop *loop = ev_default_loop_uc (); 552 return EV_A == EV_DEFAULT_UC;
477
478 if (!loop)
479 {
480 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
481
482 loop = ev_default_loop_init (flags);
483 }
484
485 return loop;
486} 553}
487 554
488/* create and destroy alternative loops that don't handle signals */ 555/* create and destroy alternative loops that don't handle signals */
489struct ev_loop *ev_loop_new (unsigned int flags); 556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
490void ev_loop_destroy (EV_P);
491void ev_loop_fork (EV_P);
492 557
493ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 558ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
494 559
495#else 560#else
496 561
497int ev_default_loop (unsigned int flags); /* returns true when successful */ 562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
498 563
499EV_INLINE ev_tstamp 564EV_INLINE ev_tstamp
500ev_now (void) 565ev_now (void)
501{ 566{
502 extern ev_tstamp ev_rt_now; 567 extern ev_tstamp ev_rt_now;
503 568
504 return ev_rt_now; 569 return ev_rt_now;
505} 570}
571
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
573EV_INLINE int
574ev_is_default_loop (void)
575{
576 return 1;
577}
578
506#endif /* multiplicity */ 579#endif /* multiplicity */
507 580
508EV_INLINE int 581/* destroy event loops, also works for the default loop */
509ev_is_default_loop (EV_P) 582void ev_loop_destroy (EV_P);
510{
511#if EV_MULTIPLICITY
512 extern struct ev_loop *ev_default_loop_ptr;
513 583
514 return !!(EV_A == ev_default_loop_ptr);
515#else
516 return 1;
517#endif
518}
519
520void ev_default_destroy (void); /* destroy the default loop */
521/* this needs to be called after fork, to duplicate the default loop */ 584/* this needs to be called after fork, to duplicate the loop */
522/* if you create alternative loops you have to call ev_loop_fork on them */ 585/* when you want to re-use it in the child */
523/* you can call it in either the parent or the child */ 586/* you can call it in either the parent or the child */
524/* you can actually call it at any time, anywhere :) */ 587/* you can actually call it at any time, anywhere :) */
525void ev_default_fork (void); 588void ev_loop_fork (EV_P);
526 589
527unsigned int ev_backend (EV_P); /* backend in use by loop */ 590unsigned int ev_backend (EV_P); /* backend in use by loop */
528 591
529void ev_now_update (EV_P); /* update event loop time */ 592void ev_now_update (EV_P); /* update event loop time */
530 593
535void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 598void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
536#endif 599#endif
537 600
538#endif /* prototypes */ 601#endif /* prototypes */
539 602
540#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 603/* ev_run flags values */
541#define EVLOOP_ONESHOT 2 /* block *once* only */ 604enum {
542#define EVUNLOOP_CANCEL 0 /* undo unloop */ 605 EVRUN_NOWAIT = 1, /* do not block/wait */
543#define EVUNLOOP_ONE 1 /* unloop once */ 606 EVRUN_ONCE = 2 /* block *once* only */
607};
608
609/* ev_break how values */
610enum {
611 EVBREAK_CANCEL = 0, /* undo unloop */
612 EVBREAK_ONE = 1, /* unloop once */
544#define EVUNLOOP_ALL 2 /* unloop all loops */ 613 EVBREAK_ALL = 2 /* unloop all loops */
614};
545 615
546#if EV_PROTOTYPES 616#if EV_PROTOTYPES
547void ev_loop (EV_P_ int flags); 617void ev_run (EV_P_ int flags EV_CPP (= 0));
548void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
549 619
550/* 620/*
551 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 621 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
552 * keeps one reference. if you have a long-running watcher you never unregister that 622 * keeps one reference. if you have a long-running watcher you never unregister that
553 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 623 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
559 * convenience function, wait for a single event, without registering an event watcher 629 * convenience function, wait for a single event, without registering an event watcher
560 * if timeout is < 0, do wait indefinitely 630 * if timeout is < 0, do wait indefinitely
561 */ 631 */
562void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 632void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
563 633
564# if EV_MINIMAL < 2 634# if EV_FEATURE_API
565unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 635unsigned int ev_iteration (EV_P); /* number of loop iterations */
566unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
567void ev_loop_verify (EV_P); /* abort if loop data corrupted */ 637void ev_verify (EV_P); /* abort if loop data corrupted */
568 638
569void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
570void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
571 641
572/* advanced stuff for threading etc. support, see docs */ 642/* advanced stuff for threading etc. support, see docs */
605#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 675#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
606#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 676#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
607#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 677#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
608#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 678#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
609#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 679#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
610#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 680#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
681#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
611 682
612#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 683#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
613#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 684#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
614#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 685#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
615#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 686#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
618#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 689#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
619#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 690#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
620#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 691#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
621#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 692#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
622#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 693#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
694#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
623#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 695#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
624 696
625#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 697#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
626#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 698#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
627 699
648/* feeds an event into a watcher as if the event actually occured */ 720/* feeds an event into a watcher as if the event actually occured */
649/* accepts any ev_watcher type */ 721/* accepts any ev_watcher type */
650void ev_feed_event (EV_P_ void *w, int revents); 722void ev_feed_event (EV_P_ void *w, int revents);
651void ev_feed_fd_event (EV_P_ int fd, int revents); 723void ev_feed_fd_event (EV_P_ int fd, int revents);
652#if EV_SIGNAL_ENABLE 724#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum);
653void ev_feed_signal_event (EV_P_ int signum); 726void ev_feed_signal_event (EV_P_ int signum);
654#endif 727#endif
655void ev_invoke (EV_P_ void *w, int revents); 728void ev_invoke (EV_P_ void *w, int revents);
656int ev_clear_pending (EV_P_ void *w); 729int ev_clear_pending (EV_P_ void *w);
657 730
692# if EV_IDLE_ENABLE 765# if EV_IDLE_ENABLE
693void ev_idle_start (EV_P_ ev_idle *w); 766void ev_idle_start (EV_P_ ev_idle *w);
694void ev_idle_stop (EV_P_ ev_idle *w); 767void ev_idle_stop (EV_P_ ev_idle *w);
695# endif 768# endif
696 769
770#if EV_PREPARE_ENABLE
697void ev_prepare_start (EV_P_ ev_prepare *w); 771void ev_prepare_start (EV_P_ ev_prepare *w);
698void ev_prepare_stop (EV_P_ ev_prepare *w); 772void ev_prepare_stop (EV_P_ ev_prepare *w);
773#endif
699 774
775#if EV_CHECK_ENABLE
700void ev_check_start (EV_P_ ev_check *w); 776void ev_check_start (EV_P_ ev_check *w);
701void ev_check_stop (EV_P_ ev_check *w); 777void ev_check_stop (EV_P_ ev_check *w);
778#endif
702 779
703# if EV_FORK_ENABLE 780# if EV_FORK_ENABLE
704void ev_fork_start (EV_P_ ev_fork *w); 781void ev_fork_start (EV_P_ ev_fork *w);
705void ev_fork_stop (EV_P_ ev_fork *w); 782void ev_fork_stop (EV_P_ ev_fork *w);
783# endif
784
785# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w);
706# endif 788# endif
707 789
708# if EV_EMBED_ENABLE 790# if EV_EMBED_ENABLE
709/* only supported when loop to be embedded is in fact embeddable */ 791/* only supported when loop to be embedded is in fact embeddable */
710void ev_embed_start (EV_P_ ev_embed *w); 792void ev_embed_start (EV_P_ ev_embed *w);
716void ev_async_start (EV_P_ ev_async *w); 798void ev_async_start (EV_P_ ev_async *w);
717void ev_async_stop (EV_P_ ev_async *w); 799void ev_async_stop (EV_P_ ev_async *w);
718void ev_async_send (EV_P_ ev_async *w); 800void ev_async_send (EV_P_ ev_async *w);
719# endif 801# endif
720 802
803#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE
806 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
807 #define EVUNLOOP_ONE EVBREAK_ONE
808 #define EVUNLOOP_ALL EVBREAK_ALL
809 #if EV_PROTOTYPES
810 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
811 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
812 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
813 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
814 #if EV_FEATURE_API
815 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
816 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
817 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
818 #endif
721#endif 819 #endif
722 820#else
723#ifdef __cplusplus 821 typedef struct ev_loop ev_loop;
724}
725#endif 822#endif
726 823
727#endif 824#endif
728 825
826EV_CPP(})
827
828#endif
829

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines