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

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

Diff Legend

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