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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines