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

Comparing libev/ev.h (file contents):
Revision 1.148 by root, Sun Oct 24 14:44:40 2010 UTC vs.
Revision 1.176 by root, Tue Sep 9 13:28:21 2014 UTC

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

Diff Legend

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