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

Comparing libev/ev.h (file contents):
Revision 1.142 by root, Thu Oct 21 14:50:58 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
49/* pre-4.0 compatibility */ 55/* pre-4.0 compatibility */
50#ifndef EV_COMPAT3 56#ifndef EV_COMPAT3
51# define EV_COMPAT3 1 57# define EV_COMPAT3 1
52#endif 58#endif
53 59
54#ifndef EV_FEATURES 60#ifndef EV_FEATURES
61# if defined __OPTIMIZE_SIZE__
62# define EV_FEATURES 0x7c
63# else
55# define EV_FEATURES 0x7f 64# define EV_FEATURES 0x7f
65# endif
56#endif 66#endif
57 67
58#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 68#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
59#define EV_FEATURE_DATA ((EV_FEATURES) & 2) 69#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
60#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4) 70#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
… …
97 107
98#ifndef EV_FORK_ENABLE 108#ifndef EV_FORK_ENABLE
99# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 109# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
100#endif 110#endif
101 111
112#ifndef EV_CLEANUP_ENABLE
113# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
114#endif
115
102#ifndef EV_SIGNAL_ENABLE 116#ifndef EV_SIGNAL_ENABLE
103# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 117# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
104#endif 118#endif
105 119
106#ifndef EV_CHILD_ENABLE 120#ifndef EV_CHILD_ENABLE
… …
148#endif 162#endif
149 163
150/* support multiple event loops? */ 164/* support multiple event loops? */
151#if EV_MULTIPLICITY 165#if EV_MULTIPLICITY
152struct ev_loop; 166struct ev_loop;
153# define EV_P struct ev_loop *loop 167# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
154# define EV_P_ EV_P, 168# define EV_P_ EV_P, /* a loop as first of multiple parameters */
155# define EV_A loop 169# define EV_A loop /* a loop as sole argument to a function call */
156# define EV_A_ EV_A, 170# define EV_A_ EV_A, /* a loop as first of multiple arguments */
157# 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 */
158# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 172# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
159# define EV_DEFAULT ev_default_loop (0) 173# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
160# define EV_DEFAULT_ EV_DEFAULT, 174# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
161#else 175#else
162# define EV_P void 176# define EV_P void
163# define EV_P_ 177# define EV_P_
164# define EV_A 178# define EV_A
165# define EV_A_ 179# define EV_A_
… …
168# define EV_DEFAULT_UC 182# define EV_DEFAULT_UC
169# define EV_DEFAULT_UC_ 183# define EV_DEFAULT_UC_
170# undef EV_EMBED_ENABLE 184# undef EV_EMBED_ENABLE
171#endif 185#endif
172 186
187/* EV_INLINE is used for functions in header files */
173#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 188#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
174# define EV_INLINE static inline 189# define EV_INLINE static inline
175#else 190#else
176# define EV_INLINE static 191# define EV_INLINE static
177#endif 192#endif
178 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 */
179#ifndef EV_PROTOTYPES 201#ifndef EV_PROTOTYPES
180# define EV_PROTOTYPES 1 202# define EV_PROTOTYPES 1
181#endif 203#endif
182 204
183/*****************************************************************************/ 205/*****************************************************************************/
184 206
185#define EV_VERSION_MAJOR 4 207#define EV_VERSION_MAJOR 4
186#define EV_VERSION_MINOR 0 208#define EV_VERSION_MINOR 11
187 209
188/* eventmask, revents, events... */ 210/* eventmask, revents, events... */
189enum { 211enum {
190 EV_UNDEF = -1, /* guaranteed to be invalid */ 212 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
191 EV_NONE = 0x00, /* no events */ 213 EV_NONE = 0x00, /* no events */
192 EV_READ = 0x01, /* ev_io detected read will not block */ 214 EV_READ = 0x01, /* ev_io detected read will not block */
193 EV_WRITE = 0x02, /* ev_io detected write will not block */ 215 EV_WRITE = 0x02, /* ev_io detected write will not block */
194 EV__IOFDSET = 0x80, /* internal use only */ 216 EV__IOFDSET = 0x80, /* internal use only */
195 EV_IO = EV_READ, /* alias for type-detection */ 217 EV_IO = EV_READ, /* alias for type-detection */
196 EV_TIMER = 0x00000100, /* timer timed out */ 218 EV_TIMER = 0x00000100, /* timer timed out */
219#if EV_COMPAT3
197 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */ 220 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
221#endif
198 EV_PERIODIC = 0x00000200, /* periodic timer timed out */ 222 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
199 EV_SIGNAL = 0x00000400, /* signal was received */ 223 EV_SIGNAL = 0x00000400, /* signal was received */
200 EV_CHILD = 0x00000800, /* child/pid had status change */ 224 EV_CHILD = 0x00000800, /* child/pid had status change */
201 EV_STAT = 0x00001000, /* stat data changed */ 225 EV_STAT = 0x00001000, /* stat data changed */
202 EV_IDLE = 0x00002000, /* event loop is idling */ 226 EV_IDLE = 0x00002000, /* event loop is idling */
203 EV_PREPARE = 0x00004000, /* event loop about to poll */ 227 EV_PREPARE = 0x00004000, /* event loop about to poll */
204 EV_CHECK = 0x00008000, /* event loop finished poll */ 228 EV_CHECK = 0x00008000, /* event loop finished poll */
205 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 229 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
206 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 */
207 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 232 EV_ASYNC = 0x00080000, /* async intra-loop signal */
208 EV_CUSTOM = 0x01000000, /* for use by user code */ 233 EV_CUSTOM = 0x01000000, /* for use by user code */
209 EV_ERROR = 0x80000000 /* sent when an error occurs */ 234 EV_ERROR = 0x80000000 /* sent when an error occurs */
210}; 235};
211 236
212/* 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 */
… …
306{ 331{
307 EV_WATCHER_TIME (ev_periodic) 332 EV_WATCHER_TIME (ev_periodic)
308 333
309 ev_tstamp offset; /* rw */ 334 ev_tstamp offset; /* rw */
310 ev_tstamp interval; /* rw */ 335 ev_tstamp interval; /* rw */
311 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 */
312} ev_periodic; 337} ev_periodic;
313 338
314/* invoked when the given signal has been received */ 339/* invoked when the given signal has been received */
315/* revent EV_SIGNAL */ 340/* revent EV_SIGNAL */
316typedef struct ev_signal 341typedef struct ev_signal
… …
381 EV_WATCHER (ev_check) 406 EV_WATCHER (ev_check)
382} ev_check; 407} ev_check;
383 408
384#if EV_FORK_ENABLE 409#if EV_FORK_ENABLE
385/* 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 */
386typedef struct ev_fork 412typedef struct ev_fork
387{ 413{
388 EV_WATCHER (ev_fork) 414 EV_WATCHER (ev_fork)
389} 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;
390#endif 425#endif
391 426
392#if EV_EMBED_ENABLE 427#if EV_EMBED_ENABLE
393/* used to embed an event loop inside another */ 428/* used to embed an event loop inside another */
394/* 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 */
… …
402 ev_check check; /* unused */ 437 ev_check check; /* unused */
403 ev_timer timer; /* unused */ 438 ev_timer timer; /* unused */
404 ev_periodic periodic; /* unused */ 439 ev_periodic periodic; /* unused */
405 ev_idle idle; /* unused */ 440 ev_idle idle; /* unused */
406 ev_fork fork; /* private */ 441 ev_fork fork; /* private */
442#if EV_CLEANUP_ENABLE
443 ev_cleanup cleanup; /* unused */
444#endif
407} ev_embed; 445} ev_embed;
408#endif 446#endif
409 447
410#if EV_ASYNC_ENABLE 448#if EV_ASYNC_ENABLE
411/* invoked when somebody calls ev_async_send on the watcher */ 449/* invoked when somebody calls ev_async_send on the watcher */
… …
439#endif 477#endif
440 struct ev_prepare prepare; 478 struct ev_prepare prepare;
441 struct ev_check check; 479 struct ev_check check;
442#if EV_FORK_ENABLE 480#if EV_FORK_ENABLE
443 struct ev_fork fork; 481 struct ev_fork fork;
482#endif
483#if EV_CLEANUP_ENABLE
484 struct ev_cleanup cleanup;
444#endif 485#endif
445#if EV_EMBED_ENABLE 486#if EV_EMBED_ENABLE
446 struct ev_embed embed; 487 struct ev_embed embed;
447#endif 488#endif
448#if EV_ASYNC_ENABLE 489#if EV_ASYNC_ENABLE
… …
460 /* debugging/feature disable */ 501 /* debugging/feature disable */
461 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 502 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
462#if EV_COMPAT3 503#if EV_COMPAT3
463 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 504 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
464#endif 505#endif
465 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ 506 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
507 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
466}; 508};
467 509
468/* method bits to be ored together */ 510/* method bits to be ored together */
469enum { 511enum {
470 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 512 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
471 EVBACKEND_POLL = 0x00000002U, /* !win */ 513 EVBACKEND_POLL = 0x00000002U, /* !win */
472 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 514 EVBACKEND_EPOLL = 0x00000004U, /* linux */
473 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 515 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
474 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 516 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
475 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 517 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
476 EVBACKEND_ALL = 0x0000003FU 518 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
519 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
477}; 520};
478 521
479#if EV_PROTOTYPES 522#if EV_PROTOTYPES
480int ev_version_major (void); 523EV_API_DECL int ev_version_major (void) EV_THROW;
481int ev_version_minor (void); 524EV_API_DECL int ev_version_minor (void) EV_THROW;
482 525
483unsigned int ev_supported_backends (void); 526EV_API_DECL unsigned int ev_supported_backends (void) EV_THROW;
484unsigned int ev_recommended_backends (void); 527EV_API_DECL unsigned int ev_recommended_backends (void) EV_THROW;
485unsigned int ev_embeddable_backends (void); 528EV_API_DECL unsigned int ev_embeddable_backends (void) EV_THROW;
486 529
487ev_tstamp ev_time (void); 530EV_API_DECL ev_tstamp ev_time (void) EV_THROW;
488void ev_sleep (ev_tstamp delay); /* sleep for a while */ 531EV_API_DECL void ev_sleep (ev_tstamp delay) EV_THROW; /* sleep for a while */
489 532
490/* Sets the allocation function to use, works like realloc. 533/* Sets the allocation function to use, works like realloc.
491 * It is used to allocate and free memory. 534 * It is used to allocate and free memory.
492 * 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
493 * or take some potentially destructive action. 536 * or take some potentially destructive action.
494 * The default is your system realloc function. 537 * The default is your system realloc function.
495 */ 538 */
496void 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;
497 540
498/* set the callback function to call on a 541/* set the callback function to call on a
499 * retryable syscall error 542 * retryable syscall error
500 * (such as failed select, poll, epoll_wait) 543 * (such as failed select, poll, epoll_wait)
501 */ 544 */
502void 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;
503 546
504#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
505EV_INLINE struct ev_loop * 557EV_INLINE struct ev_loop *
506ev_default_loop_uc (void) 558ev_default_loop_uc_ (void) EV_THROW
507{ 559{
508 extern struct ev_loop *ev_default_loop_ptr; 560 extern struct ev_loop *ev_default_loop_ptr;
509 561
510 return ev_default_loop_ptr; 562 return ev_default_loop_ptr;
511} 563}
512 564
513/* the default loop is the only one that handles signals and child watchers */ 565EV_INLINE int
514/* you can call this as often as you like */ 566ev_is_default_loop (EV_P) EV_THROW
515EV_INLINE struct ev_loop *
516ev_default_loop (unsigned int flags)
517{ 567{
518 struct ev_loop *loop = ev_default_loop_uc (); 568 return EV_A == EV_DEFAULT_UC;
519
520 if (!loop)
521 {
522 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
523
524 loop = ev_default_loop_init (flags);
525 }
526
527 return loop;
528} 569}
529 570
530/* create and destroy alternative loops that don't handle signals */ 571/* create and destroy alternative loops that don't handle signals */
531struct 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;
532void ev_loop_destroy (EV_P);
533void ev_loop_fork (EV_P);
534 573
535ev_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 */
536 575
537#else 576#else
538 577
539int 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;
540 581
541EV_INLINE ev_tstamp 582EV_INLINE ev_tstamp
542ev_now (void) 583ev_now (void) EV_THROW
543{ 584{
544 extern ev_tstamp ev_rt_now;
545
546 return ev_rt_now; 585 return ev_rt_now;
547} 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
548#endif /* multiplicity */ 595#endif /* multiplicity */
549 596
550EV_INLINE int 597/* destroy event loops, also works for the default loop */
551ev_is_default_loop (EV_P) 598EV_API_DECL void ev_loop_destroy (EV_P) EV_THROW;
552{
553#if EV_MULTIPLICITY
554 extern struct ev_loop *ev_default_loop_ptr;
555 599
556 return !!(EV_A == ev_default_loop_ptr);
557#else
558 return 1;
559#endif
560}
561
562void ev_default_destroy (void); /* destroy the default loop */
563/* this needs to be called after fork, to duplicate the default loop */ 600/* this needs to be called after fork, to duplicate the loop */
564/* 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 */
565/* you can call it in either the parent or the child */ 602/* you can call it in either the parent or the child */
566/* you can actually call it at any time, anywhere :) */ 603/* you can actually call it at any time, anywhere :) */
567void ev_default_fork (void); 604EV_API_DECL void ev_loop_fork (EV_P) EV_THROW;
568 605
569unsigned 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 */
570 607
571void ev_now_update (EV_P); /* update event loop time */ 608EV_API_DECL void ev_now_update (EV_P) EV_THROW; /* update event loop time */
572 609
573#if EV_WALK_ENABLE 610#if EV_WALK_ENABLE
574/* 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 */
575/* callback on every such watcher. The callback might stop the watcher, */ 612/* callback on every such watcher. The callback might stop the watcher, */
576/* but do nothing else with the loop */ 613/* but do nothing else with the loop */
577void 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;
578#endif 615#endif
579 616
580#endif /* prototypes */ 617#endif /* prototypes */
581 618
582/* ev_run flags values */ 619/* ev_run flags values */
… …
591 EVBREAK_ONE = 1, /* unloop once */ 628 EVBREAK_ONE = 1, /* unloop once */
592 EVBREAK_ALL = 2 /* unloop all loops */ 629 EVBREAK_ALL = 2 /* unloop all loops */
593}; 630};
594 631
595#if EV_PROTOTYPES 632#if EV_PROTOTYPES
596void ev_run (EV_P_ int flags); 633EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
597void ev_break (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 */
598 635
599/* 636/*
600 * 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
601 * 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
602 * 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.
603 */ 640 */
604void ev_ref (EV_P); 641EV_API_DECL void ev_ref (EV_P) EV_THROW;
605void ev_unref (EV_P); 642EV_API_DECL void ev_unref (EV_P) EV_THROW;
606 643
607/* 644/*
608 * 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
609 * if timeout is < 0, do wait indefinitely 646 * if timeout is < 0, do wait indefinitely
610 */ 647 */
611void 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;
612 649
613# if EV_FEATURE_API 650# if EV_FEATURE_API
614unsigned int ev_iteration (EV_P); /* number of loop iterations */ 651EV_API_DECL unsigned int ev_iteration (EV_P) EV_THROW; /* number of loop iterations */
615unsigned 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 */
616void ev_verify (EV_P); /* abort if loop data corrupted */ 653EV_API_DECL void ev_verify (EV_P) EV_THROW; /* abort if loop data corrupted */
617 654
618void 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 */
619void 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 */
620 657
621/* advanced stuff for threading etc. support, see docs */ 658/* advanced stuff for threading etc. support, see docs */
622void ev_set_userdata (EV_P_ void *data); 659EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_THROW;
623void *ev_userdata (EV_P); 660EV_API_DECL void *ev_userdata (EV_P) EV_THROW;
624void 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;
625void 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;
626 663
627unsigned 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 */
628void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 665EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
629 666
630/* 667/*
631 * stop/start the timer handling. 668 * stop/start the timer handling.
632 */ 669 */
633void ev_suspend (EV_P); 670EV_API_DECL void ev_suspend (EV_P) EV_THROW;
634void ev_resume (EV_P); 671EV_API_DECL void ev_resume (EV_P) EV_THROW;
635#endif 672#endif
636 673
637#endif 674#endif
638 675
639/* 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 */
… …
654#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 */
655#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 */
656#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 */
657#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)
658#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 */
659#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 */
660 698
661#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)
662#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)
663#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)
… …
667#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)
668#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)
669#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)
670#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)
671#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)
672#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)
673 712
674#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 */
675#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 */
676 715
… …
692 731
693/* 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 */
694/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 733/* stopping (disabling, deleting) a watcher does nothing unless its already running */
695#if EV_PROTOTYPES 734#if EV_PROTOTYPES
696 735
697/* 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 */
698/* accepts any ev_watcher type */ 737/* accepts any ev_watcher type */
699void ev_feed_event (EV_P_ void *w, int revents); 738EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents) EV_THROW;
700void 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;
701#if EV_SIGNAL_ENABLE 740#if EV_SIGNAL_ENABLE
741EV_API_DECL void ev_feed_signal (int signum) EV_THROW;
702void ev_feed_signal_event (EV_P_ int signum); 742EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_THROW;
703#endif 743#endif
704void ev_invoke (EV_P_ void *w, int revents); 744EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
705int ev_clear_pending (EV_P_ void *w); 745EV_API_DECL int ev_clear_pending (EV_P_ void *w) EV_THROW;
706 746
707void ev_io_start (EV_P_ ev_io *w); 747EV_API_DECL void ev_io_start (EV_P_ ev_io *w) EV_THROW;
708void ev_io_stop (EV_P_ ev_io *w); 748EV_API_DECL void ev_io_stop (EV_P_ ev_io *w) EV_THROW;
709 749
710void ev_timer_start (EV_P_ ev_timer *w); 750EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w) EV_THROW;
711void ev_timer_stop (EV_P_ ev_timer *w); 751EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w) EV_THROW;
712/* 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 */
713void ev_timer_again (EV_P_ ev_timer *w); 753EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w) EV_THROW;
714/* return remaining time */ 754/* return remaining time */
715ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 755EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_THROW;
716 756
717#if EV_PERIODIC_ENABLE 757#if EV_PERIODIC_ENABLE
718void ev_periodic_start (EV_P_ ev_periodic *w); 758EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_THROW;
719void ev_periodic_stop (EV_P_ ev_periodic *w); 759EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w) EV_THROW;
720void ev_periodic_again (EV_P_ ev_periodic *w); 760EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_THROW;
721#endif 761#endif
722 762
723/* only supported in the default loop */ 763/* only supported in the default loop */
724#if EV_SIGNAL_ENABLE 764#if EV_SIGNAL_ENABLE
725void ev_signal_start (EV_P_ ev_signal *w); 765EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w) EV_THROW;
726void ev_signal_stop (EV_P_ ev_signal *w); 766EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w) EV_THROW;
727#endif 767#endif
728 768
729/* only supported in the default loop */ 769/* only supported in the default loop */
730# if EV_CHILD_ENABLE 770# if EV_CHILD_ENABLE
731void ev_child_start (EV_P_ ev_child *w); 771EV_API_DECL void ev_child_start (EV_P_ ev_child *w) EV_THROW;
732void ev_child_stop (EV_P_ ev_child *w); 772EV_API_DECL void ev_child_stop (EV_P_ ev_child *w) EV_THROW;
733# endif 773# endif
734 774
735# if EV_STAT_ENABLE 775# if EV_STAT_ENABLE
736void ev_stat_start (EV_P_ ev_stat *w); 776EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w) EV_THROW;
737void ev_stat_stop (EV_P_ ev_stat *w); 777EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w) EV_THROW;
738void ev_stat_stat (EV_P_ ev_stat *w); 778EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w) EV_THROW;
739# endif 779# endif
740 780
741# if EV_IDLE_ENABLE 781# if EV_IDLE_ENABLE
742void ev_idle_start (EV_P_ ev_idle *w); 782EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w) EV_THROW;
743void ev_idle_stop (EV_P_ ev_idle *w); 783EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w) EV_THROW;
744# endif 784# endif
745 785
746#if EV_PREPARE_ENABLE 786#if EV_PREPARE_ENABLE
747void ev_prepare_start (EV_P_ ev_prepare *w); 787EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w) EV_THROW;
748void ev_prepare_stop (EV_P_ ev_prepare *w); 788EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w) EV_THROW;
749#endif 789#endif
750 790
751#if EV_CHECK_ENABLE 791#if EV_CHECK_ENABLE
752void ev_check_start (EV_P_ ev_check *w); 792EV_API_DECL void ev_check_start (EV_P_ ev_check *w) EV_THROW;
753void ev_check_stop (EV_P_ ev_check *w); 793EV_API_DECL void ev_check_stop (EV_P_ ev_check *w) EV_THROW;
754#endif 794#endif
755 795
756# if EV_FORK_ENABLE 796# if EV_FORK_ENABLE
757void ev_fork_start (EV_P_ ev_fork *w); 797EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w) EV_THROW;
758void 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;
759# endif 804# endif
760 805
761# if EV_EMBED_ENABLE 806# if EV_EMBED_ENABLE
762/* only supported when loop to be embedded is in fact embeddable */ 807/* only supported when loop to be embedded is in fact embeddable */
763void ev_embed_start (EV_P_ ev_embed *w); 808EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w) EV_THROW;
764void ev_embed_stop (EV_P_ ev_embed *w); 809EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w) EV_THROW;
765void ev_embed_sweep (EV_P_ ev_embed *w); 810EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w) EV_THROW;
766# endif 811# endif
767 812
768# if EV_ASYNC_ENABLE 813# if EV_ASYNC_ENABLE
769void ev_async_start (EV_P_ ev_async *w); 814EV_API_DECL void ev_async_start (EV_P_ ev_async *w) EV_THROW;
770void ev_async_stop (EV_P_ ev_async *w); 815EV_API_DECL void ev_async_stop (EV_P_ ev_async *w) EV_THROW;
771void ev_async_send (EV_P_ ev_async *w); 816EV_API_DECL void ev_async_send (EV_P_ ev_async *w) EV_THROW;
772# endif 817# endif
773 818
774#if EV_COMPAT3 819#if EV_COMPAT3
775 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 820 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
776 #define EVLOOP_ONESHOT EVRUN_ONCE 821 #define EVLOOP_ONESHOT EVRUN_ONCE
… …
778 #define EVUNLOOP_ONE EVBREAK_ONE 823 #define EVUNLOOP_ONE EVBREAK_ONE
779 #define EVUNLOOP_ALL EVBREAK_ALL 824 #define EVUNLOOP_ALL EVBREAK_ALL
780 #if EV_PROTOTYPES 825 #if EV_PROTOTYPES
781 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 826 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
782 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 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); }
783 #if EV_FEATURE_API 830 #if EV_FEATURE_API
784 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 831 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
785 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 832 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
786 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 833 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
787 #endif 834 #endif
788 #endif 835 #endif
789#else 836#else
790 typedef struct ev_loop ev_loop; 837 typedef struct ev_loop ev_loop;
791#endif 838#endif
792 839
793#endif 840#endif
794 841
795#ifdef __cplusplus 842EV_CPP(})
796}
797#endif
798 843
799#endif 844#endif
800 845

Diff Legend

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