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

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

Diff Legend

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