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

Comparing libev/ev.h (file contents):
Revision 1.157 by root, Mon Jan 10 01:58:55 2011 UTC vs.
Revision 1.206 by root, Fri Jun 23 11:29:38 2023 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007-2020 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)
… …
138# define EV_SIGNAL_ENABLE 1 149# define EV_SIGNAL_ENABLE 1
139#endif 150#endif
140 151
141/*****************************************************************************/ 152/*****************************************************************************/
142 153
143typedef 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 */
144 160
145#ifndef EV_ATOMIC_T 161#ifndef EV_ATOMIC_T
146# include <signal.h> 162# include <signal.h>
147# define EV_ATOMIC_T sig_atomic_t volatile 163# define EV_ATOMIC_T sig_atomic_t volatile
148#endif 164#endif
… …
183# define EV_INLINE static inline 199# define EV_INLINE static inline
184#else 200#else
185# define EV_INLINE static 201# define EV_INLINE static
186#endif 202#endif
187 203
204#ifdef EV_API_STATIC
205# define EV_API_DECL static
206#else
207# define EV_API_DECL extern
208#endif
209
188/* EV_PROTOTYPES can be sued to switch of prototype declarations */ 210/* EV_PROTOTYPES can be used to switch of prototype declarations */
189#ifndef EV_PROTOTYPES 211#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1 212# define EV_PROTOTYPES 1
191#endif 213#endif
192 214
193/*****************************************************************************/ 215/*****************************************************************************/
194 216
195#define EV_VERSION_MAJOR 4 217#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 1 218#define EV_VERSION_MINOR 33
197 219
198/* eventmask, revents, events... */ 220/* eventmask, revents, events... */
199enum { 221enum {
200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */ 222 EV_UNDEF = (int)0xFFFFFFFF, /* guaranteed to be invalid */
201 EV_NONE = 0x00, /* no events */ 223 EV_NONE = 0x00, /* no events */
202 EV_READ = 0x01, /* ev_io detected read will not block */ 224 EV_READ = 0x01, /* ev_io detected read will not block */
203 EV_WRITE = 0x02, /* ev_io detected write will not block */ 225 EV_WRITE = 0x02, /* ev_io detected write will not block */
204 EV__IOFDSET = 0x80, /* internal use only */ 226 EV__IOFDSET = 0x80, /* internal use only */
205 EV_IO = EV_READ, /* alias for type-detection */ 227 EV_IO = EV_READ, /* alias for type-detection */
206 EV_TIMER = 0x00000100, /* timer timed out */ 228 EV_TIMER = 0x00000100, /* timer timed out */
207#if EV_COMPAT3 229#if EV_COMPAT3
208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */ 230 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif 231#endif
210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */ 232 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
211 EV_SIGNAL = 0x00000400, /* signal was received */ 233 EV_SIGNAL = 0x00000400, /* signal was received */
212 EV_CHILD = 0x00000800, /* child/pid had status change */ 234 EV_CHILD = 0x00000800, /* child/pid had status change */
213 EV_STAT = 0x00001000, /* stat data changed */ 235 EV_STAT = 0x00001000, /* stat data changed */
214 EV_IDLE = 0x00002000, /* event loop is idling */ 236 EV_IDLE = 0x00002000, /* event loop is idling */
215 EV_PREPARE = 0x00004000, /* event loop about to poll */ 237 EV_PREPARE = 0x00004000, /* event loop about to poll */
216 EV_CHECK = 0x00008000, /* event loop finished poll */ 238 EV_CHECK = 0x00008000, /* event loop finished poll */
217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 239 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
218 EV_FORK = 0x00020000, /* event loop resumed in child */ 240 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */ 241 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
220 EV_ASYNC = 0x00080000, /* async intra-loop signal */ 242 EV_ASYNC = 0x00080000, /* async intra-loop signal */
221 EV_CUSTOM = 0x01000000, /* for use by user code */ 243 EV_CUSTOM = 0x01000000, /* for use by user code */
222 EV_ERROR = 0x80000000 /* sent when an error occurs */ 244 EV_ERROR = (int)0x80000000 /* sent when an error occurs */
223}; 245};
224 246
225/* 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 */
226#ifndef EV_COMMON 248#ifndef EV_COMMON
227# define EV_COMMON void *data; 249# define EV_COMMON void *data;
… …
319{ 341{
320 EV_WATCHER_TIME (ev_periodic) 342 EV_WATCHER_TIME (ev_periodic)
321 343
322 ev_tstamp offset; /* rw */ 344 ev_tstamp offset; /* rw */
323 ev_tstamp interval; /* rw */ 345 ev_tstamp interval; /* rw */
324 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 */
325} ev_periodic; 347} ev_periodic;
326 348
327/* invoked when the given signal has been received */ 349/* invoked when the given signal has been received */
328/* revent EV_SIGNAL */ 350/* revent EV_SIGNAL */
329typedef struct ev_signal 351typedef struct ev_signal
… …
368 390
369 int wd; /* wd for inotify, fd for kqueue */ 391 int wd; /* wd for inotify, fd for kqueue */
370} ev_stat; 392} ev_stat;
371#endif 393#endif
372 394
373#if EV_IDLE_ENABLE
374/* invoked when the nothing else needs to be done, keeps the process from blocking */ 395/* invoked when the nothing else needs to be done, keeps the process from blocking */
375/* revent EV_IDLE */ 396/* revent EV_IDLE */
376typedef struct ev_idle 397typedef struct ev_idle
377{ 398{
378 EV_WATCHER (ev_idle) 399 EV_WATCHER (ev_idle)
379} ev_idle; 400} ev_idle;
380#endif
381 401
382/* invoked for each run of the mainloop, just before the blocking call */ 402/* invoked for each run of the mainloop, just before the blocking call */
383/* you can still change events in any way you like */ 403/* you can still change events in any way you like */
384/* revent EV_PREPARE */ 404/* revent EV_PREPARE */
385typedef struct ev_prepare 405typedef struct ev_prepare
… …
392typedef struct ev_check 412typedef struct ev_check
393{ 413{
394 EV_WATCHER (ev_check) 414 EV_WATCHER (ev_check)
395} ev_check; 415} ev_check;
396 416
397#if EV_FORK_ENABLE
398/* 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 */
399/* revent EV_FORK */ 418/* revent EV_FORK */
400typedef struct ev_fork 419typedef struct ev_fork
401{ 420{
402 EV_WATCHER (ev_fork) 421 EV_WATCHER (ev_fork)
403} ev_fork; 422} ev_fork;
404#endif
405 423
406#if EV_CLEANUP_ENABLE
407/* is invoked just before the loop gets destroyed */ 424/* is invoked just before the loop gets destroyed */
408/* revent EV_CLEANUP */ 425/* revent EV_CLEANUP */
409typedef struct ev_cleanup 426typedef struct ev_cleanup
410{ 427{
411 EV_WATCHER (ev_cleanup) 428 EV_WATCHER (ev_cleanup)
412} ev_cleanup; 429} ev_cleanup;
413#endif
414 430
415#if EV_EMBED_ENABLE 431#if EV_EMBED_ENABLE
416/* used to embed an event loop inside another */ 432/* used to embed an event loop inside another */
417/* the callback gets invoked when the event loop has handled events, and can be 0 */ 433/* the callback gets invoked when the event loop has handled events, and can be 0 */
418typedef struct ev_embed 434typedef struct ev_embed
419{ 435{
420 EV_WATCHER (ev_embed) 436 EV_WATCHER (ev_embed)
421 437
422 struct ev_loop *other; /* ro */ 438 struct ev_loop *other; /* ro */
439#undef EV_IO_ENABLE
440#define EV_IO_ENABLE 1
423 ev_io io; /* private */ 441 ev_io io; /* private */
442#undef EV_PREPARE_ENABLE
443#define EV_PREPARE_ENABLE 1
424 ev_prepare prepare; /* private */ 444 ev_prepare prepare; /* private */
425 ev_check check; /* unused */ 445 ev_check check; /* unused */
426 ev_timer timer; /* unused */ 446 ev_timer timer; /* unused */
427 ev_periodic periodic; /* unused */ 447 ev_periodic periodic; /* unused */
428 ev_idle idle; /* unused */ 448 ev_idle idle; /* unused */
429 ev_fork fork; /* private */ 449 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */ 450 ev_cleanup cleanup; /* unused */
432#endif
433} ev_embed; 451} ev_embed;
434#endif 452#endif
435 453
436#if EV_ASYNC_ENABLE 454#if EV_ASYNC_ENABLE
437/* invoked when somebody calls ev_async_send on the watcher */ 455/* invoked when somebody calls ev_async_send on the watcher */
… …
480}; 498};
481 499
482/* flag bits for ev_default_loop and ev_loop_new */ 500/* flag bits for ev_default_loop and ev_loop_new */
483enum { 501enum {
484 /* the default */ 502 /* the default */
485 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */ 503 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
486 /* flag bits */ 504 /* flag bits */
487 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */ 505 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
488 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */ 506 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
489 /* debugging/feature disable */ 507 /* debugging/feature disable */
490 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 508 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
491#if EV_COMPAT3 509#if EV_COMPAT3
492 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 510 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
493#endif 511#endif
494 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */ 512 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
495 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */ 513 EVFLAG_NOSIGMASK = 0x00400000U, /* avoid modifying the signal mask */
514 EVFLAG_NOTIMERFD = 0x00800000U /* avoid creating a timerfd */
496}; 515};
497 516
498/* method bits to be ored together */ 517/* method bits to be ored together */
499enum { 518enum {
500 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 519 EVBACKEND_SELECT = 0x00000001U, /* available just about anywhere */
501 EVBACKEND_POLL = 0x00000002U, /* !win */ 520 EVBACKEND_POLL = 0x00000002U, /* !win, !aix, broken on osx */
502 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 521 EVBACKEND_EPOLL = 0x00000004U, /* linux */
503 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 522 EVBACKEND_KQUEUE = 0x00000008U, /* bsd, broken on osx */
504 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 523 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
505 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 524 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
525 EVBACKEND_LINUXAIO = 0x00000040U, /* linux AIO, 4.19+ */
526 EVBACKEND_IOURING = 0x00000080U, /* linux io_uring, 5.1+ */
506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */ 527 EVBACKEND_ALL = 0x000000FFU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */ 528 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508}; 529};
509 530
510#if EV_PROTOTYPES 531#if EV_PROTOTYPES
511int ev_version_major (void); 532EV_API_DECL int ev_version_major (void) EV_NOEXCEPT;
512int ev_version_minor (void); 533EV_API_DECL int ev_version_minor (void) EV_NOEXCEPT;
513 534
514unsigned int ev_supported_backends (void); 535EV_API_DECL unsigned int ev_supported_backends (void) EV_NOEXCEPT;
515unsigned int ev_recommended_backends (void); 536EV_API_DECL unsigned int ev_recommended_backends (void) EV_NOEXCEPT;
516unsigned int ev_embeddable_backends (void); 537EV_API_DECL unsigned int ev_embeddable_backends (void) EV_NOEXCEPT;
517 538
518ev_tstamp ev_time (void); 539EV_API_DECL ev_tstamp ev_time (void) EV_NOEXCEPT;
519void ev_sleep (ev_tstamp delay); /* sleep for a while */ 540EV_API_DECL void ev_sleep (ev_tstamp delay) EV_NOEXCEPT; /* sleep for a while */
520 541
521/* Sets the allocation function to use, works like realloc. 542/* Sets the allocation function to use, works like realloc.
522 * It is used to allocate and free memory. 543 * It is used to allocate and free memory.
523 * 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
524 * or take some potentially destructive action. 545 * or take some potentially destructive action.
525 * The default is your system realloc function. 546 * The default is your system realloc function.
526 */ 547 */
527void 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;
528 549
529/* set the callback function to call on a 550/* set the callback function to call on a
530 * retryable syscall error 551 * retryable syscall error
531 * (such as failed select, poll, epoll_wait) 552 * (such as failed select, poll, epoll_wait)
532 */ 553 */
533void 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;
534 555
535#if EV_MULTIPLICITY 556#if EV_MULTIPLICITY
536 557
537/* the default loop is the only one that handles signals and child watchers */ 558/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */ 559/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)); 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
540 565
541EV_INLINE struct ev_loop * 566EV_INLINE struct ev_loop *
542ev_default_loop_uc_ (void) 567ev_default_loop_uc_ (void) EV_NOEXCEPT
543{ 568{
544 extern struct ev_loop *ev_default_loop_ptr; 569 extern struct ev_loop *ev_default_loop_ptr;
545 570
546 return ev_default_loop_ptr; 571 return ev_default_loop_ptr;
547} 572}
548 573
549EV_INLINE int 574EV_INLINE int
550ev_is_default_loop (EV_P) 575ev_is_default_loop (EV_P) EV_NOEXCEPT
551{ 576{
552 return EV_A == EV_DEFAULT_UC; 577 return EV_A == EV_DEFAULT_UC;
553} 578}
554 579
555/* create and destroy alternative loops that don't handle signals */ 580/* create and destroy alternative loops that don't handle signals */
556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); 581EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)) EV_NOEXCEPT;
557 582
558ev_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 */
559 584
560#else 585#else
561 586
562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* 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;
563 590
564EV_INLINE ev_tstamp 591EV_INLINE ev_tstamp
565ev_now (void) 592ev_now (void) EV_NOEXCEPT
566{ 593{
567 extern ev_tstamp ev_rt_now;
568
569 return ev_rt_now; 594 return ev_rt_now;
570} 595}
571 596
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */ 597/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
573EV_INLINE int 598EV_INLINE int
574ev_is_default_loop (void) 599ev_is_default_loop (void) EV_NOEXCEPT
575{ 600{
576 return 1; 601 return 1;
577} 602}
578 603
579#endif /* multiplicity */ 604#endif /* multiplicity */
580 605
581/* destroy event loops, also works for the default loop */ 606/* destroy event loops, also works for the default loop */
582void ev_loop_destroy (EV_P); 607EV_API_DECL void ev_loop_destroy (EV_P);
583 608
584/* this needs to be called after fork, to duplicate the loop */ 609/* this needs to be called after fork, to duplicate the loop */
585/* when you want to re-use it in the child */ 610/* when you want to re-use it in the child */
586/* you can call it in either the parent or the child */ 611/* you can call it in either the parent or the child */
587/* you can actually call it at any time, anywhere :) */ 612/* you can actually call it at any time, anywhere :) */
588void ev_loop_fork (EV_P); 613EV_API_DECL void ev_loop_fork (EV_P) EV_NOEXCEPT;
589 614
590unsigned 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 */
591 616
592void ev_now_update (EV_P); /* update event loop time */ 617EV_API_DECL void ev_now_update (EV_P) EV_NOEXCEPT; /* update event loop time */
593 618
594#if EV_WALK_ENABLE 619#if EV_WALK_ENABLE
595/* 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 */
596/* callback on every such watcher. The callback might stop the watcher, */ 621/* callback on every such watcher. The callback might stop the watcher, */
597/* but do nothing else with the loop */ 622/* but do nothing else with the loop */
598void 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;
599#endif 624#endif
600 625
601#endif /* prototypes */ 626#endif /* prototypes */
602 627
603/* ev_run flags values */ 628/* ev_run flags values */
… …
612 EVBREAK_ONE = 1, /* unloop once */ 637 EVBREAK_ONE = 1, /* unloop once */
613 EVBREAK_ALL = 2 /* unloop all loops */ 638 EVBREAK_ALL = 2 /* unloop all loops */
614}; 639};
615 640
616#if EV_PROTOTYPES 641#if EV_PROTOTYPES
617void ev_run (EV_P_ int flags EV_CPP (= 0)); 642EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */ 643EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)) EV_NOEXCEPT; /* break out of the loop */
619 644
620/* 645/*
621 * 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
622 * 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
623 * 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.
624 */ 649 */
625void ev_ref (EV_P); 650EV_API_DECL void ev_ref (EV_P) EV_NOEXCEPT;
626void ev_unref (EV_P); 651EV_API_DECL void ev_unref (EV_P) EV_NOEXCEPT;
627 652
628/* 653/*
629 * 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
630 * if timeout is < 0, do wait indefinitely 655 * if timeout is < 0, do wait indefinitely
631 */ 656 */
632void 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;
658
659EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
633 660
634# if EV_FEATURE_API 661# if EV_FEATURE_API
635unsigned int ev_iteration (EV_P); /* number of loop iterations */ 662EV_API_DECL unsigned int ev_iteration (EV_P) EV_NOEXCEPT; /* number of loop iterations */
636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 663EV_API_DECL unsigned int ev_depth (EV_P) EV_NOEXCEPT; /* #ev_loop enters - #ev_loop leaves */
637void ev_verify (EV_P); /* abort if loop data corrupted */ 664EV_API_DECL void ev_verify (EV_P) EV_NOEXCEPT; /* abort if loop data corrupted */
638 665
639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 666EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval) EV_NOEXCEPT; /* sleep at least this time, default 0 */
640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 667EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval) EV_NOEXCEPT; /* sleep at least this time, default 0 */
641 668
642/* advanced stuff for threading etc. support, see docs */ 669/* advanced stuff for threading etc. support, see docs */
643void ev_set_userdata (EV_P_ void *data); 670EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_NOEXCEPT;
644void *ev_userdata (EV_P); 671EV_API_DECL void *ev_userdata (EV_P) EV_NOEXCEPT;
645void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 672typedef void (*ev_loop_callback)(EV_P);
673EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ ev_loop_callback invoke_pending_cb) EV_NOEXCEPT;
674/* C++ doesn't allow the use of the ev_loop_callback typedef here, so we need to spell it out */
646void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 675EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P) EV_NOEXCEPT, void (*acquire)(EV_P) EV_NOEXCEPT) EV_NOEXCEPT;
647 676
648unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 677EV_API_DECL unsigned int ev_pending_count (EV_P) EV_NOEXCEPT; /* number of pending events, if any */
649void ev_invoke_pending (EV_P); /* invoke all pending watchers */
650 678
651/* 679/*
652 * stop/start the timer handling. 680 * stop/start the timer handling.
653 */ 681 */
654void ev_suspend (EV_P); 682EV_API_DECL void ev_suspend (EV_P) EV_NOEXCEPT;
655void ev_resume (EV_P); 683EV_API_DECL void ev_resume (EV_P) EV_NOEXCEPT;
656#endif 684#endif
657 685
658#endif 686#endif
659 687
660/* these may evaluate ev multiple times, and the other arguments at most once */ 688/* these may evaluate ev multiple times, and the other arguments at most once */
… …
664 ((ev_watcher *)(void *)(ev))->pending = 0; \ 692 ((ev_watcher *)(void *)(ev))->pending = 0; \
665 ev_set_priority ((ev), 0); \ 693 ev_set_priority ((ev), 0); \
666 ev_set_cb ((ev), cb_); \ 694 ev_set_cb ((ev), cb_); \
667} while (0) 695} while (0)
668 696
697#define ev_io_modify(ev,events_) do { (ev)->events = (ev)->events & EV__IOFDSET | (events_); } while (0)
669#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) 698#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
670#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) 699#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
671#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0) 700#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
672#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 701#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
673#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) 702#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
… …
695#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 724#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
696 725
697#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 726#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
698#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 727#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
699 728
700#define ev_cb(ev) (ev)->cb /* rw */ 729#define ev_cb_(ev) (ev)->cb /* rw */
730#define ev_cb(ev) (memmove (&ev_cb_ (ev), &((ev_watcher *)(ev))->cb, sizeof (ev_cb_ (ev))), (ev)->cb)
701 731
702#if EV_MINPRI == EV_MAXPRI 732#if EV_MINPRI == EV_MAXPRI
703# define ev_priority(ev) ((ev), EV_MINPRI) 733# define ev_priority(ev) ((ev), EV_MINPRI)
704# define ev_set_priority(ev,pri) ((ev), (pri)) 734# define ev_set_priority(ev,pri) ((ev), (pri))
705#else 735#else
… …
708#endif 738#endif
709 739
710#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at) 740#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
711 741
712#ifndef ev_set_cb 742#ifndef ev_set_cb
713# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 743/* memmove is used here to avoid strict aliasing violations, and hopefully is optimized out by any reasonable compiler */
744# define ev_set_cb(ev,cb_) (ev_cb_ (ev) = (cb_), memmove (&((ev_watcher *)(ev))->cb, &ev_cb_ (ev), sizeof (ev_cb_ (ev))))
714#endif 745#endif
715 746
716/* stopping (enabling, adding) a watcher does nothing if it is already running */ 747/* starting (enabling, adding) a watcher does nothing if it is already running */
717/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 748/* stopping (disabling, deleting) a watcher does nothing unless it's already running */
718#if EV_PROTOTYPES 749#if EV_PROTOTYPES
719 750
720/* feeds an event into a watcher as if the event actually occured */ 751/* feeds an event into a watcher as if the event actually occurred */
721/* accepts any ev_watcher type */ 752/* accepts any ev_watcher type */
722void ev_feed_event (EV_P_ void *w, int revents); 753EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents) EV_NOEXCEPT;
723void ev_feed_fd_event (EV_P_ int fd, int revents); 754EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents) EV_NOEXCEPT;
724#if EV_SIGNAL_ENABLE 755#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum); 756EV_API_DECL void ev_feed_signal (int signum) EV_NOEXCEPT;
726void ev_feed_signal_event (EV_P_ int signum); 757EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_NOEXCEPT;
727#endif 758#endif
728void ev_invoke (EV_P_ void *w, int revents); 759EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
729int ev_clear_pending (EV_P_ void *w); 760EV_API_DECL int ev_clear_pending (EV_P_ void *w) EV_NOEXCEPT;
730 761
731void ev_io_start (EV_P_ ev_io *w); 762EV_API_DECL void ev_io_start (EV_P_ ev_io *w) EV_NOEXCEPT;
732void ev_io_stop (EV_P_ ev_io *w); 763EV_API_DECL void ev_io_stop (EV_P_ ev_io *w) EV_NOEXCEPT;
733 764
734void ev_timer_start (EV_P_ ev_timer *w); 765EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w) EV_NOEXCEPT;
735void ev_timer_stop (EV_P_ ev_timer *w); 766EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w) EV_NOEXCEPT;
736/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 767/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
737void ev_timer_again (EV_P_ ev_timer *w); 768EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w) EV_NOEXCEPT;
738/* return remaining time */ 769/* return remaining time */
739ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 770EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_NOEXCEPT;
740 771
741#if EV_PERIODIC_ENABLE 772#if EV_PERIODIC_ENABLE
742void ev_periodic_start (EV_P_ ev_periodic *w); 773EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_NOEXCEPT;
743void ev_periodic_stop (EV_P_ ev_periodic *w); 774EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w) EV_NOEXCEPT;
744void ev_periodic_again (EV_P_ ev_periodic *w); 775EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_NOEXCEPT;
745#endif 776#endif
746 777
747/* only supported in the default loop */ 778/* only supported in the default loop */
748#if EV_SIGNAL_ENABLE 779#if EV_SIGNAL_ENABLE
749void ev_signal_start (EV_P_ ev_signal *w); 780EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w) EV_NOEXCEPT;
750void ev_signal_stop (EV_P_ ev_signal *w); 781EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w) EV_NOEXCEPT;
751#endif 782#endif
752 783
753/* only supported in the default loop */ 784/* only supported in the default loop */
754# if EV_CHILD_ENABLE 785# if EV_CHILD_ENABLE
755void ev_child_start (EV_P_ ev_child *w); 786EV_API_DECL void ev_child_start (EV_P_ ev_child *w) EV_NOEXCEPT;
756void ev_child_stop (EV_P_ ev_child *w); 787EV_API_DECL void ev_child_stop (EV_P_ ev_child *w) EV_NOEXCEPT;
757# endif 788# endif
758 789
759# if EV_STAT_ENABLE 790# if EV_STAT_ENABLE
760void ev_stat_start (EV_P_ ev_stat *w); 791EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w) EV_NOEXCEPT;
761void ev_stat_stop (EV_P_ ev_stat *w); 792EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w) EV_NOEXCEPT;
762void ev_stat_stat (EV_P_ ev_stat *w); 793EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w) EV_NOEXCEPT;
763# endif 794# endif
764 795
765# if EV_IDLE_ENABLE 796# if EV_IDLE_ENABLE
766void ev_idle_start (EV_P_ ev_idle *w); 797EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w) EV_NOEXCEPT;
767void ev_idle_stop (EV_P_ ev_idle *w); 798EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w) EV_NOEXCEPT;
768# endif 799# endif
769 800
770#if EV_PREPARE_ENABLE 801#if EV_PREPARE_ENABLE
771void ev_prepare_start (EV_P_ ev_prepare *w); 802EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w) EV_NOEXCEPT;
772void ev_prepare_stop (EV_P_ ev_prepare *w); 803EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w) EV_NOEXCEPT;
773#endif 804#endif
774 805
775#if EV_CHECK_ENABLE 806#if EV_CHECK_ENABLE
776void ev_check_start (EV_P_ ev_check *w); 807EV_API_DECL void ev_check_start (EV_P_ ev_check *w) EV_NOEXCEPT;
777void ev_check_stop (EV_P_ ev_check *w); 808EV_API_DECL void ev_check_stop (EV_P_ ev_check *w) EV_NOEXCEPT;
778#endif 809#endif
779 810
780# if EV_FORK_ENABLE 811# if EV_FORK_ENABLE
781void ev_fork_start (EV_P_ ev_fork *w); 812EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w) EV_NOEXCEPT;
782void ev_fork_stop (EV_P_ ev_fork *w); 813EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w) EV_NOEXCEPT;
783# endif 814# endif
784 815
785# if EV_CLEANUP_ENABLE 816# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w); 817EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w) EV_NOEXCEPT;
787void ev_cleanup_stop (EV_P_ ev_cleanup *w); 818EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w) EV_NOEXCEPT;
788# endif 819# endif
789 820
790# if EV_EMBED_ENABLE 821# if EV_EMBED_ENABLE
791/* only supported when loop to be embedded is in fact embeddable */ 822/* only supported when loop to be embedded is in fact embeddable */
792void ev_embed_start (EV_P_ ev_embed *w); 823EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w) EV_NOEXCEPT;
793void ev_embed_stop (EV_P_ ev_embed *w); 824EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w) EV_NOEXCEPT;
794void ev_embed_sweep (EV_P_ ev_embed *w); 825EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w) EV_NOEXCEPT;
795# endif 826# endif
796 827
797# if EV_ASYNC_ENABLE 828# if EV_ASYNC_ENABLE
798void ev_async_start (EV_P_ ev_async *w); 829EV_API_DECL void ev_async_start (EV_P_ ev_async *w) EV_NOEXCEPT;
799void ev_async_stop (EV_P_ ev_async *w); 830EV_API_DECL void ev_async_stop (EV_P_ ev_async *w) EV_NOEXCEPT;
800void ev_async_send (EV_P_ ev_async *w); 831EV_API_DECL void ev_async_send (EV_P_ ev_async *w) EV_NOEXCEPT;
801# endif 832# endif
802 833
803#if EV_COMPAT3 834#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 835 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE 836 #define EVLOOP_ONESHOT EVRUN_ONCE

Diff Legend

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