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

Comparing libev/ev.h (file contents):
Revision 1.146 by root, Fri Oct 22 06:14:28 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
… …
143# ifdef _WIN32 155# ifdef _WIN32
144# include <time.h> 156# include <time.h>
145# include <sys/types.h> 157# include <sys/types.h>
146# endif 158# endif
147# include <sys/stat.h> 159# include <sys/stat.h>
148#endif
149
150/* in C++ we can use this to provide default arguments */
151#ifdef __cplusplus
152# define EV_DEFARG(x) = x
153#else
154# define EV_DEFARG(x)
155#endif 160#endif
156 161
157/* support multiple event loops? */ 162/* support multiple event loops? */
158#if EV_MULTIPLICITY 163#if EV_MULTIPLICITY
159struct ev_loop; 164struct ev_loop;
160# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */ 165# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
161# define EV_P_ EV_P, /* a loop as first of multiple parameters */ 166# define EV_P_ EV_P, /* a loop as first of multiple parameters */
162# define EV_A loop /* a loop as sole argument to a function call */ 167# define EV_A loop /* a loop as sole argument to a function call */
163# define EV_A_ EV_A, /* a loop as first of multiple arguments */ 168# define EV_A_ EV_A, /* a loop as first of multiple arguments */
164# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */ 169# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
165# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */ 170# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
166# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */ 171# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
167# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */ 172# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
168# define EV_PDEF EV_P EV_DEFARG (EV_DEFAULT_UC) /* EV_P, but with default argument in C++ */
169# define EV_PDEF_ EV_P EV_DEFARG (EV_DEFAULT_UC), /* EV_P_, but with default argument in C++ */
170#else 173#else
171# define EV_P void 174# define EV_P void
172# define EV_P_ 175# define EV_P_
173# define EV_A 176# define EV_A
174# define EV_A_ 177# define EV_A_
175# define EV_DEFAULT 178# define EV_DEFAULT
176# define EV_DEFAULT_ 179# define EV_DEFAULT_
177# define EV_DEFAULT_UC 180# define EV_DEFAULT_UC
178# define EV_DEFAULT_UC_ 181# define EV_DEFAULT_UC_
179# define EV_PDEF EV_P
180# define EV_PDEF_ EV_P_
181# undef EV_EMBED_ENABLE 182# undef EV_EMBED_ENABLE
182#endif 183#endif
183 184
184/* EV_INLINE is used for functions in header files */ 185/* EV_INLINE is used for functions in header files */
185#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 186#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
186# define EV_INLINE static inline 187# define EV_INLINE static inline
187#else 188#else
188# define EV_INLINE static 189# define EV_INLINE static
189#endif 190#endif
190 191
192#ifdef EV_API_STATIC
193# define EV_API_DECL static
194#else
195# define EV_API_DECL extern
196#endif
197
191/* EV_PROTOTYPES can be sued to switch of prototype declarations */ 198/* EV_PROTOTYPES can be used to switch of prototype declarations */
192#ifndef EV_PROTOTYPES 199#ifndef EV_PROTOTYPES
193# define EV_PROTOTYPES 1 200# define EV_PROTOTYPES 1
194#endif 201#endif
195 202
196/*****************************************************************************/ 203/*****************************************************************************/
197 204
198#define EV_VERSION_MAJOR 4 205#define EV_VERSION_MAJOR 4
199#define EV_VERSION_MINOR 0 206#define EV_VERSION_MINOR 11
200 207
201/* eventmask, revents, events... */ 208/* eventmask, revents, events... */
202enum { 209enum {
203 EV_UNDEF = -1, /* guaranteed to be invalid */ 210 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
204 EV_NONE = 0x00, /* no events */ 211 EV_NONE = 0x00, /* no events */
205 EV_READ = 0x01, /* ev_io detected read will not block */ 212 EV_READ = 0x01, /* ev_io detected read will not block */
206 EV_WRITE = 0x02, /* ev_io detected write will not block */ 213 EV_WRITE = 0x02, /* ev_io detected write will not block */
207 EV__IOFDSET = 0x80, /* internal use only */ 214 EV__IOFDSET = 0x80, /* internal use only */
208 EV_IO = EV_READ, /* alias for type-detection */ 215 EV_IO = EV_READ, /* alias for type-detection */
… …
217 EV_IDLE = 0x00002000, /* event loop is idling */ 224 EV_IDLE = 0x00002000, /* event loop is idling */
218 EV_PREPARE = 0x00004000, /* event loop about to poll */ 225 EV_PREPARE = 0x00004000, /* event loop about to poll */
219 EV_CHECK = 0x00008000, /* event loop finished poll */ 226 EV_CHECK = 0x00008000, /* event loop finished poll */
220 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 227 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
221 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 */
222 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 230 EV_ASYNC = 0x00080000, /* async intra-loop signal */
223 EV_CUSTOM = 0x01000000, /* for use by user code */ 231 EV_CUSTOM = 0x01000000, /* for use by user code */
224 EV_ERROR = 0x80000000 /* sent when an error occurs */ 232 EV_ERROR = 0x80000000 /* sent when an error occurs */
225}; 233};
226 234
227/* 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 */
… …
396 EV_WATCHER (ev_check) 404 EV_WATCHER (ev_check)
397} ev_check; 405} ev_check;
398 406
399#if EV_FORK_ENABLE 407#if EV_FORK_ENABLE
400/* 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 */
401typedef struct ev_fork 410typedef struct ev_fork
402{ 411{
403 EV_WATCHER (ev_fork) 412 EV_WATCHER (ev_fork)
404} 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;
405#endif 423#endif
406 424
407#if EV_EMBED_ENABLE 425#if EV_EMBED_ENABLE
408/* used to embed an event loop inside another */ 426/* used to embed an event loop inside another */
409/* 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 */
… …
417 ev_check check; /* unused */ 435 ev_check check; /* unused */
418 ev_timer timer; /* unused */ 436 ev_timer timer; /* unused */
419 ev_periodic periodic; /* unused */ 437 ev_periodic periodic; /* unused */
420 ev_idle idle; /* unused */ 438 ev_idle idle; /* unused */
421 ev_fork fork; /* private */ 439 ev_fork fork; /* private */
440#if EV_CLEANUP_ENABLE
441 ev_cleanup cleanup; /* unused */
442#endif
422} ev_embed; 443} ev_embed;
423#endif 444#endif
424 445
425#if EV_ASYNC_ENABLE 446#if EV_ASYNC_ENABLE
426/* invoked when somebody calls ev_async_send on the watcher */ 447/* invoked when somebody calls ev_async_send on the watcher */
… …
454#endif 475#endif
455 struct ev_prepare prepare; 476 struct ev_prepare prepare;
456 struct ev_check check; 477 struct ev_check check;
457#if EV_FORK_ENABLE 478#if EV_FORK_ENABLE
458 struct ev_fork fork; 479 struct ev_fork fork;
480#endif
481#if EV_CLEANUP_ENABLE
482 struct ev_cleanup cleanup;
459#endif 483#endif
460#if EV_EMBED_ENABLE 484#if EV_EMBED_ENABLE
461 struct ev_embed embed; 485 struct ev_embed embed;
462#endif 486#endif
463#if EV_ASYNC_ENABLE 487#if EV_ASYNC_ENABLE
… …
475 /* debugging/feature disable */ 499 /* debugging/feature disable */
476 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 500 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
477#if EV_COMPAT3 501#if EV_COMPAT3
478 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 502 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
479#endif 503#endif
480 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ 504 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
505 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
481}; 506};
482 507
483/* method bits to be ored together */ 508/* method bits to be ored together */
484enum { 509enum {
485 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 510 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
486 EVBACKEND_POLL = 0x00000002U, /* !win */ 511 EVBACKEND_POLL = 0x00000002U, /* !win */
487 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 512 EVBACKEND_EPOLL = 0x00000004U, /* linux */
488 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 513 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
489 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 514 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
490 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 515 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
491 EVBACKEND_ALL = 0x0000003FU 516 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
517 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
492}; 518};
493 519
494#if EV_PROTOTYPES 520#if EV_PROTOTYPES
495int ev_version_major (void); 521EV_API_DECL int ev_version_major (void);
496int ev_version_minor (void); 522EV_API_DECL int ev_version_minor (void);
497 523
498unsigned int ev_supported_backends (void); 524EV_API_DECL unsigned int ev_supported_backends (void);
499unsigned int ev_recommended_backends (void); 525EV_API_DECL unsigned int ev_recommended_backends (void);
500unsigned int ev_embeddable_backends (void); 526EV_API_DECL unsigned int ev_embeddable_backends (void);
501 527
502ev_tstamp ev_time (void); 528EV_API_DECL ev_tstamp ev_time (void);
503void ev_sleep (ev_tstamp delay); /* sleep for a while */ 529EV_API_DECL void ev_sleep (ev_tstamp delay); /* sleep for a while */
504 530
505/* Sets the allocation function to use, works like realloc. 531/* Sets the allocation function to use, works like realloc.
506 * It is used to allocate and free memory. 532 * It is used to allocate and free memory.
507 * 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
508 * or take some potentially destructive action. 534 * or take some potentially destructive action.
509 * The default is your system realloc function. 535 * The default is your system realloc function.
510 */ 536 */
511void ev_set_allocator (void *(*cb)(void *ptr, long size)); 537EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size));
512 538
513/* set the callback function to call on a 539/* set the callback function to call on a
514 * retryable syscall error 540 * retryable syscall error
515 * (such as failed select, poll, epoll_wait) 541 * (such as failed select, poll, epoll_wait)
516 */ 542 */
517void ev_set_syserr_cb (void (*cb)(const char *msg)); 543EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg));
518 544
519#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
520EV_INLINE struct ev_loop * 555EV_INLINE struct ev_loop *
521ev_default_loop_uc (void) 556ev_default_loop_uc_ (void)
522{ 557{
523 extern struct ev_loop *ev_default_loop_ptr; 558 extern struct ev_loop *ev_default_loop_ptr;
524 559
525 return ev_default_loop_ptr; 560 return ev_default_loop_ptr;
526} 561}
527 562
528/* the default loop is the only one that handles signals and child watchers */ 563EV_INLINE int
529/* you can call this as often as you like */ 564ev_is_default_loop (EV_P)
530EV_INLINE struct ev_loop *
531ev_default_loop (unsigned int flags EV_DEFARG (0))
532{ 565{
533 struct ev_loop *loop = ev_default_loop_uc (); 566 return EV_A == EV_DEFAULT_UC;
534
535 if (!loop)
536 {
537 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
538
539 loop = ev_default_loop_init (flags);
540 }
541
542 return loop;
543} 567}
544 568
545/* create and destroy alternative loops that don't handle signals */ 569/* create and destroy alternative loops that don't handle signals */
546struct ev_loop *ev_loop_new (unsigned int flags EV_DEFARG (0)); 570EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
547void ev_loop_destroy (EV_PDEF);
548void ev_loop_fork (EV_PDEF);
549 571
550ev_tstamp ev_now (EV_PDEF); /* 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 */
551 573
552#else 574#else
553 575
554int ev_default_loop (unsigned int flags EV_DEFARG (0)); /* 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;
555 579
556EV_INLINE ev_tstamp 580EV_INLINE ev_tstamp
557ev_now (void) 581ev_now (void)
558{ 582{
559 extern ev_tstamp ev_rt_now;
560
561 return ev_rt_now; 583 return ev_rt_now;
562} 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
563#endif /* multiplicity */ 593#endif /* multiplicity */
564 594
565EV_INLINE int 595/* destroy event loops, also works for the default loop */
566ev_is_default_loop (EV_PDEF) 596EV_API_DECL void ev_loop_destroy (EV_P);
567{
568#if EV_MULTIPLICITY
569 extern struct ev_loop *ev_default_loop_ptr;
570 597
571 return !!(EV_A == ev_default_loop_ptr);
572#else
573 return 1;
574#endif
575}
576
577void ev_default_destroy (void); /* destroy the default loop */
578/* this needs to be called after fork, to duplicate the default loop */ 598/* this needs to be called after fork, to duplicate the loop */
579/* 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 */
580/* you can call it in either the parent or the child */ 600/* you can call it in either the parent or the child */
581/* you can actually call it at any time, anywhere :) */ 601/* you can actually call it at any time, anywhere :) */
582void ev_default_fork (void); 602EV_API_DECL void ev_loop_fork (EV_P);
583 603
584unsigned int ev_backend (EV_PDEF); /* backend in use by loop */ 604EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */
585 605
586void ev_now_update (EV_PDEF); /* update event loop time */ 606EV_API_DECL void ev_now_update (EV_P); /* update event loop time */
587 607
588#if EV_WALK_ENABLE 608#if EV_WALK_ENABLE
589/* 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 */
590/* callback on every such watcher. The callback might stop the watcher, */ 610/* callback on every such watcher. The callback might stop the watcher, */
591/* but do nothing else with the loop */ 611/* but do nothing else with the loop */
592void 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));
593#endif 613#endif
594 614
595#endif /* prototypes */ 615#endif /* prototypes */
596 616
597/* ev_run flags values */ 617/* ev_run flags values */
… …
606 EVBREAK_ONE = 1, /* unloop once */ 626 EVBREAK_ONE = 1, /* unloop once */
607 EVBREAK_ALL = 2 /* unloop all loops */ 627 EVBREAK_ALL = 2 /* unloop all loops */
608}; 628};
609 629
610#if EV_PROTOTYPES 630#if EV_PROTOTYPES
611void ev_run (EV_PDEF_ int flags EV_DEFARG (0)); 631EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
612void ev_break (EV_PDEF_ int how EV_DEFARG (EVBREAK_ONE)); /* break out of the loop */ 632EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
613 633
614/* 634/*
615 * 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
616 * 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
617 * 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.
618 */ 638 */
619void ev_ref (EV_PDEF); 639EV_API_DECL void ev_ref (EV_P);
620void ev_unref (EV_PDEF); 640EV_API_DECL void ev_unref (EV_P);
621 641
622/* 642/*
623 * 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
624 * if timeout is < 0, do wait indefinitely 644 * if timeout is < 0, do wait indefinitely
625 */ 645 */
626void 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);
627 647
628# if EV_FEATURE_API 648# if EV_FEATURE_API
629unsigned int ev_iteration (EV_PDEF); /* number of loop iterations */ 649EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */
630unsigned int ev_depth (EV_PDEF); /* #ev_loop enters - #ev_loop leaves */ 650EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
631void ev_verify (EV_PDEF); /* abort if loop data corrupted */ 651EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */
632 652
633void 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 */
634void 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 */
635 655
636/* advanced stuff for threading etc. support, see docs */ 656/* advanced stuff for threading etc. support, see docs */
637void ev_set_userdata (EV_P_ void *data); 657EV_API_DECL void ev_set_userdata (EV_P_ void *data);
638void *ev_userdata (EV_PDEF); 658EV_API_DECL void *ev_userdata (EV_P);
639void 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));
640void 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));
641 661
642unsigned int ev_pending_count (EV_PDEF); /* number of pending events, if any */ 662EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
643void ev_invoke_pending (EV_PDEF); /* invoke all pending watchers */ 663EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
644 664
645/* 665/*
646 * stop/start the timer handling. 666 * stop/start the timer handling.
647 */ 667 */
648void ev_suspend (EV_PDEF); 668EV_API_DECL void ev_suspend (EV_P);
649void ev_resume (EV_PDEF); 669EV_API_DECL void ev_resume (EV_P);
650#endif 670#endif
651 671
652#endif 672#endif
653 673
654/* 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 */
… …
669#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 */
670#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 */
671#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 */
672#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)
673#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 */
674#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 */
675 696
676#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)
677#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)
678#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)
… …
682#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)
683#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)
684#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)
685#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)
686#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)
687#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)
688 710
689#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 */
690#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 */
691 713
… …
707 729
708/* 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 */
709/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 731/* stopping (disabling, deleting) a watcher does nothing unless its already running */
710#if EV_PROTOTYPES 732#if EV_PROTOTYPES
711 733
712/* 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 */
713/* accepts any ev_watcher type */ 735/* accepts any ev_watcher type */
714void ev_feed_event (EV_P_ void *w, int revents); 736EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents);
715void ev_feed_fd_event (EV_P_ int fd, int revents); 737EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents);
716#if EV_SIGNAL_ENABLE 738#if EV_SIGNAL_ENABLE
739EV_API_DECL void ev_feed_signal (int signum);
717void ev_feed_signal_event (EV_P_ int signum); 740EV_API_DECL void ev_feed_signal_event (EV_P_ int signum);
718#endif 741#endif
719void ev_invoke (EV_P_ void *w, int revents); 742EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
720int ev_clear_pending (EV_P_ void *w); 743EV_API_DECL int ev_clear_pending (EV_P_ void *w);
721 744
722void ev_io_start (EV_P_ ev_io *w); 745EV_API_DECL void ev_io_start (EV_P_ ev_io *w);
723void ev_io_stop (EV_P_ ev_io *w); 746EV_API_DECL void ev_io_stop (EV_P_ ev_io *w);
724 747
725void ev_timer_start (EV_P_ ev_timer *w); 748EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w);
726void ev_timer_stop (EV_P_ ev_timer *w); 749EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w);
727/* 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 */
728void ev_timer_again (EV_P_ ev_timer *w); 751EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w);
729/* return remaining time */ 752/* return remaining time */
730ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 753EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
731 754
732#if EV_PERIODIC_ENABLE 755#if EV_PERIODIC_ENABLE
733void ev_periodic_start (EV_P_ ev_periodic *w); 756EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w);
734void ev_periodic_stop (EV_P_ ev_periodic *w); 757EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w);
735void ev_periodic_again (EV_P_ ev_periodic *w); 758EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w);
736#endif 759#endif
737 760
738/* only supported in the default loop */ 761/* only supported in the default loop */
739#if EV_SIGNAL_ENABLE 762#if EV_SIGNAL_ENABLE
740void ev_signal_start (EV_P_ ev_signal *w); 763EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w);
741void ev_signal_stop (EV_P_ ev_signal *w); 764EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w);
742#endif 765#endif
743 766
744/* only supported in the default loop */ 767/* only supported in the default loop */
745# if EV_CHILD_ENABLE 768# if EV_CHILD_ENABLE
746void ev_child_start (EV_P_ ev_child *w); 769EV_API_DECL void ev_child_start (EV_P_ ev_child *w);
747void ev_child_stop (EV_P_ ev_child *w); 770EV_API_DECL void ev_child_stop (EV_P_ ev_child *w);
748# endif 771# endif
749 772
750# if EV_STAT_ENABLE 773# if EV_STAT_ENABLE
751void ev_stat_start (EV_P_ ev_stat *w); 774EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w);
752void ev_stat_stop (EV_P_ ev_stat *w); 775EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w);
753void ev_stat_stat (EV_P_ ev_stat *w); 776EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w);
754# endif 777# endif
755 778
756# if EV_IDLE_ENABLE 779# if EV_IDLE_ENABLE
757void ev_idle_start (EV_P_ ev_idle *w); 780EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w);
758void ev_idle_stop (EV_P_ ev_idle *w); 781EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w);
759# endif 782# endif
760 783
761#if EV_PREPARE_ENABLE 784#if EV_PREPARE_ENABLE
762void ev_prepare_start (EV_P_ ev_prepare *w); 785EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w);
763void ev_prepare_stop (EV_P_ ev_prepare *w); 786EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w);
764#endif 787#endif
765 788
766#if EV_CHECK_ENABLE 789#if EV_CHECK_ENABLE
767void ev_check_start (EV_P_ ev_check *w); 790EV_API_DECL void ev_check_start (EV_P_ ev_check *w);
768void ev_check_stop (EV_P_ ev_check *w); 791EV_API_DECL void ev_check_stop (EV_P_ ev_check *w);
769#endif 792#endif
770 793
771# if EV_FORK_ENABLE 794# if EV_FORK_ENABLE
772void ev_fork_start (EV_P_ ev_fork *w); 795EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w);
773void 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);
774# endif 802# endif
775 803
776# if EV_EMBED_ENABLE 804# if EV_EMBED_ENABLE
777/* only supported when loop to be embedded is in fact embeddable */ 805/* only supported when loop to be embedded is in fact embeddable */
778void ev_embed_start (EV_P_ ev_embed *w); 806EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w);
779void ev_embed_stop (EV_P_ ev_embed *w); 807EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w);
780void ev_embed_sweep (EV_P_ ev_embed *w); 808EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w);
781# endif 809# endif
782 810
783# if EV_ASYNC_ENABLE 811# if EV_ASYNC_ENABLE
784void ev_async_start (EV_P_ ev_async *w); 812EV_API_DECL void ev_async_start (EV_P_ ev_async *w);
785void ev_async_stop (EV_P_ ev_async *w); 813EV_API_DECL void ev_async_stop (EV_P_ ev_async *w);
786void ev_async_send (EV_P_ ev_async *w); 814EV_API_DECL void ev_async_send (EV_P_ ev_async *w);
787# endif 815# endif
788 816
789#if EV_COMPAT3 817#if EV_COMPAT3
790 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 818 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
791 #define EVLOOP_ONESHOT EVRUN_ONCE 819 #define EVLOOP_ONESHOT EVRUN_ONCE
… …
793 #define EVUNLOOP_ONE EVBREAK_ONE 821 #define EVUNLOOP_ONE EVBREAK_ONE
794 #define EVUNLOOP_ALL EVBREAK_ALL 822 #define EVUNLOOP_ALL EVBREAK_ALL
795 #if EV_PROTOTYPES 823 #if EV_PROTOTYPES
796 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); }
797 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); }
798 #if EV_FEATURE_API 828 #if EV_FEATURE_API
799 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); }
800 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); }
801 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); }
802 #endif 832 #endif
803 #endif 833 #endif
804#else 834#else
805 typedef struct ev_loop ev_loop; 835 typedef struct ev_loop ev_loop;
806#endif 836#endif
807 837
808#endif 838#endif
809 839
810#ifdef __cplusplus 840EV_CPP(})
811}
812#endif
813 841
814#endif 842#endif
815 843

Diff Legend

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