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

Comparing libev/ev.h (file contents):
Revision 1.190 by root, Fri Dec 21 06:54:30 2018 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-2018 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 *
… …
149# define EV_SIGNAL_ENABLE 1 149# define EV_SIGNAL_ENABLE 1
150#endif 150#endif
151 151
152/*****************************************************************************/ 152/*****************************************************************************/
153 153
154typedef double ev_tstamp; 154#ifndef EV_TSTAMP_T
155# define EV_TSTAMP_T double
156#endif
157typedef EV_TSTAMP_T ev_tstamp;
155 158
156#include <string.h> /* for memmove */ 159#include <string.h> /* for memmove */
157 160
158#ifndef EV_ATOMIC_T 161#ifndef EV_ATOMIC_T
159# include <signal.h> 162# include <signal.h>
… …
210#endif 213#endif
211 214
212/*****************************************************************************/ 215/*****************************************************************************/
213 216
214#define EV_VERSION_MAJOR 4 217#define EV_VERSION_MAJOR 4
215#define EV_VERSION_MINOR 25 218#define EV_VERSION_MINOR 33
216 219
217/* eventmask, revents, events... */ 220/* eventmask, revents, events... */
218enum { 221enum {
219 EV_UNDEF = (int)0xFFFFFFFF, /* guaranteed to be invalid */ 222 EV_UNDEF = (int)0xFFFFFFFF, /* guaranteed to be invalid */
220 EV_NONE = 0x00, /* no events */ 223 EV_NONE = 0x00, /* no events */
… …
387 390
388 int wd; /* wd for inotify, fd for kqueue */ 391 int wd; /* wd for inotify, fd for kqueue */
389} ev_stat; 392} ev_stat;
390#endif 393#endif
391 394
392#if EV_IDLE_ENABLE
393/* 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 */
394/* revent EV_IDLE */ 396/* revent EV_IDLE */
395typedef struct ev_idle 397typedef struct ev_idle
396{ 398{
397 EV_WATCHER (ev_idle) 399 EV_WATCHER (ev_idle)
398} ev_idle; 400} ev_idle;
399#endif
400 401
401/* 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 */
402/* you can still change events in any way you like */ 403/* you can still change events in any way you like */
403/* revent EV_PREPARE */ 404/* revent EV_PREPARE */
404typedef struct ev_prepare 405typedef struct ev_prepare
… …
411typedef struct ev_check 412typedef struct ev_check
412{ 413{
413 EV_WATCHER (ev_check) 414 EV_WATCHER (ev_check)
414} ev_check; 415} ev_check;
415 416
416#if EV_FORK_ENABLE
417/* 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 */ 418/* revent EV_FORK */
419typedef struct ev_fork 419typedef struct ev_fork
420{ 420{
421 EV_WATCHER (ev_fork) 421 EV_WATCHER (ev_fork)
422} ev_fork; 422} ev_fork;
423#endif
424 423
425#if EV_CLEANUP_ENABLE
426/* is invoked just before the loop gets destroyed */ 424/* is invoked just before the loop gets destroyed */
427/* revent EV_CLEANUP */ 425/* revent EV_CLEANUP */
428typedef struct ev_cleanup 426typedef struct ev_cleanup
429{ 427{
430 EV_WATCHER (ev_cleanup) 428 EV_WATCHER (ev_cleanup)
431} ev_cleanup; 429} ev_cleanup;
432#endif
433 430
434#if EV_EMBED_ENABLE 431#if EV_EMBED_ENABLE
435/* used to embed an event loop inside another */ 432/* used to embed an event loop inside another */
436/* 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 */
437typedef struct ev_embed 434typedef struct ev_embed
438{ 435{
439 EV_WATCHER (ev_embed) 436 EV_WATCHER (ev_embed)
440 437
441 struct ev_loop *other; /* ro */ 438 struct ev_loop *other; /* ro */
439#undef EV_IO_ENABLE
440#define EV_IO_ENABLE 1
442 ev_io io; /* private */ 441 ev_io io; /* private */
442#undef EV_PREPARE_ENABLE
443#define EV_PREPARE_ENABLE 1
443 ev_prepare prepare; /* private */ 444 ev_prepare prepare; /* private */
444 ev_check check; /* unused */ 445 ev_check check; /* unused */
445 ev_timer timer; /* unused */ 446 ev_timer timer; /* unused */
446 ev_periodic periodic; /* unused */ 447 ev_periodic periodic; /* unused */
447 ev_idle idle; /* unused */ 448 ev_idle idle; /* unused */
448 ev_fork fork; /* private */ 449 ev_fork fork; /* private */
449#if EV_CLEANUP_ENABLE
450 ev_cleanup cleanup; /* unused */ 450 ev_cleanup cleanup; /* unused */
451#endif
452} ev_embed; 451} ev_embed;
453#endif 452#endif
454 453
455#if EV_ASYNC_ENABLE 454#if EV_ASYNC_ENABLE
456/* invoked when somebody calls ev_async_send on the watcher */ 455/* invoked when somebody calls ev_async_send on the watcher */
… …
499}; 498};
500 499
501/* flag bits for ev_default_loop and ev_loop_new */ 500/* flag bits for ev_default_loop and ev_loop_new */
502enum { 501enum {
503 /* the default */ 502 /* the default */
504 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */ 503 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
505 /* flag bits */ 504 /* flag bits */
506 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */ 505 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
507 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */ 506 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
508 /* debugging/feature disable */ 507 /* debugging/feature disable */
509 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 508 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
510#if EV_COMPAT3 509#if EV_COMPAT3
511 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 510 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
512#endif 511#endif
513 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */ 512 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
514 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 */
515}; 515};
516 516
517/* method bits to be ored together */ 517/* method bits to be ored together */
518enum { 518enum {
519 EVBACKEND_SELECT = 0x00000001U, /* available just about anywhere */ 519 EVBACKEND_SELECT = 0x00000001U, /* available just about anywhere */
520 EVBACKEND_POLL = 0x00000002U, /* !win, !aix, broken on osx */ 520 EVBACKEND_POLL = 0x00000002U, /* !win, !aix, broken on osx */
521 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 521 EVBACKEND_EPOLL = 0x00000004U, /* linux */
522 EVBACKEND_KQUEUE = 0x00000008U, /* bsd, broken on osx */ 522 EVBACKEND_KQUEUE = 0x00000008U, /* bsd, broken on osx */
523 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 523 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
524 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+ */
525 EVBACKEND_ALL = 0x0000003FU, /* all known backends */ 527 EVBACKEND_ALL = 0x000000FFU, /* all known backends */
526 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */ 528 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
527}; 529};
528 530
529#if EV_PROTOTYPES 531#if EV_PROTOTYPES
530EV_API_DECL int ev_version_major (void) EV_NOEXCEPT; 532EV_API_DECL int ev_version_major (void) EV_NOEXCEPT;
531EV_API_DECL int ev_version_minor (void) EV_NOEXCEPT; 533EV_API_DECL int ev_version_minor (void) EV_NOEXCEPT;
… …
652 * 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
653 * if timeout is < 0, do wait indefinitely 655 * if timeout is < 0, do wait indefinitely
654 */ 656 */
655EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg) EV_NOEXCEPT; 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;
656 658
659EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
660
657# if EV_FEATURE_API 661# if EV_FEATURE_API
658EV_API_DECL unsigned int ev_iteration (EV_P) EV_NOEXCEPT; /* number of loop iterations */ 662EV_API_DECL unsigned int ev_iteration (EV_P) EV_NOEXCEPT; /* number of loop iterations */
659EV_API_DECL unsigned int ev_depth (EV_P) EV_NOEXCEPT; /* #ev_loop enters - #ev_loop leaves */ 663EV_API_DECL unsigned int ev_depth (EV_P) EV_NOEXCEPT; /* #ev_loop enters - #ev_loop leaves */
660EV_API_DECL void ev_verify (EV_P) EV_NOEXCEPT; /* abort if loop data corrupted */ 664EV_API_DECL void ev_verify (EV_P) EV_NOEXCEPT; /* abort if loop data corrupted */
661 665
… …
669EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ ev_loop_callback invoke_pending_cb) EV_NOEXCEPT; 673EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ ev_loop_callback invoke_pending_cb) EV_NOEXCEPT;
670/* C++ doesn't allow the use of the ev_loop_callback typedef here, so we need to spell it out */ 674/* C++ doesn't allow the use of the ev_loop_callback typedef here, so we need to spell it out */
671EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P) EV_NOEXCEPT, void (*acquire)(EV_P) EV_NOEXCEPT) EV_NOEXCEPT; 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;
672 676
673EV_API_DECL unsigned int ev_pending_count (EV_P) EV_NOEXCEPT; /* number of pending events, if any */ 677EV_API_DECL unsigned int ev_pending_count (EV_P) EV_NOEXCEPT; /* number of pending events, if any */
674EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
675 678
676/* 679/*
677 * stop/start the timer handling. 680 * stop/start the timer handling.
678 */ 681 */
679EV_API_DECL void ev_suspend (EV_P) EV_NOEXCEPT; 682EV_API_DECL void ev_suspend (EV_P) EV_NOEXCEPT;
… …
689 ((ev_watcher *)(void *)(ev))->pending = 0; \ 692 ((ev_watcher *)(void *)(ev))->pending = 0; \
690 ev_set_priority ((ev), 0); \ 693 ev_set_priority ((ev), 0); \
691 ev_set_cb ((ev), cb_); \ 694 ev_set_cb ((ev), cb_); \
692} while (0) 695} while (0)
693 696
697#define ev_io_modify(ev,events_) do { (ev)->events = (ev)->events & EV__IOFDSET | (events_); } while (0)
694#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)
695#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)
696#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)
697#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)
698#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)
… …
734#endif 738#endif
735 739
736#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at) 740#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
737 741
738#ifndef ev_set_cb 742#ifndef ev_set_cb
743/* memmove is used here to avoid strict aliasing violations, and hopefully is optimized out by any reasonable compiler */
739# define ev_set_cb(ev,cb_) (ev_cb_ (ev) = (cb_), memmove (&((ev_watcher *)(ev))->cb, &ev_cb_ (ev), sizeof (ev_cb_ (ev)))) 744# define ev_set_cb(ev,cb_) (ev_cb_ (ev) = (cb_), memmove (&((ev_watcher *)(ev))->cb, &ev_cb_ (ev), sizeof (ev_cb_ (ev))))
740#endif 745#endif
741 746
742/* 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 */
743/* stopping (disabling, deleting) a watcher does nothing unless it's already running */ 748/* stopping (disabling, deleting) a watcher does nothing unless it's already running */
744#if EV_PROTOTYPES 749#if EV_PROTOTYPES
745 750
746/* feeds an event into a watcher as if the event actually occurred */ 751/* feeds an event into a watcher as if the event actually occurred */
747/* accepts any ev_watcher type */ 752/* accepts any ev_watcher type */

Diff Legend

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