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.162 by root, Tue Dec 20 04:08:35 2011 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 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
44extern "C" { 49EV_CPP(extern "C" {)
45#endif
46 50
47/*****************************************************************************/ 51/*****************************************************************************/
48 52
49/* pre-4.0 compatibility */ 53/* pre-4.0 compatibility */
50#ifndef EV_COMPAT3 54#ifndef EV_COMPAT3
97 101
98#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
99# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
100#endif 104#endif
101 105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
108#endif
109
102#ifndef EV_SIGNAL_ENABLE 110#ifndef EV_SIGNAL_ENABLE
103# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
104#endif 112#endif
105 113
106#ifndef EV_CHILD_ENABLE 114#ifndef EV_CHILD_ENABLE
148#endif 156#endif
149 157
150/* support multiple event loops? */ 158/* support multiple event loops? */
151#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
152struct ev_loop; 160struct ev_loop;
153# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
154# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
155# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
156# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
157# define EV_DEFAULT_UC ev_default_loop_uc () 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
158# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
159# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
160# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
161#else 169#else
162# define EV_P void 170# define EV_P void
163# define EV_P_ 171# define EV_P_
164# define EV_A 172# define EV_A
165# define EV_A_ 173# define EV_A_
168# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
169# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
170# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
171#endif 179#endif
172 180
181/* EV_INLINE is used for functions in header files */
173#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
174# define EV_INLINE static inline 183# define EV_INLINE static inline
175#else 184#else
176# define EV_INLINE static 185# define EV_INLINE static
177#endif 186#endif
178 187
188#ifdef EV_API_STATIC
189# define EV_API_DECL static
190#else
191# define EV_API_DECL extern
192#endif
193
194/* EV_PROTOTYPES can be used to switch of prototype declarations */
179#ifndef EV_PROTOTYPES 195#ifndef EV_PROTOTYPES
180# define EV_PROTOTYPES 1 196# define EV_PROTOTYPES 1
181#endif 197#endif
182 198
183/*****************************************************************************/ 199/*****************************************************************************/
184 200
185#define EV_VERSION_MAJOR 4 201#define EV_VERSION_MAJOR 4
186#define EV_VERSION_MINOR 0 202#define EV_VERSION_MINOR 4
187 203
188/* eventmask, revents, events... */ 204/* eventmask, revents, events... */
189enum { 205enum {
190 EV_UNDEF = -1, /* guaranteed to be invalid */ 206 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
191 EV_NONE = 0x00, /* no events */ 207 EV_NONE = 0x00, /* no events */
192 EV_READ = 0x01, /* ev_io detected read will not block */ 208 EV_READ = 0x01, /* ev_io detected read will not block */
193 EV_WRITE = 0x02, /* ev_io detected write will not block */ 209 EV_WRITE = 0x02, /* ev_io detected write will not block */
194 EV__IOFDSET = 0x80, /* internal use only */ 210 EV__IOFDSET = 0x80, /* internal use only */
195 EV_IO = EV_READ, /* alias for type-detection */ 211 EV_IO = EV_READ, /* alias for type-detection */
196 EV_TIMER = 0x00000100, /* timer timed out */ 212 EV_TIMER = 0x00000100, /* timer timed out */
213#if EV_COMPAT3
197 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */ 214 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
215#endif
198 EV_PERIODIC = 0x00000200, /* periodic timer timed out */ 216 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
199 EV_SIGNAL = 0x00000400, /* signal was received */ 217 EV_SIGNAL = 0x00000400, /* signal was received */
200 EV_CHILD = 0x00000800, /* child/pid had status change */ 218 EV_CHILD = 0x00000800, /* child/pid had status change */
201 EV_STAT = 0x00001000, /* stat data changed */ 219 EV_STAT = 0x00001000, /* stat data changed */
202 EV_IDLE = 0x00002000, /* event loop is idling */ 220 EV_IDLE = 0x00002000, /* event loop is idling */
203 EV_PREPARE = 0x00004000, /* event loop about to poll */ 221 EV_PREPARE = 0x00004000, /* event loop about to poll */
204 EV_CHECK = 0x00008000, /* event loop finished poll */ 222 EV_CHECK = 0x00008000, /* event loop finished poll */
205 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 223 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
206 EV_FORK = 0x00020000, /* event loop resumed in child */ 224 EV_FORK = 0x00020000, /* event loop resumed in child */
225 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
207 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 226 EV_ASYNC = 0x00080000, /* async intra-loop signal */
208 EV_CUSTOM = 0x01000000, /* for use by user code */ 227 EV_CUSTOM = 0x01000000, /* for use by user code */
209 EV_ERROR = 0x80000000 /* sent when an error occurs */ 228 EV_ERROR = 0x80000000 /* sent when an error occurs */
210}; 229};
211 230
212/* can be used to add custom fields to all watchers, while losing binary compatibility */ 231/* can be used to add custom fields to all watchers, while losing binary compatibility */
381 EV_WATCHER (ev_check) 400 EV_WATCHER (ev_check)
382} ev_check; 401} ev_check;
383 402
384#if EV_FORK_ENABLE 403#if EV_FORK_ENABLE
385/* the callback gets invoked before check in the child process when a fork was detected */ 404/* the callback gets invoked before check in the child process when a fork was detected */
405/* revent EV_FORK */
386typedef struct ev_fork 406typedef struct ev_fork
387{ 407{
388 EV_WATCHER (ev_fork) 408 EV_WATCHER (ev_fork)
389} ev_fork; 409} ev_fork;
410#endif
411
412#if EV_CLEANUP_ENABLE
413/* is invoked just before the loop gets destroyed */
414/* revent EV_CLEANUP */
415typedef struct ev_cleanup
416{
417 EV_WATCHER (ev_cleanup)
418} ev_cleanup;
390#endif 419#endif
391 420
392#if EV_EMBED_ENABLE 421#if EV_EMBED_ENABLE
393/* used to embed an event loop inside another */ 422/* used to embed an event loop inside another */
394/* the callback gets invoked when the event loop has handled events, and can be 0 */ 423/* the callback gets invoked when the event loop has handled events, and can be 0 */
402 ev_check check; /* unused */ 431 ev_check check; /* unused */
403 ev_timer timer; /* unused */ 432 ev_timer timer; /* unused */
404 ev_periodic periodic; /* unused */ 433 ev_periodic periodic; /* unused */
405 ev_idle idle; /* unused */ 434 ev_idle idle; /* unused */
406 ev_fork fork; /* private */ 435 ev_fork fork; /* private */
436#if EV_CLEANUP_ENABLE
437 ev_cleanup cleanup; /* unused */
438#endif
407} ev_embed; 439} ev_embed;
408#endif 440#endif
409 441
410#if EV_ASYNC_ENABLE 442#if EV_ASYNC_ENABLE
411/* invoked when somebody calls ev_async_send on the watcher */ 443/* invoked when somebody calls ev_async_send on the watcher */
439#endif 471#endif
440 struct ev_prepare prepare; 472 struct ev_prepare prepare;
441 struct ev_check check; 473 struct ev_check check;
442#if EV_FORK_ENABLE 474#if EV_FORK_ENABLE
443 struct ev_fork fork; 475 struct ev_fork fork;
476#endif
477#if EV_CLEANUP_ENABLE
478 struct ev_cleanup cleanup;
444#endif 479#endif
445#if EV_EMBED_ENABLE 480#if EV_EMBED_ENABLE
446 struct ev_embed embed; 481 struct ev_embed embed;
447#endif 482#endif
448#if EV_ASYNC_ENABLE 483#if EV_ASYNC_ENABLE
460 /* debugging/feature disable */ 495 /* debugging/feature disable */
461 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 496 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
462#if EV_COMPAT3 497#if EV_COMPAT3
463 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 498 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
464#endif 499#endif
465 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ 500 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
501 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
466}; 502};
467 503
468/* method bits to be ored together */ 504/* method bits to be ored together */
469enum { 505enum {
470 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 506 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
471 EVBACKEND_POLL = 0x00000002U, /* !win */ 507 EVBACKEND_POLL = 0x00000002U, /* !win */
472 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 508 EVBACKEND_EPOLL = 0x00000004U, /* linux */
473 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 509 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
474 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 510 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
475 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 511 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
476 EVBACKEND_ALL = 0x0000003FU 512 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
513 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
477}; 514};
478 515
479#if EV_PROTOTYPES 516#if EV_PROTOTYPES
480int ev_version_major (void); 517EV_API_DECL int ev_version_major (void);
481int ev_version_minor (void); 518EV_API_DECL int ev_version_minor (void);
482 519
483unsigned int ev_supported_backends (void); 520EV_API_DECL unsigned int ev_supported_backends (void);
484unsigned int ev_recommended_backends (void); 521EV_API_DECL unsigned int ev_recommended_backends (void);
485unsigned int ev_embeddable_backends (void); 522EV_API_DECL unsigned int ev_embeddable_backends (void);
486 523
487ev_tstamp ev_time (void); 524EV_API_DECL ev_tstamp ev_time (void);
488void ev_sleep (ev_tstamp delay); /* sleep for a while */ 525EV_API_DECL void ev_sleep (ev_tstamp delay); /* sleep for a while */
489 526
490/* Sets the allocation function to use, works like realloc. 527/* Sets the allocation function to use, works like realloc.
491 * It is used to allocate and free memory. 528 * It is used to allocate and free memory.
492 * If it returns zero when memory needs to be allocated, the library might abort 529 * If it returns zero when memory needs to be allocated, the library might abort
493 * or take some potentially destructive action. 530 * or take some potentially destructive action.
494 * The default is your system realloc function. 531 * The default is your system realloc function.
495 */ 532 */
496void ev_set_allocator (void *(*cb)(void *ptr, long size)); 533EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size));
497 534
498/* set the callback function to call on a 535/* set the callback function to call on a
499 * retryable syscall error 536 * retryable syscall error
500 * (such as failed select, poll, epoll_wait) 537 * (such as failed select, poll, epoll_wait)
501 */ 538 */
502void ev_set_syserr_cb (void (*cb)(const char *msg)); 539EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg));
503 540
504#if EV_MULTIPLICITY 541#if EV_MULTIPLICITY
542
543/* the default loop is the only one that handles signals and child watchers */
544/* you can call this as often as you like */
545EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
546
547EV_API_DECL struct ev_loop *ev_default_loop_ptr;
548
505EV_INLINE struct ev_loop * 549EV_INLINE struct ev_loop *
506ev_default_loop_uc (void) 550ev_default_loop_uc_ (void)
507{ 551{
508 extern struct ev_loop *ev_default_loop_ptr; 552 extern struct ev_loop *ev_default_loop_ptr;
509 553
510 return ev_default_loop_ptr; 554 return ev_default_loop_ptr;
511} 555}
512 556
513/* the default loop is the only one that handles signals and child watchers */ 557EV_INLINE int
514/* you can call this as often as you like */ 558ev_is_default_loop (EV_P)
515EV_INLINE struct ev_loop *
516ev_default_loop (unsigned int flags)
517{ 559{
518 struct ev_loop *loop = ev_default_loop_uc (); 560 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} 561}
529 562
530/* create and destroy alternative loops that don't handle signals */ 563/* create and destroy alternative loops that don't handle signals */
531struct ev_loop *ev_loop_new (unsigned int flags); 564EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
532void ev_loop_destroy (EV_P);
533void ev_loop_fork (EV_P);
534 565
535ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 566EV_API_DECL ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
536 567
537#else 568#else
538 569
539int ev_default_loop (unsigned int flags); /* returns true when successful */ 570EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
571
572EV_API_DECL ev_tstamp ev_rt_now;
540 573
541EV_INLINE ev_tstamp 574EV_INLINE ev_tstamp
542ev_now (void) 575ev_now (void)
543{ 576{
544 extern ev_tstamp ev_rt_now;
545
546 return ev_rt_now; 577 return ev_rt_now;
547} 578}
579
580/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
581EV_INLINE int
582ev_is_default_loop (void)
583{
584 return 1;
585}
586
548#endif /* multiplicity */ 587#endif /* multiplicity */
549 588
550EV_INLINE int 589/* destroy event loops, also works for the default loop */
551ev_is_default_loop (EV_P) 590EV_API_DECL void ev_loop_destroy (EV_P);
552{
553#if EV_MULTIPLICITY
554 extern struct ev_loop *ev_default_loop_ptr;
555 591
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 */ 592/* 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 */ 593/* when you want to re-use it in the child */
565/* you can call it in either the parent or the child */ 594/* you can call it in either the parent or the child */
566/* you can actually call it at any time, anywhere :) */ 595/* you can actually call it at any time, anywhere :) */
567void ev_default_fork (void); 596EV_API_DECL void ev_loop_fork (EV_P);
568 597
569unsigned int ev_backend (EV_P); /* backend in use by loop */ 598EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */
570 599
571void ev_now_update (EV_P); /* update event loop time */ 600EV_API_DECL void ev_now_update (EV_P); /* update event loop time */
572 601
573#if EV_WALK_ENABLE 602#if EV_WALK_ENABLE
574/* walk (almost) all watchers in the loop of a given type, invoking the */ 603/* 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, */ 604/* callback on every such watcher. The callback might stop the watcher, */
576/* but do nothing else with the loop */ 605/* but do nothing else with the loop */
577void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 606EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
578#endif 607#endif
579 608
580#endif /* prototypes */ 609#endif /* prototypes */
581 610
582/* ev_run flags values */ 611/* ev_run flags values */
591 EVBREAK_ONE = 1, /* unloop once */ 620 EVBREAK_ONE = 1, /* unloop once */
592 EVBREAK_ALL = 2 /* unloop all loops */ 621 EVBREAK_ALL = 2 /* unloop all loops */
593}; 622};
594 623
595#if EV_PROTOTYPES 624#if EV_PROTOTYPES
596void ev_run (EV_P_ int flags); 625EV_API_DECL void 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 */ 626EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
598 627
599/* 628/*
600 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 629 * 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 630 * 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. 631 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
603 */ 632 */
604void ev_ref (EV_P); 633EV_API_DECL void ev_ref (EV_P);
605void ev_unref (EV_P); 634EV_API_DECL void ev_unref (EV_P);
606 635
607/* 636/*
608 * convenience function, wait for a single event, without registering an event watcher 637 * convenience function, wait for a single event, without registering an event watcher
609 * if timeout is < 0, do wait indefinitely 638 * if timeout is < 0, do wait indefinitely
610 */ 639 */
611void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 640EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
612 641
613# if EV_FEATURE_API 642# if EV_FEATURE_API
614unsigned int ev_iteration (EV_P); /* number of loop iterations */ 643EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */
615unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 644EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
616void ev_verify (EV_P); /* abort if loop data corrupted */ 645EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */
617 646
618void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 647EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* 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 */ 648EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
620 649
621/* advanced stuff for threading etc. support, see docs */ 650/* advanced stuff for threading etc. support, see docs */
622void ev_set_userdata (EV_P_ void *data); 651EV_API_DECL void ev_set_userdata (EV_P_ void *data);
623void *ev_userdata (EV_P); 652EV_API_DECL void *ev_userdata (EV_P);
624void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 653EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
625void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 654EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
626 655
627unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 656EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
628void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 657EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
629 658
630/* 659/*
631 * stop/start the timer handling. 660 * stop/start the timer handling.
632 */ 661 */
633void ev_suspend (EV_P); 662EV_API_DECL void ev_suspend (EV_P);
634void ev_resume (EV_P); 663EV_API_DECL void ev_resume (EV_P);
635#endif 664#endif
636 665
637#endif 666#endif
638 667
639/* these may evaluate ev multiple times, and the other arguments at most once */ 668/* 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 */ 683#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 */ 684#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 */ 685#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) 686#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 */ 687#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
688#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 */ 689#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
660 690
661#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 691#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) 692#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) 693#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) 697#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) 698#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) 699#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) 700#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) 701#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
702#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) 703#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
673 704
674#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 705#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 */ 706#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
676 707
692 723
693/* stopping (enabling, adding) a watcher does nothing if it is already running */ 724/* stopping (enabling, adding) a watcher does nothing if it is already running */
694/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 725/* stopping (disabling, deleting) a watcher does nothing unless its already running */
695#if EV_PROTOTYPES 726#if EV_PROTOTYPES
696 727
697/* feeds an event into a watcher as if the event actually occured */ 728/* feeds an event into a watcher as if the event actually occurred */
698/* accepts any ev_watcher type */ 729/* accepts any ev_watcher type */
699void ev_feed_event (EV_P_ void *w, int revents); 730EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents);
700void ev_feed_fd_event (EV_P_ int fd, int revents); 731EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents);
701#if EV_SIGNAL_ENABLE 732#if EV_SIGNAL_ENABLE
733EV_API_DECL void ev_feed_signal (int signum);
702void ev_feed_signal_event (EV_P_ int signum); 734EV_API_DECL void ev_feed_signal_event (EV_P_ int signum);
703#endif 735#endif
704void ev_invoke (EV_P_ void *w, int revents); 736EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
705int ev_clear_pending (EV_P_ void *w); 737EV_API_DECL int ev_clear_pending (EV_P_ void *w);
706 738
707void ev_io_start (EV_P_ ev_io *w); 739EV_API_DECL void ev_io_start (EV_P_ ev_io *w);
708void ev_io_stop (EV_P_ ev_io *w); 740EV_API_DECL void ev_io_stop (EV_P_ ev_io *w);
709 741
710void ev_timer_start (EV_P_ ev_timer *w); 742EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w);
711void ev_timer_stop (EV_P_ ev_timer *w); 743EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w);
712/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 744/* 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); 745EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w);
714/* return remaining time */ 746/* return remaining time */
715ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 747EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
716 748
717#if EV_PERIODIC_ENABLE 749#if EV_PERIODIC_ENABLE
718void ev_periodic_start (EV_P_ ev_periodic *w); 750EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w);
719void ev_periodic_stop (EV_P_ ev_periodic *w); 751EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w);
720void ev_periodic_again (EV_P_ ev_periodic *w); 752EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w);
721#endif 753#endif
722 754
723/* only supported in the default loop */ 755/* only supported in the default loop */
724#if EV_SIGNAL_ENABLE 756#if EV_SIGNAL_ENABLE
725void ev_signal_start (EV_P_ ev_signal *w); 757EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w);
726void ev_signal_stop (EV_P_ ev_signal *w); 758EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w);
727#endif 759#endif
728 760
729/* only supported in the default loop */ 761/* only supported in the default loop */
730# if EV_CHILD_ENABLE 762# if EV_CHILD_ENABLE
731void ev_child_start (EV_P_ ev_child *w); 763EV_API_DECL void ev_child_start (EV_P_ ev_child *w);
732void ev_child_stop (EV_P_ ev_child *w); 764EV_API_DECL void ev_child_stop (EV_P_ ev_child *w);
733# endif 765# endif
734 766
735# if EV_STAT_ENABLE 767# if EV_STAT_ENABLE
736void ev_stat_start (EV_P_ ev_stat *w); 768EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w);
737void ev_stat_stop (EV_P_ ev_stat *w); 769EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w);
738void ev_stat_stat (EV_P_ ev_stat *w); 770EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w);
739# endif 771# endif
740 772
741# if EV_IDLE_ENABLE 773# if EV_IDLE_ENABLE
742void ev_idle_start (EV_P_ ev_idle *w); 774EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w);
743void ev_idle_stop (EV_P_ ev_idle *w); 775EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w);
744# endif 776# endif
745 777
746#if EV_PREPARE_ENABLE 778#if EV_PREPARE_ENABLE
747void ev_prepare_start (EV_P_ ev_prepare *w); 779EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w);
748void ev_prepare_stop (EV_P_ ev_prepare *w); 780EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w);
749#endif 781#endif
750 782
751#if EV_CHECK_ENABLE 783#if EV_CHECK_ENABLE
752void ev_check_start (EV_P_ ev_check *w); 784EV_API_DECL void ev_check_start (EV_P_ ev_check *w);
753void ev_check_stop (EV_P_ ev_check *w); 785EV_API_DECL void ev_check_stop (EV_P_ ev_check *w);
754#endif 786#endif
755 787
756# if EV_FORK_ENABLE 788# if EV_FORK_ENABLE
757void ev_fork_start (EV_P_ ev_fork *w); 789EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w);
758void ev_fork_stop (EV_P_ ev_fork *w); 790EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w);
791# endif
792
793# if EV_CLEANUP_ENABLE
794EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w);
795EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w);
759# endif 796# endif
760 797
761# if EV_EMBED_ENABLE 798# if EV_EMBED_ENABLE
762/* only supported when loop to be embedded is in fact embeddable */ 799/* only supported when loop to be embedded is in fact embeddable */
763void ev_embed_start (EV_P_ ev_embed *w); 800EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w);
764void ev_embed_stop (EV_P_ ev_embed *w); 801EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w);
765void ev_embed_sweep (EV_P_ ev_embed *w); 802EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w);
766# endif 803# endif
767 804
768# if EV_ASYNC_ENABLE 805# if EV_ASYNC_ENABLE
769void ev_async_start (EV_P_ ev_async *w); 806EV_API_DECL void ev_async_start (EV_P_ ev_async *w);
770void ev_async_stop (EV_P_ ev_async *w); 807EV_API_DECL void ev_async_stop (EV_P_ ev_async *w);
771void ev_async_send (EV_P_ ev_async *w); 808EV_API_DECL void ev_async_send (EV_P_ ev_async *w);
772# endif 809# endif
773 810
774#if EV_COMPAT3 811#if EV_COMPAT3
775 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 812 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
776 #define EVLOOP_ONESHOT EVRUN_ONCE 813 #define EVLOOP_ONESHOT EVRUN_ONCE
778 #define EVUNLOOP_ONE EVBREAK_ONE 815 #define EVUNLOOP_ONE EVBREAK_ONE
779 #define EVUNLOOP_ALL EVBREAK_ALL 816 #define EVUNLOOP_ALL EVBREAK_ALL
780 #if EV_PROTOTYPES 817 #if EV_PROTOTYPES
781 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 818 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 ); } 819 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
820 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
821 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
783 #if EV_FEATURE_API 822 #if EV_FEATURE_API
784 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 823 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); } 824 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); } 825 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
787 #endif 826 #endif
788 #endif 827 #endif
789#else 828#else
790 typedef struct ev_loop ev_loop; 829 typedef struct ev_loop ev_loop;
791#endif 830#endif
792 831
793#endif 832#endif
794 833
795#ifdef __cplusplus 834EV_CPP(})
796}
797#endif
798 835
799#endif 836#endif
800 837

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines