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

Comparing libev/ev.h (file contents):
Revision 1.140 by root, Thu Oct 21 02:33:08 2010 UTC vs.
Revision 1.168 by root, Wed Apr 18 06:06:04 2012 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011,2012 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 *
10 * 1. Redistributions of source code must retain the above copyright notice, 10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer. 11 * this list of conditions and the following disclaimer.
12 * 12 *
13 * 2. Redistributions in binary form must reproduce the above copyright 13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the 14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution. 15 * documentation and/or other materials provided with the distribution.
16 * 16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 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- 18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 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- 20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
… …
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
49#define EV_THROW EV_CPP(throw())
50
44extern "C" { 51EV_CPP(extern "C" {)
45#endif
46 52
47/*****************************************************************************/ 53/*****************************************************************************/
48 54
55/* pre-4.0 compatibility */
56#ifndef EV_COMPAT3
57# define EV_COMPAT3 1
58#endif
59
49#ifndef EV_FEATURES 60#ifndef EV_FEATURES
61# if defined __OPTIMIZE_SIZE__
62# define EV_FEATURES 0x7c
63# else
50# define EV_FEATURES 0x7f 64# define EV_FEATURES 0x7f
65# endif
51#endif 66#endif
52 67
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 68#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2) 69#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
55#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4) 70#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
… …
92 107
93#ifndef EV_FORK_ENABLE 108#ifndef EV_FORK_ENABLE
94# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 109# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
95#endif 110#endif
96 111
112#ifndef EV_CLEANUP_ENABLE
113# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
114#endif
115
97#ifndef EV_SIGNAL_ENABLE 116#ifndef EV_SIGNAL_ENABLE
98# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 117# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
99#endif 118#endif
100 119
101#ifndef EV_CHILD_ENABLE 120#ifndef EV_CHILD_ENABLE
… …
143#endif 162#endif
144 163
145/* support multiple event loops? */ 164/* support multiple event loops? */
146#if EV_MULTIPLICITY 165#if EV_MULTIPLICITY
147struct ev_loop; 166struct ev_loop;
148# define EV_P struct ev_loop *loop 167# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
149# define EV_P_ EV_P, 168# define EV_P_ EV_P, /* a loop as first of multiple parameters */
150# define EV_A loop 169# define EV_A loop /* a loop as sole argument to a function call */
151# define EV_A_ EV_A, 170# define EV_A_ EV_A, /* a loop as first of multiple arguments */
152# define EV_DEFAULT_UC ev_default_loop_uc () 171# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
153# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 172# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
154# define EV_DEFAULT ev_default_loop (0) 173# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
155# define EV_DEFAULT_ EV_DEFAULT, 174# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
156#else 175#else
157# define EV_P void 176# define EV_P void
158# define EV_P_ 177# define EV_P_
159# define EV_A 178# define EV_A
160# define EV_A_ 179# define EV_A_
… …
163# define EV_DEFAULT_UC 182# define EV_DEFAULT_UC
164# define EV_DEFAULT_UC_ 183# define EV_DEFAULT_UC_
165# undef EV_EMBED_ENABLE 184# undef EV_EMBED_ENABLE
166#endif 185#endif
167 186
187/* EV_INLINE is used for functions in header files */
168#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 188#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
169# define EV_INLINE static inline 189# define EV_INLINE static inline
170#else 190#else
171# define EV_INLINE static 191# define EV_INLINE static
172#endif 192#endif
173 193
194#ifdef EV_API_STATIC
195# define EV_API_DECL static
196#else
197# define EV_API_DECL extern
198#endif
199
200/* EV_PROTOTYPES can be used to switch of prototype declarations */
174#ifndef EV_PROTOTYPES 201#ifndef EV_PROTOTYPES
175# define EV_PROTOTYPES 1 202# define EV_PROTOTYPES 1
176#endif 203#endif
177 204
178/*****************************************************************************/ 205/*****************************************************************************/
179 206
180#define EV_VERSION_MAJOR 4 207#define EV_VERSION_MAJOR 4
181#define EV_VERSION_MINOR 0 208#define EV_VERSION_MINOR 11
182 209
183/* eventmask, revents, events... */ 210/* eventmask, revents, events... */
184#define EV_UNDEF -1 /* guaranteed to be invalid */ 211enum {
212 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
185#define EV_NONE 0x00 /* no events */ 213 EV_NONE = 0x00, /* no events */
186#define EV_READ 0x01 /* ev_io detected read will not block */ 214 EV_READ = 0x01, /* ev_io detected read will not block */
187#define EV_WRITE 0x02 /* ev_io detected write will not block */ 215 EV_WRITE = 0x02, /* ev_io detected write will not block */
188#define EV__IOFDSET 0x80 /* internal use only */ 216 EV__IOFDSET = 0x80, /* internal use only */
189#define EV_IO EV_READ /* alias for type-detection */ 217 EV_IO = EV_READ, /* alias for type-detection */
190#define EV_TIMER 0x00000100 /* timer timed out */ 218 EV_TIMER = 0x00000100, /* timer timed out */
219#if EV_COMPAT3
191#define EV_TIMEOUT EV_TIMER /* pre 4.0 API compatibility */ 220 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
221#endif
192#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 222 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
193#define EV_SIGNAL 0x00000400 /* signal was received */ 223 EV_SIGNAL = 0x00000400, /* signal was received */
194#define EV_CHILD 0x00000800 /* child/pid had status change */ 224 EV_CHILD = 0x00000800, /* child/pid had status change */
195#define EV_STAT 0x00001000 /* stat data changed */ 225 EV_STAT = 0x00001000, /* stat data changed */
196#define EV_IDLE 0x00002000 /* event loop is idling */ 226 EV_IDLE = 0x00002000, /* event loop is idling */
197#define EV_PREPARE 0x00004000 /* event loop about to poll */ 227 EV_PREPARE = 0x00004000, /* event loop about to poll */
198#define EV_CHECK 0x00008000 /* event loop finished poll */ 228 EV_CHECK = 0x00008000, /* event loop finished poll */
199#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 229 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
200#define EV_FORK 0x00020000 /* event loop resumed in child */ 230 EV_FORK = 0x00020000, /* event loop resumed in child */
231 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
201#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 232 EV_ASYNC = 0x00080000, /* async intra-loop signal */
202#define EV_CUSTOM 0x01000000 /* for use by user code */ 233 EV_CUSTOM = 0x01000000, /* for use by user code */
203#define EV_ERROR 0x80000000 /* sent when an error occurs */ 234 EV_ERROR = 0x80000000 /* sent when an error occurs */
235};
204 236
205/* can be used to add custom fields to all watchers, while losing binary compatibility */ 237/* can be used to add custom fields to all watchers, while losing binary compatibility */
206#ifndef EV_COMMON 238#ifndef EV_COMMON
207# define EV_COMMON void *data; 239# define EV_COMMON void *data;
208#endif 240#endif
… …
299{ 331{
300 EV_WATCHER_TIME (ev_periodic) 332 EV_WATCHER_TIME (ev_periodic)
301 333
302 ev_tstamp offset; /* rw */ 334 ev_tstamp offset; /* rw */
303 ev_tstamp interval; /* rw */ 335 ev_tstamp interval; /* rw */
304 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 336 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) EV_THROW; /* rw */
305} ev_periodic; 337} ev_periodic;
306 338
307/* invoked when the given signal has been received */ 339/* invoked when the given signal has been received */
308/* revent EV_SIGNAL */ 340/* revent EV_SIGNAL */
309typedef struct ev_signal 341typedef struct ev_signal
… …
374 EV_WATCHER (ev_check) 406 EV_WATCHER (ev_check)
375} ev_check; 407} ev_check;
376 408
377#if EV_FORK_ENABLE 409#if EV_FORK_ENABLE
378/* the callback gets invoked before check in the child process when a fork was detected */ 410/* the callback gets invoked before check in the child process when a fork was detected */
411/* revent EV_FORK */
379typedef struct ev_fork 412typedef struct ev_fork
380{ 413{
381 EV_WATCHER (ev_fork) 414 EV_WATCHER (ev_fork)
382} ev_fork; 415} ev_fork;
416#endif
417
418#if EV_CLEANUP_ENABLE
419/* is invoked just before the loop gets destroyed */
420/* revent EV_CLEANUP */
421typedef struct ev_cleanup
422{
423 EV_WATCHER (ev_cleanup)
424} ev_cleanup;
383#endif 425#endif
384 426
385#if EV_EMBED_ENABLE 427#if EV_EMBED_ENABLE
386/* used to embed an event loop inside another */ 428/* used to embed an event loop inside another */
387/* the callback gets invoked when the event loop has handled events, and can be 0 */ 429/* the callback gets invoked when the event loop has handled events, and can be 0 */
… …
395 ev_check check; /* unused */ 437 ev_check check; /* unused */
396 ev_timer timer; /* unused */ 438 ev_timer timer; /* unused */
397 ev_periodic periodic; /* unused */ 439 ev_periodic periodic; /* unused */
398 ev_idle idle; /* unused */ 440 ev_idle idle; /* unused */
399 ev_fork fork; /* private */ 441 ev_fork fork; /* private */
442#if EV_CLEANUP_ENABLE
443 ev_cleanup cleanup; /* unused */
444#endif
400} ev_embed; 445} ev_embed;
401#endif 446#endif
402 447
403#if EV_ASYNC_ENABLE 448#if EV_ASYNC_ENABLE
404/* invoked when somebody calls ev_async_send on the watcher */ 449/* invoked when somebody calls ev_async_send on the watcher */
… …
433 struct ev_prepare prepare; 478 struct ev_prepare prepare;
434 struct ev_check check; 479 struct ev_check check;
435#if EV_FORK_ENABLE 480#if EV_FORK_ENABLE
436 struct ev_fork fork; 481 struct ev_fork fork;
437#endif 482#endif
483#if EV_CLEANUP_ENABLE
484 struct ev_cleanup cleanup;
485#endif
438#if EV_EMBED_ENABLE 486#if EV_EMBED_ENABLE
439 struct ev_embed embed; 487 struct ev_embed embed;
440#endif 488#endif
441#if EV_ASYNC_ENABLE 489#if EV_ASYNC_ENABLE
442 struct ev_async async; 490 struct ev_async async;
443#endif 491#endif
444}; 492};
445 493
446/* bits for ev_default_loop and ev_loop_new */ 494/* flag bits for ev_default_loop and ev_loop_new */
495enum {
447/* the default */ 496 /* the default */
448#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 497 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
449/* flag bits */ 498 /* flag bits */
450#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 499 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
451#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 500 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
452/* debugging/feature disable */ 501 /* debugging/feature disable */
453#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 502 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
503#if EV_COMPAT3
454#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ 504 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
505#endif
455#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ 506 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
507 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
508};
509
456/* method bits to be ored together */ 510/* method bits to be ored together */
511enum {
457#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 512 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
458#define EVBACKEND_POLL 0x00000002U /* !win */ 513 EVBACKEND_POLL = 0x00000002U, /* !win */
459#define EVBACKEND_EPOLL 0x00000004U /* linux */ 514 EVBACKEND_EPOLL = 0x00000004U, /* linux */
460#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 515 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
461#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 516 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
462#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 517 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
463#define EVBACKEND_ALL 0x0000003FU 518 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
519 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
520};
464 521
465#if EV_PROTOTYPES 522#if EV_PROTOTYPES
466int ev_version_major (void); 523EV_API_DECL int ev_version_major (void) EV_THROW;
467int ev_version_minor (void); 524EV_API_DECL int ev_version_minor (void) EV_THROW;
468 525
469unsigned int ev_supported_backends (void); 526EV_API_DECL unsigned int ev_supported_backends (void) EV_THROW;
470unsigned int ev_recommended_backends (void); 527EV_API_DECL unsigned int ev_recommended_backends (void) EV_THROW;
471unsigned int ev_embeddable_backends (void); 528EV_API_DECL unsigned int ev_embeddable_backends (void) EV_THROW;
472 529
473ev_tstamp ev_time (void); 530EV_API_DECL ev_tstamp ev_time (void) EV_THROW;
474void ev_sleep (ev_tstamp delay); /* sleep for a while */ 531EV_API_DECL void ev_sleep (ev_tstamp delay) EV_THROW; /* sleep for a while */
475 532
476/* Sets the allocation function to use, works like realloc. 533/* Sets the allocation function to use, works like realloc.
477 * It is used to allocate and free memory. 534 * It is used to allocate and free memory.
478 * If it returns zero when memory needs to be allocated, the library might abort 535 * If it returns zero when memory needs to be allocated, the library might abort
479 * or take some potentially destructive action. 536 * or take some potentially destructive action.
480 * The default is your system realloc function. 537 * The default is your system realloc function.
481 */ 538 */
482void ev_set_allocator (void *(*cb)(void *ptr, long size)); 539EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size) EV_THROW) EV_THROW;
483 540
484/* set the callback function to call on a 541/* set the callback function to call on a
485 * retryable syscall error 542 * retryable syscall error
486 * (such as failed select, poll, epoll_wait) 543 * (such as failed select, poll, epoll_wait)
487 */ 544 */
488void ev_set_syserr_cb (void (*cb)(const char *msg)); 545EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg) EV_THROW) EV_THROW;
489 546
490#if EV_MULTIPLICITY 547#if EV_MULTIPLICITY
548
549/* the default loop is the only one that handles signals and child watchers */
550/* you can call this as often as you like */
551EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW;
552
553#ifdef EV_API_STATIC
554EV_API_DECL struct ev_loop *ev_default_loop_ptr;
555#endif
556
491EV_INLINE struct ev_loop * 557EV_INLINE struct ev_loop *
492ev_default_loop_uc (void) 558ev_default_loop_uc_ (void) EV_THROW
493{ 559{
494 extern struct ev_loop *ev_default_loop_ptr; 560 extern struct ev_loop *ev_default_loop_ptr;
495 561
496 return ev_default_loop_ptr; 562 return ev_default_loop_ptr;
497} 563}
498 564
499/* the default loop is the only one that handles signals and child watchers */ 565EV_INLINE int
500/* you can call this as often as you like */ 566ev_is_default_loop (EV_P) EV_THROW
501EV_INLINE struct ev_loop *
502ev_default_loop (unsigned int flags)
503{ 567{
504 struct ev_loop *loop = ev_default_loop_uc (); 568 return EV_A == EV_DEFAULT_UC;
505
506 if (!loop)
507 {
508 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
509
510 loop = ev_default_loop_init (flags);
511 }
512
513 return loop;
514} 569}
515 570
516/* create and destroy alternative loops that don't handle signals */ 571/* create and destroy alternative loops that don't handle signals */
517struct ev_loop *ev_loop_new (unsigned int flags); 572EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)) EV_THROW;
518void ev_loop_destroy (EV_P);
519void ev_loop_fork (EV_P);
520 573
521ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 574EV_API_DECL ev_tstamp ev_now (EV_P) EV_THROW; /* time w.r.t. timers and the eventloop, updated after each poll */
522 575
523#else 576#else
524 577
525int ev_default_loop (unsigned int flags); /* returns true when successful */ 578EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW; /* returns true when successful */
579
580EV_API_DECL ev_tstamp ev_rt_now;
526 581
527EV_INLINE ev_tstamp 582EV_INLINE ev_tstamp
528ev_now (void) 583ev_now (void) EV_THROW
529{ 584{
530 extern ev_tstamp ev_rt_now;
531
532 return ev_rt_now; 585 return ev_rt_now;
533} 586}
587
588/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
589EV_INLINE int
590ev_is_default_loop (void) EV_THROW
591{
592 return 1;
593}
594
534#endif /* multiplicity */ 595#endif /* multiplicity */
535 596
536EV_INLINE int 597/* destroy event loops, also works for the default loop */
537ev_is_default_loop (EV_P) 598EV_API_DECL void ev_loop_destroy (EV_P) EV_THROW;
538{
539#if EV_MULTIPLICITY
540 extern struct ev_loop *ev_default_loop_ptr;
541 599
542 return !!(EV_A == ev_default_loop_ptr);
543#else
544 return 1;
545#endif
546}
547
548void ev_default_destroy (void); /* destroy the default loop */
549/* this needs to be called after fork, to duplicate the default loop */ 600/* this needs to be called after fork, to duplicate the loop */
550/* if you create alternative loops you have to call ev_loop_fork on them */ 601/* when you want to re-use it in the child */
551/* you can call it in either the parent or the child */ 602/* you can call it in either the parent or the child */
552/* you can actually call it at any time, anywhere :) */ 603/* you can actually call it at any time, anywhere :) */
553void ev_default_fork (void); 604EV_API_DECL void ev_loop_fork (EV_P) EV_THROW;
554 605
555unsigned int ev_backend (EV_P); /* backend in use by loop */ 606EV_API_DECL unsigned int ev_backend (EV_P) EV_THROW; /* backend in use by loop */
556 607
557void ev_now_update (EV_P); /* update event loop time */ 608EV_API_DECL void ev_now_update (EV_P) EV_THROW; /* update event loop time */
558 609
559#if EV_WALK_ENABLE 610#if EV_WALK_ENABLE
560/* walk (almost) all watchers in the loop of a given type, invoking the */ 611/* walk (almost) all watchers in the loop of a given type, invoking the */
561/* callback on every such watcher. The callback might stop the watcher, */ 612/* callback on every such watcher. The callback might stop the watcher, */
562/* but do nothing else with the loop */ 613/* but do nothing else with the loop */
563void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 614EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)) EV_THROW;
564#endif 615#endif
565 616
566#endif /* prototypes */ 617#endif /* prototypes */
567 618
568#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 619/* ev_run flags values */
569#define EVLOOP_ONESHOT 2 /* block *once* only */ 620enum {
570#define EVUNLOOP_CANCEL 0 /* undo unloop */ 621 EVRUN_NOWAIT = 1, /* do not block/wait */
571#define EVUNLOOP_ONE 1 /* unloop once */ 622 EVRUN_ONCE = 2 /* block *once* only */
623};
624
625/* ev_break how values */
626enum {
627 EVBREAK_CANCEL = 0, /* undo unloop */
628 EVBREAK_ONE = 1, /* unloop once */
572#define EVUNLOOP_ALL 2 /* unloop all loops */ 629 EVBREAK_ALL = 2 /* unloop all loops */
630};
573 631
574#if EV_PROTOTYPES 632#if EV_PROTOTYPES
575void ev_loop (EV_P_ int flags); 633EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
576void 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 */ 634EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)) EV_THROW; /* break out of the loop */
577 635
578/* 636/*
579 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 637 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
580 * keeps one reference. if you have a long-running watcher you never unregister that 638 * keeps one reference. if you have a long-running watcher you never unregister that
581 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 639 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
582 */ 640 */
583void ev_ref (EV_P); 641EV_API_DECL void ev_ref (EV_P) EV_THROW;
584void ev_unref (EV_P); 642EV_API_DECL void ev_unref (EV_P) EV_THROW;
585 643
586/* 644/*
587 * convenience function, wait for a single event, without registering an event watcher 645 * convenience function, wait for a single event, without registering an event watcher
588 * if timeout is < 0, do wait indefinitely 646 * if timeout is < 0, do wait indefinitely
589 */ 647 */
590void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 648EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg) EV_THROW;
591 649
592# if EV_FEATURE_API 650# if EV_FEATURE_API
593unsigned int ev_iteration (EV_P); /* number of loop iterations */ 651EV_API_DECL unsigned int ev_iteration (EV_P) EV_THROW; /* number of loop iterations */
594unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 652EV_API_DECL unsigned int ev_depth (EV_P) EV_THROW; /* #ev_loop enters - #ev_loop leaves */
595void ev_verify (EV_P); /* abort if loop data corrupted */ 653EV_API_DECL void ev_verify (EV_P) EV_THROW; /* abort if loop data corrupted */
596 654
597/* pre 4.0 API compatibility */
598# if EV_MULTIPLICITY
599# define ev_loop_count(l) ev_iteration (l)
600# define ev_loop_depth(l) ev_depth (l)
601# define ev_loop_verify(l) ev_verify (l)
602# endif
603
604void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 655EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
605void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 656EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
606 657
607/* advanced stuff for threading etc. support, see docs */ 658/* advanced stuff for threading etc. support, see docs */
608void ev_set_userdata (EV_P_ void *data); 659EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_THROW;
609void *ev_userdata (EV_P); 660EV_API_DECL void *ev_userdata (EV_P) EV_THROW;
610void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 661EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)) EV_THROW;
611void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 662EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P) EV_THROW) EV_THROW;
612 663
613unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 664EV_API_DECL unsigned int ev_pending_count (EV_P) EV_THROW; /* number of pending events, if any */
614void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 665EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
615 666
616/* 667/*
617 * stop/start the timer handling. 668 * stop/start the timer handling.
618 */ 669 */
619void ev_suspend (EV_P); 670EV_API_DECL void ev_suspend (EV_P) EV_THROW;
620void ev_resume (EV_P); 671EV_API_DECL void ev_resume (EV_P) EV_THROW;
621#endif 672#endif
622 673
623#endif 674#endif
624 675
625/* these may evaluate ev multiple times, and the other arguments at most once */ 676/* these may evaluate ev multiple times, and the other arguments at most once */
… …
640#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 691#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
641#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 692#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
642#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 693#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
643#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 694#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
644#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 695#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
696#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
645#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ 697#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
646 698
647#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 699#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
648#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 700#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
649#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 701#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
… …
653#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 705#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
654#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 706#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
655#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 707#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
656#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 708#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
657#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 709#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
710#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
658#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 711#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
659 712
660#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 713#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
661#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 714#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
662 715
… …
678 731
679/* stopping (enabling, adding) a watcher does nothing if it is already running */ 732/* stopping (enabling, adding) a watcher does nothing if it is already running */
680/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 733/* stopping (disabling, deleting) a watcher does nothing unless its already running */
681#if EV_PROTOTYPES 734#if EV_PROTOTYPES
682 735
683/* feeds an event into a watcher as if the event actually occured */ 736/* feeds an event into a watcher as if the event actually occurred */
684/* accepts any ev_watcher type */ 737/* accepts any ev_watcher type */
685void ev_feed_event (EV_P_ void *w, int revents); 738EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents) EV_THROW;
686void ev_feed_fd_event (EV_P_ int fd, int revents); 739EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents) EV_THROW;
687#if EV_SIGNAL_ENABLE 740#if EV_SIGNAL_ENABLE
741EV_API_DECL void ev_feed_signal (int signum) EV_THROW;
688void ev_feed_signal_event (EV_P_ int signum); 742EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_THROW;
689#endif 743#endif
690void ev_invoke (EV_P_ void *w, int revents); 744EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
691int ev_clear_pending (EV_P_ void *w); 745EV_API_DECL int ev_clear_pending (EV_P_ void *w) EV_THROW;
692 746
693void ev_io_start (EV_P_ ev_io *w); 747EV_API_DECL void ev_io_start (EV_P_ ev_io *w) EV_THROW;
694void ev_io_stop (EV_P_ ev_io *w); 748EV_API_DECL void ev_io_stop (EV_P_ ev_io *w) EV_THROW;
695 749
696void ev_timer_start (EV_P_ ev_timer *w); 750EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w) EV_THROW;
697void ev_timer_stop (EV_P_ ev_timer *w); 751EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w) EV_THROW;
698/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 752/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
699void ev_timer_again (EV_P_ ev_timer *w); 753EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w) EV_THROW;
700/* return remaining time */ 754/* return remaining time */
701ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 755EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_THROW;
702 756
703#if EV_PERIODIC_ENABLE 757#if EV_PERIODIC_ENABLE
704void ev_periodic_start (EV_P_ ev_periodic *w); 758EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_THROW;
705void ev_periodic_stop (EV_P_ ev_periodic *w); 759EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w) EV_THROW;
706void ev_periodic_again (EV_P_ ev_periodic *w); 760EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_THROW;
707#endif 761#endif
708 762
709/* only supported in the default loop */ 763/* only supported in the default loop */
710#if EV_SIGNAL_ENABLE 764#if EV_SIGNAL_ENABLE
711void ev_signal_start (EV_P_ ev_signal *w); 765EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w) EV_THROW;
712void ev_signal_stop (EV_P_ ev_signal *w); 766EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w) EV_THROW;
713#endif 767#endif
714 768
715/* only supported in the default loop */ 769/* only supported in the default loop */
716# if EV_CHILD_ENABLE 770# if EV_CHILD_ENABLE
717void ev_child_start (EV_P_ ev_child *w); 771EV_API_DECL void ev_child_start (EV_P_ ev_child *w) EV_THROW;
718void ev_child_stop (EV_P_ ev_child *w); 772EV_API_DECL void ev_child_stop (EV_P_ ev_child *w) EV_THROW;
719# endif 773# endif
720 774
721# if EV_STAT_ENABLE 775# if EV_STAT_ENABLE
722void ev_stat_start (EV_P_ ev_stat *w); 776EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w) EV_THROW;
723void ev_stat_stop (EV_P_ ev_stat *w); 777EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w) EV_THROW;
724void ev_stat_stat (EV_P_ ev_stat *w); 778EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w) EV_THROW;
725# endif 779# endif
726 780
727# if EV_IDLE_ENABLE 781# if EV_IDLE_ENABLE
728void ev_idle_start (EV_P_ ev_idle *w); 782EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w) EV_THROW;
729void ev_idle_stop (EV_P_ ev_idle *w); 783EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w) EV_THROW;
730# endif 784# endif
731 785
732#if EV_PREPARE_ENABLE 786#if EV_PREPARE_ENABLE
733void ev_prepare_start (EV_P_ ev_prepare *w); 787EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w) EV_THROW;
734void ev_prepare_stop (EV_P_ ev_prepare *w); 788EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w) EV_THROW;
735#endif 789#endif
736 790
737#if EV_CHECK_ENABLE 791#if EV_CHECK_ENABLE
738void ev_check_start (EV_P_ ev_check *w); 792EV_API_DECL void ev_check_start (EV_P_ ev_check *w) EV_THROW;
739void ev_check_stop (EV_P_ ev_check *w); 793EV_API_DECL void ev_check_stop (EV_P_ ev_check *w) EV_THROW;
740#endif 794#endif
741 795
742# if EV_FORK_ENABLE 796# if EV_FORK_ENABLE
743void ev_fork_start (EV_P_ ev_fork *w); 797EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w) EV_THROW;
744void ev_fork_stop (EV_P_ ev_fork *w); 798EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w) EV_THROW;
799# endif
800
801# if EV_CLEANUP_ENABLE
802EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w) EV_THROW;
803EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w) EV_THROW;
745# endif 804# endif
746 805
747# if EV_EMBED_ENABLE 806# if EV_EMBED_ENABLE
748/* only supported when loop to be embedded is in fact embeddable */ 807/* only supported when loop to be embedded is in fact embeddable */
749void ev_embed_start (EV_P_ ev_embed *w); 808EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w) EV_THROW;
750void ev_embed_stop (EV_P_ ev_embed *w); 809EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w) EV_THROW;
751void ev_embed_sweep (EV_P_ ev_embed *w); 810EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w) EV_THROW;
752# endif 811# endif
753 812
754# if EV_ASYNC_ENABLE 813# if EV_ASYNC_ENABLE
755void ev_async_start (EV_P_ ev_async *w); 814EV_API_DECL void ev_async_start (EV_P_ ev_async *w) EV_THROW;
756void ev_async_stop (EV_P_ ev_async *w); 815EV_API_DECL void ev_async_stop (EV_P_ ev_async *w) EV_THROW;
757void ev_async_send (EV_P_ ev_async *w); 816EV_API_DECL void ev_async_send (EV_P_ ev_async *w) EV_THROW;
758# endif
759
760#endif 817# endif
761 818
762#ifdef __cplusplus 819#if EV_COMPAT3
763} 820 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
821 #define EVLOOP_ONESHOT EVRUN_ONCE
822 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
823 #define EVUNLOOP_ONE EVBREAK_ONE
824 #define EVUNLOOP_ALL EVBREAK_ALL
825 #if EV_PROTOTYPES
826 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
827 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
828 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
829 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
830 #if EV_FEATURE_API
831 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
832 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
833 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
834 #endif
764#endif 835 #endif
765 836#else
837 typedef struct ev_loop ev_loop;
766#endif 838#endif
767 839
840#endif
841
842EV_CPP(})
843
844#endif
845

Diff Legend

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