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

Comparing libev/ev.h (file contents):
Revision 1.147 by root, Fri Oct 22 09:24:11 2010 UTC vs.
Revision 1.177 by root, Tue Sep 9 13:34:46 2014 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,
… …
44# define EV_CPP(x) x 44# define EV_CPP(x) x
45#else 45#else
46# define EV_CPP(x) 46# define EV_CPP(x)
47#endif 47#endif
48 48
49#define EV_THROW EV_CPP(throw())
50
51/* apple's proprietary clang fork errors out with exception specifications */
52/* in all sorts of places, so let's not even bother with them */
53/* users are strongly advised to install clang or gcc */
54#if __APPLE__ && __clang__
55# undef EV_THROW
56# define EV_THROW
57#endif
58
49EV_CPP(extern "C" {) 59EV_CPP(extern "C" {)
50 60
51/*****************************************************************************/ 61/*****************************************************************************/
52 62
53/* pre-4.0 compatibility */ 63/* pre-4.0 compatibility */
54#ifndef EV_COMPAT3 64#ifndef EV_COMPAT3
55# define EV_COMPAT3 1 65# define EV_COMPAT3 1
56#endif 66#endif
57 67
58#ifndef EV_FEATURES 68#ifndef EV_FEATURES
69# if defined __OPTIMIZE_SIZE__
70# define EV_FEATURES 0x7c
71# else
59# define EV_FEATURES 0x7f 72# define EV_FEATURES 0x7f
73# endif
60#endif 74#endif
61 75
62#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 76#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
63#define EV_FEATURE_DATA ((EV_FEATURES) & 2) 77#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
64#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4) 78#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
… …
101 115
102#ifndef EV_FORK_ENABLE 116#ifndef EV_FORK_ENABLE
103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 117# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
104#endif 118#endif
105 119
120#ifndef EV_CLEANUP_ENABLE
121# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
122#endif
123
106#ifndef EV_SIGNAL_ENABLE 124#ifndef EV_SIGNAL_ENABLE
107# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 125# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
108#endif 126#endif
109 127
110#ifndef EV_CHILD_ENABLE 128#ifndef EV_CHILD_ENABLE
… …
156struct ev_loop; 174struct ev_loop;
157# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */ 175# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
158# define EV_P_ EV_P, /* a loop as first of multiple parameters */ 176# define EV_P_ EV_P, /* a loop as first of multiple parameters */
159# define EV_A loop /* a loop as sole argument to a function call */ 177# define EV_A loop /* a loop as sole argument to a function call */
160# define EV_A_ EV_A, /* a loop as first of multiple arguments */ 178# define EV_A_ EV_A, /* a loop as first of multiple arguments */
161# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */ 179# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
162# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */ 180# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
163# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */ 181# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
164# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */ 182# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
165#else 183#else
166# define EV_P void 184# define EV_P void
… …
179# define EV_INLINE static inline 197# define EV_INLINE static inline
180#else 198#else
181# define EV_INLINE static 199# define EV_INLINE static
182#endif 200#endif
183 201
202#ifdef EV_API_STATIC
203# define EV_API_DECL static
204#else
205# define EV_API_DECL extern
206#endif
207
184/* EV_PROTOTYPES can be sued to switch of prototype declarations */ 208/* EV_PROTOTYPES can be used to switch of prototype declarations */
185#ifndef EV_PROTOTYPES 209#ifndef EV_PROTOTYPES
186# define EV_PROTOTYPES 1 210# define EV_PROTOTYPES 1
187#endif 211#endif
188 212
189/*****************************************************************************/ 213/*****************************************************************************/
190 214
191#define EV_VERSION_MAJOR 4 215#define EV_VERSION_MAJOR 4
192#define EV_VERSION_MINOR 0 216#define EV_VERSION_MINOR 18
193 217
194/* eventmask, revents, events... */ 218/* eventmask, revents, events... */
195enum { 219enum {
196 EV_UNDEF = -1, /* guaranteed to be invalid */ 220 EV_UNDEF = (int)0xFFFFFFFF, /* guaranteed to be invalid */
197 EV_NONE = 0x00, /* no events */ 221 EV_NONE = 0x00, /* no events */
198 EV_READ = 0x01, /* ev_io detected read will not block */ 222 EV_READ = 0x01, /* ev_io detected read will not block */
199 EV_WRITE = 0x02, /* ev_io detected write will not block */ 223 EV_WRITE = 0x02, /* ev_io detected write will not block */
200 EV__IOFDSET = 0x80, /* internal use only */ 224 EV__IOFDSET = 0x80, /* internal use only */
201 EV_IO = EV_READ, /* alias for type-detection */ 225 EV_IO = EV_READ, /* alias for type-detection */
202 EV_TIMER = 0x00000100, /* timer timed out */ 226 EV_TIMER = 0x00000100, /* timer timed out */
203#if EV_COMPAT3 227#if EV_COMPAT3
204 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */ 228 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
205#endif 229#endif
206 EV_PERIODIC = 0x00000200, /* periodic timer timed out */ 230 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
207 EV_SIGNAL = 0x00000400, /* signal was received */ 231 EV_SIGNAL = 0x00000400, /* signal was received */
208 EV_CHILD = 0x00000800, /* child/pid had status change */ 232 EV_CHILD = 0x00000800, /* child/pid had status change */
209 EV_STAT = 0x00001000, /* stat data changed */ 233 EV_STAT = 0x00001000, /* stat data changed */
210 EV_IDLE = 0x00002000, /* event loop is idling */ 234 EV_IDLE = 0x00002000, /* event loop is idling */
211 EV_PREPARE = 0x00004000, /* event loop about to poll */ 235 EV_PREPARE = 0x00004000, /* event loop about to poll */
212 EV_CHECK = 0x00008000, /* event loop finished poll */ 236 EV_CHECK = 0x00008000, /* event loop finished poll */
213 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 237 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
214 EV_FORK = 0x00020000, /* event loop resumed in child */ 238 EV_FORK = 0x00020000, /* event loop resumed in child */
239 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
215 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 240 EV_ASYNC = 0x00080000, /* async intra-loop signal */
216 EV_CUSTOM = 0x01000000, /* for use by user code */ 241 EV_CUSTOM = 0x01000000, /* for use by user code */
217 EV_ERROR = 0x80000000 /* sent when an error occurs */ 242 EV_ERROR = (int)0x80000000 /* sent when an error occurs */
218}; 243};
219 244
220/* can be used to add custom fields to all watchers, while losing binary compatibility */ 245/* can be used to add custom fields to all watchers, while losing binary compatibility */
221#ifndef EV_COMMON 246#ifndef EV_COMMON
222# define EV_COMMON void *data; 247# define EV_COMMON void *data;
… …
314{ 339{
315 EV_WATCHER_TIME (ev_periodic) 340 EV_WATCHER_TIME (ev_periodic)
316 341
317 ev_tstamp offset; /* rw */ 342 ev_tstamp offset; /* rw */
318 ev_tstamp interval; /* rw */ 343 ev_tstamp interval; /* rw */
319 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 344 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) EV_THROW; /* rw */
320} ev_periodic; 345} ev_periodic;
321 346
322/* invoked when the given signal has been received */ 347/* invoked when the given signal has been received */
323/* revent EV_SIGNAL */ 348/* revent EV_SIGNAL */
324typedef struct ev_signal 349typedef struct ev_signal
… …
389 EV_WATCHER (ev_check) 414 EV_WATCHER (ev_check)
390} ev_check; 415} ev_check;
391 416
392#if EV_FORK_ENABLE 417#if EV_FORK_ENABLE
393/* the callback gets invoked before check in the child process when a fork was detected */ 418/* the callback gets invoked before check in the child process when a fork was detected */
419/* revent EV_FORK */
394typedef struct ev_fork 420typedef struct ev_fork
395{ 421{
396 EV_WATCHER (ev_fork) 422 EV_WATCHER (ev_fork)
397} ev_fork; 423} ev_fork;
424#endif
425
426#if EV_CLEANUP_ENABLE
427/* is invoked just before the loop gets destroyed */
428/* revent EV_CLEANUP */
429typedef struct ev_cleanup
430{
431 EV_WATCHER (ev_cleanup)
432} ev_cleanup;
398#endif 433#endif
399 434
400#if EV_EMBED_ENABLE 435#if EV_EMBED_ENABLE
401/* used to embed an event loop inside another */ 436/* used to embed an event loop inside another */
402/* the callback gets invoked when the event loop has handled events, and can be 0 */ 437/* the callback gets invoked when the event loop has handled events, and can be 0 */
… …
410 ev_check check; /* unused */ 445 ev_check check; /* unused */
411 ev_timer timer; /* unused */ 446 ev_timer timer; /* unused */
412 ev_periodic periodic; /* unused */ 447 ev_periodic periodic; /* unused */
413 ev_idle idle; /* unused */ 448 ev_idle idle; /* unused */
414 ev_fork fork; /* private */ 449 ev_fork fork; /* private */
450#if EV_CLEANUP_ENABLE
451 ev_cleanup cleanup; /* unused */
452#endif
415} ev_embed; 453} ev_embed;
416#endif 454#endif
417 455
418#if EV_ASYNC_ENABLE 456#if EV_ASYNC_ENABLE
419/* invoked when somebody calls ev_async_send on the watcher */ 457/* invoked when somebody calls ev_async_send on the watcher */
… …
447#endif 485#endif
448 struct ev_prepare prepare; 486 struct ev_prepare prepare;
449 struct ev_check check; 487 struct ev_check check;
450#if EV_FORK_ENABLE 488#if EV_FORK_ENABLE
451 struct ev_fork fork; 489 struct ev_fork fork;
490#endif
491#if EV_CLEANUP_ENABLE
492 struct ev_cleanup cleanup;
452#endif 493#endif
453#if EV_EMBED_ENABLE 494#if EV_EMBED_ENABLE
454 struct ev_embed embed; 495 struct ev_embed embed;
455#endif 496#endif
456#if EV_ASYNC_ENABLE 497#if EV_ASYNC_ENABLE
… …
468 /* debugging/feature disable */ 509 /* debugging/feature disable */
469 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 510 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
470#if EV_COMPAT3 511#if EV_COMPAT3
471 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 512 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
472#endif 513#endif
473 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ 514 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
515 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
474}; 516};
475 517
476/* method bits to be ored together */ 518/* method bits to be ored together */
477enum { 519enum {
478 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 520 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
479 EVBACKEND_POLL = 0x00000002U, /* !win */ 521 EVBACKEND_POLL = 0x00000002U, /* !win */
480 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 522 EVBACKEND_EPOLL = 0x00000004U, /* linux */
481 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 523 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
482 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 524 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
483 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 525 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
484 EVBACKEND_ALL = 0x0000003FU 526 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
527 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
485}; 528};
486 529
487#if EV_PROTOTYPES 530#if EV_PROTOTYPES
488int ev_version_major (void); 531EV_API_DECL int ev_version_major (void) EV_THROW;
489int ev_version_minor (void); 532EV_API_DECL int ev_version_minor (void) EV_THROW;
490 533
491unsigned int ev_supported_backends (void); 534EV_API_DECL unsigned int ev_supported_backends (void) EV_THROW;
492unsigned int ev_recommended_backends (void); 535EV_API_DECL unsigned int ev_recommended_backends (void) EV_THROW;
493unsigned int ev_embeddable_backends (void); 536EV_API_DECL unsigned int ev_embeddable_backends (void) EV_THROW;
494 537
495ev_tstamp ev_time (void); 538EV_API_DECL ev_tstamp ev_time (void) EV_THROW;
496void ev_sleep (ev_tstamp delay); /* sleep for a while */ 539EV_API_DECL void ev_sleep (ev_tstamp delay) EV_THROW; /* sleep for a while */
497 540
498/* Sets the allocation function to use, works like realloc. 541/* Sets the allocation function to use, works like realloc.
499 * It is used to allocate and free memory. 542 * It is used to allocate and free memory.
500 * If it returns zero when memory needs to be allocated, the library might abort 543 * If it returns zero when memory needs to be allocated, the library might abort
501 * or take some potentially destructive action. 544 * or take some potentially destructive action.
502 * The default is your system realloc function. 545 * The default is your system realloc function.
503 */ 546 */
504void ev_set_allocator (void *(*cb)(void *ptr, long size)); 547EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size) EV_THROW) EV_THROW;
505 548
506/* set the callback function to call on a 549/* set the callback function to call on a
507 * retryable syscall error 550 * retryable syscall error
508 * (such as failed select, poll, epoll_wait) 551 * (such as failed select, poll, epoll_wait)
509 */ 552 */
510void ev_set_syserr_cb (void (*cb)(const char *msg)); 553EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg) EV_THROW) EV_THROW;
511 554
512#if EV_MULTIPLICITY 555#if EV_MULTIPLICITY
556
557/* the default loop is the only one that handles signals and child watchers */
558/* you can call this as often as you like */
559EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW;
560
561#ifdef EV_API_STATIC
562EV_API_DECL struct ev_loop *ev_default_loop_ptr;
563#endif
564
513EV_INLINE struct ev_loop * 565EV_INLINE struct ev_loop *
514ev_default_loop_uc (void) 566ev_default_loop_uc_ (void) EV_THROW
515{ 567{
516 extern struct ev_loop *ev_default_loop_ptr; 568 extern struct ev_loop *ev_default_loop_ptr;
517 569
518 return ev_default_loop_ptr; 570 return ev_default_loop_ptr;
519} 571}
520 572
521/* the default loop is the only one that handles signals and child watchers */ 573EV_INLINE int
522/* you can call this as often as you like */ 574ev_is_default_loop (EV_P) EV_THROW
523EV_INLINE struct ev_loop *
524ev_default_loop (unsigned int flags EV_CPP (= 0))
525{ 575{
526 struct ev_loop *loop = ev_default_loop_uc (); 576 return EV_A == EV_DEFAULT_UC;
527
528 if (!loop)
529 {
530 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
531
532 loop = ev_default_loop_init (flags);
533 }
534
535 return loop;
536} 577}
537 578
538/* create and destroy alternative loops that don't handle signals */ 579/* create and destroy alternative loops that don't handle signals */
539struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); 580EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)) EV_THROW;
540void ev_loop_destroy (EV_P);
541void ev_loop_fork (EV_P);
542 581
543ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 582EV_API_DECL ev_tstamp ev_now (EV_P) EV_THROW; /* time w.r.t. timers and the eventloop, updated after each poll */
544 583
545#else 584#else
546 585
547int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */ 586EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW; /* returns true when successful */
587
588EV_API_DECL ev_tstamp ev_rt_now;
548 589
549EV_INLINE ev_tstamp 590EV_INLINE ev_tstamp
550ev_now (void) 591ev_now (void) EV_THROW
551{ 592{
552 extern ev_tstamp ev_rt_now;
553
554 return ev_rt_now; 593 return ev_rt_now;
555} 594}
595
596/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
597EV_INLINE int
598ev_is_default_loop (void) EV_THROW
599{
600 return 1;
601}
602
556#endif /* multiplicity */ 603#endif /* multiplicity */
557 604
558EV_INLINE int 605/* destroy event loops, also works for the default loop */
559ev_is_default_loop (EV_P) 606EV_API_DECL void ev_loop_destroy (EV_P);
560{
561#if EV_MULTIPLICITY
562 extern struct ev_loop *ev_default_loop_ptr;
563 607
564 return !!(EV_A == ev_default_loop_ptr);
565#else
566 return 1;
567#endif
568}
569
570void ev_default_destroy (void); /* destroy the default loop */
571/* this needs to be called after fork, to duplicate the default loop */ 608/* this needs to be called after fork, to duplicate the loop */
572/* if you create alternative loops you have to call ev_loop_fork on them */ 609/* when you want to re-use it in the child */
573/* you can call it in either the parent or the child */ 610/* you can call it in either the parent or the child */
574/* you can actually call it at any time, anywhere :) */ 611/* you can actually call it at any time, anywhere :) */
575void ev_default_fork (void); 612EV_API_DECL void ev_loop_fork (EV_P) EV_THROW;
576 613
577unsigned int ev_backend (EV_P); /* backend in use by loop */ 614EV_API_DECL unsigned int ev_backend (EV_P) EV_THROW; /* backend in use by loop */
578 615
579void ev_now_update (EV_P); /* update event loop time */ 616EV_API_DECL void ev_now_update (EV_P) EV_THROW; /* update event loop time */
580 617
581#if EV_WALK_ENABLE 618#if EV_WALK_ENABLE
582/* walk (almost) all watchers in the loop of a given type, invoking the */ 619/* walk (almost) all watchers in the loop of a given type, invoking the */
583/* callback on every such watcher. The callback might stop the watcher, */ 620/* callback on every such watcher. The callback might stop the watcher, */
584/* but do nothing else with the loop */ 621/* but do nothing else with the loop */
585void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 622EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)) EV_THROW;
586#endif 623#endif
587 624
588#endif /* prototypes */ 625#endif /* prototypes */
589 626
590/* ev_run flags values */ 627/* ev_run flags values */
… …
599 EVBREAK_ONE = 1, /* unloop once */ 636 EVBREAK_ONE = 1, /* unloop once */
600 EVBREAK_ALL = 2 /* unloop all loops */ 637 EVBREAK_ALL = 2 /* unloop all loops */
601}; 638};
602 639
603#if EV_PROTOTYPES 640#if EV_PROTOTYPES
604void ev_run (EV_P_ int flags EV_CPP (= 0)); 641EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
605void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */ 642EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)) EV_THROW; /* break out of the loop */
606 643
607/* 644/*
608 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 645 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
609 * keeps one reference. if you have a long-running watcher you never unregister that 646 * keeps one reference. if you have a long-running watcher you never unregister that
610 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 647 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
611 */ 648 */
612void ev_ref (EV_P); 649EV_API_DECL void ev_ref (EV_P) EV_THROW;
613void ev_unref (EV_P); 650EV_API_DECL void ev_unref (EV_P) EV_THROW;
614 651
615/* 652/*
616 * convenience function, wait for a single event, without registering an event watcher 653 * convenience function, wait for a single event, without registering an event watcher
617 * if timeout is < 0, do wait indefinitely 654 * if timeout is < 0, do wait indefinitely
618 */ 655 */
619void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 656EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg) EV_THROW;
620 657
621# if EV_FEATURE_API 658# if EV_FEATURE_API
622unsigned int ev_iteration (EV_P); /* number of loop iterations */ 659EV_API_DECL unsigned int ev_iteration (EV_P) EV_THROW; /* number of loop iterations */
623unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 660EV_API_DECL unsigned int ev_depth (EV_P) EV_THROW; /* #ev_loop enters - #ev_loop leaves */
624void ev_verify (EV_P); /* abort if loop data corrupted */ 661EV_API_DECL void ev_verify (EV_P) EV_THROW; /* abort if loop data corrupted */
625 662
626void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 663EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
627void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 664EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
628 665
629/* advanced stuff for threading etc. support, see docs */ 666/* advanced stuff for threading etc. support, see docs */
630void ev_set_userdata (EV_P_ void *data); 667EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_THROW;
631void *ev_userdata (EV_P); 668EV_API_DECL void *ev_userdata (EV_P) EV_THROW;
632void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 669typedef void (*ev_loop_callback)(EV_P);
633void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 670EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ ev_loop_callback invoke_pending_cb) EV_THROW;
671EV_API_DECL void ev_set_loop_release_cb (EV_P_ ev_loop_callback EV_THROW release, ev_loop_callback EV_THROW acquire) EV_THROW;
634 672
635unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 673EV_API_DECL unsigned int ev_pending_count (EV_P) EV_THROW; /* number of pending events, if any */
636void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 674EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
637 675
638/* 676/*
639 * stop/start the timer handling. 677 * stop/start the timer handling.
640 */ 678 */
641void ev_suspend (EV_P); 679EV_API_DECL void ev_suspend (EV_P) EV_THROW;
642void ev_resume (EV_P); 680EV_API_DECL void ev_resume (EV_P) EV_THROW;
643#endif 681#endif
644 682
645#endif 683#endif
646 684
647/* these may evaluate ev multiple times, and the other arguments at most once */ 685/* these may evaluate ev multiple times, and the other arguments at most once */
… …
662#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 700#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
663#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 701#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
664#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 702#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
665#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 703#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
666#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 704#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
705#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
667#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ 706#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
668 707
669#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 708#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
670#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 709#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
671#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 710#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
… …
675#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 714#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
676#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 715#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
677#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 716#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
678#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 717#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
679#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 718#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
719#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
680#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 720#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
681 721
682#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 722#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
683#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 723#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
684 724
… …
697#ifndef ev_set_cb 737#ifndef ev_set_cb
698# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 738# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
699#endif 739#endif
700 740
701/* stopping (enabling, adding) a watcher does nothing if it is already running */ 741/* stopping (enabling, adding) a watcher does nothing if it is already running */
702/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 742/* stopping (disabling, deleting) a watcher does nothing unless it's already running */
703#if EV_PROTOTYPES 743#if EV_PROTOTYPES
704 744
705/* feeds an event into a watcher as if the event actually occured */ 745/* feeds an event into a watcher as if the event actually occurred */
706/* accepts any ev_watcher type */ 746/* accepts any ev_watcher type */
707void ev_feed_event (EV_P_ void *w, int revents); 747EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents) EV_THROW;
708void ev_feed_fd_event (EV_P_ int fd, int revents); 748EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents) EV_THROW;
709#if EV_SIGNAL_ENABLE 749#if EV_SIGNAL_ENABLE
750EV_API_DECL void ev_feed_signal (int signum) EV_THROW;
710void ev_feed_signal_event (EV_P_ int signum); 751EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_THROW;
711#endif 752#endif
712void ev_invoke (EV_P_ void *w, int revents); 753EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
713int ev_clear_pending (EV_P_ void *w); 754EV_API_DECL int ev_clear_pending (EV_P_ void *w) EV_THROW;
714 755
715void ev_io_start (EV_P_ ev_io *w); 756EV_API_DECL void ev_io_start (EV_P_ ev_io *w) EV_THROW;
716void ev_io_stop (EV_P_ ev_io *w); 757EV_API_DECL void ev_io_stop (EV_P_ ev_io *w) EV_THROW;
717 758
718void ev_timer_start (EV_P_ ev_timer *w); 759EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w) EV_THROW;
719void ev_timer_stop (EV_P_ ev_timer *w); 760EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w) EV_THROW;
720/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 761/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
721void ev_timer_again (EV_P_ ev_timer *w); 762EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w) EV_THROW;
722/* return remaining time */ 763/* return remaining time */
723ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 764EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_THROW;
724 765
725#if EV_PERIODIC_ENABLE 766#if EV_PERIODIC_ENABLE
726void ev_periodic_start (EV_P_ ev_periodic *w); 767EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_THROW;
727void ev_periodic_stop (EV_P_ ev_periodic *w); 768EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w) EV_THROW;
728void ev_periodic_again (EV_P_ ev_periodic *w); 769EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_THROW;
729#endif 770#endif
730 771
731/* only supported in the default loop */ 772/* only supported in the default loop */
732#if EV_SIGNAL_ENABLE 773#if EV_SIGNAL_ENABLE
733void ev_signal_start (EV_P_ ev_signal *w); 774EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w) EV_THROW;
734void ev_signal_stop (EV_P_ ev_signal *w); 775EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w) EV_THROW;
735#endif 776#endif
736 777
737/* only supported in the default loop */ 778/* only supported in the default loop */
738# if EV_CHILD_ENABLE 779# if EV_CHILD_ENABLE
739void ev_child_start (EV_P_ ev_child *w); 780EV_API_DECL void ev_child_start (EV_P_ ev_child *w) EV_THROW;
740void ev_child_stop (EV_P_ ev_child *w); 781EV_API_DECL void ev_child_stop (EV_P_ ev_child *w) EV_THROW;
741# endif 782# endif
742 783
743# if EV_STAT_ENABLE 784# if EV_STAT_ENABLE
744void ev_stat_start (EV_P_ ev_stat *w); 785EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w) EV_THROW;
745void ev_stat_stop (EV_P_ ev_stat *w); 786EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w) EV_THROW;
746void ev_stat_stat (EV_P_ ev_stat *w); 787EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w) EV_THROW;
747# endif 788# endif
748 789
749# if EV_IDLE_ENABLE 790# if EV_IDLE_ENABLE
750void ev_idle_start (EV_P_ ev_idle *w); 791EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w) EV_THROW;
751void ev_idle_stop (EV_P_ ev_idle *w); 792EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w) EV_THROW;
752# endif 793# endif
753 794
754#if EV_PREPARE_ENABLE 795#if EV_PREPARE_ENABLE
755void ev_prepare_start (EV_P_ ev_prepare *w); 796EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w) EV_THROW;
756void ev_prepare_stop (EV_P_ ev_prepare *w); 797EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w) EV_THROW;
757#endif 798#endif
758 799
759#if EV_CHECK_ENABLE 800#if EV_CHECK_ENABLE
760void ev_check_start (EV_P_ ev_check *w); 801EV_API_DECL void ev_check_start (EV_P_ ev_check *w) EV_THROW;
761void ev_check_stop (EV_P_ ev_check *w); 802EV_API_DECL void ev_check_stop (EV_P_ ev_check *w) EV_THROW;
762#endif 803#endif
763 804
764# if EV_FORK_ENABLE 805# if EV_FORK_ENABLE
765void ev_fork_start (EV_P_ ev_fork *w); 806EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w) EV_THROW;
766void ev_fork_stop (EV_P_ ev_fork *w); 807EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w) EV_THROW;
808# endif
809
810# if EV_CLEANUP_ENABLE
811EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w) EV_THROW;
812EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w) EV_THROW;
767# endif 813# endif
768 814
769# if EV_EMBED_ENABLE 815# if EV_EMBED_ENABLE
770/* only supported when loop to be embedded is in fact embeddable */ 816/* only supported when loop to be embedded is in fact embeddable */
771void ev_embed_start (EV_P_ ev_embed *w); 817EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w) EV_THROW;
772void ev_embed_stop (EV_P_ ev_embed *w); 818EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w) EV_THROW;
773void ev_embed_sweep (EV_P_ ev_embed *w); 819EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w) EV_THROW;
774# endif 820# endif
775 821
776# if EV_ASYNC_ENABLE 822# if EV_ASYNC_ENABLE
777void ev_async_start (EV_P_ ev_async *w); 823EV_API_DECL void ev_async_start (EV_P_ ev_async *w) EV_THROW;
778void ev_async_stop (EV_P_ ev_async *w); 824EV_API_DECL void ev_async_stop (EV_P_ ev_async *w) EV_THROW;
779void ev_async_send (EV_P_ ev_async *w); 825EV_API_DECL void ev_async_send (EV_P_ ev_async *w) EV_THROW;
780# endif 826# endif
781 827
782#if EV_COMPAT3 828#if EV_COMPAT3
783 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 829 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
784 #define EVLOOP_ONESHOT EVRUN_ONCE 830 #define EVLOOP_ONESHOT EVRUN_ONCE
… …
786 #define EVUNLOOP_ONE EVBREAK_ONE 832 #define EVUNLOOP_ONE EVBREAK_ONE
787 #define EVUNLOOP_ALL EVBREAK_ALL 833 #define EVUNLOOP_ALL EVBREAK_ALL
788 #if EV_PROTOTYPES 834 #if EV_PROTOTYPES
789 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 835 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
790 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 836 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
837 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
838 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
791 #if EV_FEATURE_API 839 #if EV_FEATURE_API
792 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 840 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
793 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 841 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
794 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 842 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
795 #endif 843 #endif
796 #endif 844 #endif
797#else 845#else
798 typedef struct ev_loop ev_loop; 846 typedef struct ev_loop ev_loop;
799#endif 847#endif

Diff Legend

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