ev.h

   1 /*
   2  * libev native API header
   3  *
   4  * Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libev@schmorp.de>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without modifica-
   8  * tion, are permitted provided that the following conditions are met:
   9  *
  10  *   1.  Redistributions of source code must retain the above copyright notice,
  11  *       this list of conditions and the following disclaimer.
  12  *
  13  *   2.  Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in the
  15  *       documentation and/or other materials provided with the distribution.
  16  *
  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-
  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-
  21  * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  23  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
  25  * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  26  * OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of
  29  * the GNU General Public License ("GPL") version 2 or any later version,
  30  * in which case the provisions of the GPL are applicable instead of
  31  * the above. If you wish to allow the use of your version of this file
  32  * only under the terms of the GPL and not to allow others to use your
  33  * version of this file under the BSD license, indicate your decision
  34  * by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL. If you do not delete the
  36  * provisions above, a recipient may use your version of this file under
  37  * either the BSD or the GPL.
  38  */
  39
  40 #ifndef EV_H_
  41 #define EV_H_
  42
  43 #ifdef __cplusplus
  44 # define EV_CPP(x) x
  45 #else
  46 # define EV_CPP(x)
  47 #endif
  48
  49 #define EV_THROW EV_CPP(throw())
  50
  51 /* apple's proprietary clang fork errors out with exception specifications */
  52 /* in all sorts of places, so let's not even bother with them */
  53 /* users are strongly advised to install clang or gcc */
  54 #if __APPLE__ && __clang__
  55 # undef EV_THROW
  56 # define EV_THROW
  57 #endif
  58
  59 EV_CPP(extern "C" {)
  60
  61 /*****************************************************************************/
  62
  63 /* pre-4.0 compatibility */
  64 #ifndef EV_COMPAT3
  65 # define EV_COMPAT3 1
  66 #endif
  67
  68 #ifndef EV_FEATURES
  69 # if defined __OPTIMIZE_SIZE__
  70 #  define EV_FEATURES 0x7c
  71 # else
  72 #  define EV_FEATURES 0x7f
  73 # endif
  74 #endif
  75
  76 #define EV_FEATURE_CODE     ((EV_FEATURES) &  1)
  77 #define EV_FEATURE_DATA     ((EV_FEATURES) &  2)
  78 #define EV_FEATURE_CONFIG   ((EV_FEATURES) &  4)
  79 #define EV_FEATURE_API      ((EV_FEATURES) &  8)
  80 #define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
  81 #define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
  82 #define EV_FEATURE_OS       ((EV_FEATURES) & 64)
  83
  84 /* these priorities are inclusive, higher priorities will be invoked earlier */
  85 #ifndef EV_MINPRI
  86 # define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
  87 #endif
  88 #ifndef EV_MAXPRI
  89 # define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
  90 #endif
  91
  92 #ifndef EV_MULTIPLICITY
  93 # define EV_MULTIPLICITY EV_FEATURE_CONFIG
  94 #endif
  95
  96 #ifndef EV_PERIODIC_ENABLE
  97 # define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
  98 #endif
  99
 100 #ifndef EV_STAT_ENABLE
 101 # define EV_STAT_ENABLE EV_FEATURE_WATCHERS
 102 #endif
 103
 104 #ifndef EV_PREPARE_ENABLE
 105 # define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
 106 #endif
 107
 108 #ifndef EV_CHECK_ENABLE
 109 # define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
 110 #endif
 111
 112 #ifndef EV_IDLE_ENABLE
 113 # define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
 114 #endif
 115
 116 #ifndef EV_FORK_ENABLE
 117 # define EV_FORK_ENABLE EV_FEATURE_WATCHERS
 118 #endif
 119
 120 #ifndef EV_CLEANUP_ENABLE
 121 # define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
 122 #endif
 123
 124 #ifndef EV_SIGNAL_ENABLE
 125 # define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
 126 #endif
 127
 128 #ifndef EV_CHILD_ENABLE
 129 # ifdef _WIN32
 130 #  define EV_CHILD_ENABLE 0
 131 # else
 132 #  define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
 133 #endif
 134 #endif
 135
 136 #ifndef EV_ASYNC_ENABLE
 137 # define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
 138 #endif
 139
 140 #ifndef EV_EMBED_ENABLE
 141 # define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
 142 #endif
 143
 144 #ifndef EV_WALK_ENABLE
 145 # define EV_WALK_ENABLE 0 /* not yet */
 146 #endif
 147
 148 /*****************************************************************************/
 149
 150 #if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
 151 # undef EV_SIGNAL_ENABLE
 152 # define EV_SIGNAL_ENABLE 1
 153 #endif
 154
 155 /*****************************************************************************/
 156
 157 typedef double ev_tstamp;
 158
 159 #ifndef EV_ATOMIC_T
 160 # include <signal.h>
 161 # define EV_ATOMIC_T sig_atomic_t volatile
 162 #endif
 163
 164 #if EV_STAT_ENABLE
 165 # ifdef _WIN32
 166 #  include <time.h>
 167 #  include <sys/types.h>
 168 # endif
 169 # include <sys/stat.h>
 170 #endif
 171
 172 /* support multiple event loops? */
 173 #if EV_MULTIPLICITY
 174 struct ev_loop;
 175 # define EV_P  struct ev_loop *loop               /* a loop as sole parameter in a declaration */
 176 # define EV_P_ EV_P,                              /* a loop as first of multiple parameters */
 177 # define EV_A  loop                               /* a loop as sole argument to a function call */
 178 # define EV_A_ EV_A,                              /* a loop as first of multiple arguments */
 179 # define EV_DEFAULT_UC  ev_default_loop_uc_ ()    /* the default loop, if initialised, as sole arg */
 180 # define EV_DEFAULT_UC_ EV_DEFAULT_UC,            /* the default loop as first of multiple arguments */
 181 # define EV_DEFAULT  ev_default_loop (0)          /* the default loop as sole arg */
 182 # define EV_DEFAULT_ EV_DEFAULT,                  /* the default loop as first of multiple arguments */
 183 #else
 184 # define EV_P void
 185 # define EV_P_
 186 # define EV_A
 187 # define EV_A_
 188 # define EV_DEFAULT
 189 # define EV_DEFAULT_
 190 # define EV_DEFAULT_UC
 191 # define EV_DEFAULT_UC_
 192 # undef EV_EMBED_ENABLE
 193 #endif
 194
 195 /* EV_INLINE is used for functions in header files */
 196 #if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
 197 # define EV_INLINE static inline
 198 #else
 199 # define EV_INLINE static
 200 #endif
 201
 202 #ifdef EV_API_STATIC
 203 # define EV_API_DECL static
 204 #else
 205 # define EV_API_DECL extern
 206 #endif
 207
 208 /* EV_PROTOTYPES can be used to switch of prototype declarations */
 209 #ifndef EV_PROTOTYPES
 210 # define EV_PROTOTYPES 1
 211 #endif
 212
 213 /*****************************************************************************/
 214
 215 #define EV_VERSION_MAJOR 4
 216 #define EV_VERSION_MINOR 18
 217
 218 /* eventmask, revents, events... */
 219 enum {
 220   EV_UNDEF    = (int)0xFFFFFFFF, /* guaranteed to be invalid */
 221   EV_NONE     =            0x00, /* no events */
 222   EV_READ     =            0x01, /* ev_io detected read will not block */
 223   EV_WRITE    =            0x02, /* ev_io detected write will not block */
 224   EV__IOFDSET =            0x80, /* internal use only */
 225   EV_IO       =         EV_READ, /* alias for type-detection */
 226   EV_TIMER    =      0x00000100, /* timer timed out */
 227 #if EV_COMPAT3
 228   EV_TIMEOUT  =        EV_TIMER, /* pre 4.0 API compatibility */
 229 #endif
 230   EV_PERIODIC =      0x00000200, /* periodic timer timed out */
 231   EV_SIGNAL   =      0x00000400, /* signal was received */
 232   EV_CHILD    =      0x00000800, /* child/pid had status change */
 233   EV_STAT     =      0x00001000, /* stat data changed */
 234   EV_IDLE     =      0x00002000, /* event loop is idling */
 235   EV_PREPARE  =      0x00004000, /* event loop about to poll */
 236   EV_CHECK    =      0x00008000, /* event loop finished poll */
 237   EV_EMBED    =      0x00010000, /* embedded event loop needs sweep */
 238   EV_FORK     =      0x00020000, /* event loop resumed in child */
 239   EV_CLEANUP  =      0x00040000, /* event loop resumed in child */
 240   EV_ASYNC    =      0x00080000, /* async intra-loop signal */
 241   EV_CUSTOM   =      0x01000000, /* for use by user code */
 242   EV_ERROR    = (int)0x80000000  /* sent when an error occurs */
 243 };
 244
 245 /* can be used to add custom fields to all watchers, while losing binary compatibility */
 246 #ifndef EV_COMMON
 247 # define EV_COMMON void *data;
 248 #endif
 249
 250 #ifndef EV_CB_DECLARE
 251 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
 252 #endif
 253 #ifndef EV_CB_INVOKE
 254 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
 255 #endif
 256
 257 /* not official, do not use */
 258 #define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
 259
 260 /*
 261  * struct member types:
 262  * private: you may look at them, but not change them,
 263  *          and they might not mean anything to you.
 264  * ro: can be read anytime, but only changed when the watcher isn't active.
 265  * rw: can be read and modified anytime, even when the watcher is active.
 266  *
 267  * some internal details that might be helpful for debugging:
 268  *
 269  * active is either 0, which means the watcher is not active,
 270  *           or the array index of the watcher (periodics, timers)
 271  *           or the array index + 1 (most other watchers)
 272  *           or simply 1 for watchers that aren't in some array.
 273  * pending is either 0, in which case the watcher isn't,
 274  *           or the array index + 1 in the pendings array.
 275  */
 276
 277 #if EV_MINPRI == EV_MAXPRI
 278 # define EV_DECL_PRIORITY
 279 #elif !defined (EV_DECL_PRIORITY)
 280 # define EV_DECL_PRIORITY int priority;
 281 #endif
 282
 283 /* shared by all watchers */
 284 #define EV_WATCHER(type)                        \
 285   int active; /* private */                     \
 286   int pending; /* private */                    \
 287   EV_DECL_PRIORITY /* private */                \
 288   EV_COMMON /* rw */                            \
 289   EV_CB_DECLARE (type) /* private */
 290
 291 #define EV_WATCHER_LIST(type)                   \
 292   EV_WATCHER (type)                             \
 293   struct ev_watcher_list *next; /* private */
 294
 295 #define EV_WATCHER_TIME(type)                   \
 296   EV_WATCHER (type)                             \
 297   ev_tstamp at;     /* private */
 298
 299 /* base class, nothing to see here unless you subclass */
 300 typedef struct ev_watcher
 301 {
 302   EV_WATCHER (ev_watcher)
 303 } ev_watcher;
 304
 305 /* base class, nothing to see here unless you subclass */
 306 typedef struct ev_watcher_list
 307 {
 308   EV_WATCHER_LIST (ev_watcher_list)
 309 } ev_watcher_list;
 310
 311 /* base class, nothing to see here unless you subclass */
 312 typedef struct ev_watcher_time
 313 {
 314   EV_WATCHER_TIME (ev_watcher_time)
 315 } ev_watcher_time;
 316
 317 /* invoked when fd is either EV_READable or EV_WRITEable */
 318 /* revent EV_READ, EV_WRITE */
 319 typedef struct ev_io
 320 {
 321   EV_WATCHER_LIST (ev_io)
 322
 323   int fd;     /* ro */
 324   int events; /* ro */
 325 } ev_io;
 326
 327 /* invoked after a specific time, repeatable (based on monotonic clock) */
 328 /* revent EV_TIMEOUT */
 329 typedef struct ev_timer
 330 {
 331   EV_WATCHER_TIME (ev_timer)
 332
 333   ev_tstamp repeat; /* rw */
 334 } ev_timer;
 335
 336 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
 337 /* revent EV_PERIODIC */
 338 typedef struct ev_periodic
 339 {
 340   EV_WATCHER_TIME (ev_periodic)
 341
 342   ev_tstamp offset; /* rw */
 343   ev_tstamp interval; /* rw */
 344   ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) EV_THROW; /* rw */
 345 } ev_periodic;
 346
 347 /* invoked when the given signal has been received */
 348 /* revent EV_SIGNAL */
 349 typedef struct ev_signal
 350 {
 351   EV_WATCHER_LIST (ev_signal)
 352
 353   int signum; /* ro */
 354 } ev_signal;
 355
 356 /* invoked when sigchld is received and waitpid indicates the given pid */
 357 /* revent EV_CHILD */
 358 /* does not support priorities */
 359 typedef struct ev_child
 360 {
 361   EV_WATCHER_LIST (ev_child)
 362
 363   int flags;   /* private */
 364   int pid;     /* ro */
 365   int rpid;    /* rw, holds the received pid */
 366   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
 367 } ev_child;
 368
 369 #if EV_STAT_ENABLE
 370 /* st_nlink = 0 means missing file or other error */
 371 # ifdef _WIN32
 372 typedef struct _stati64 ev_statdata;
 373 # else
 374 typedef struct stat ev_statdata;
 375 # endif
 376
 377 /* invoked each time the stat data changes for a given path */
 378 /* revent EV_STAT */
 379 typedef struct ev_stat
 380 {
 381   EV_WATCHER_LIST (ev_stat)
 382
 383   ev_timer timer;     /* private */
 384   ev_tstamp interval; /* ro */
 385   const char *path;   /* ro */
 386   ev_statdata prev;   /* ro */
 387   ev_statdata attr;   /* ro */
 388
 389   int wd; /* wd for inotify, fd for kqueue */
 390 } ev_stat;
 391 #endif
 392
 393 #if EV_IDLE_ENABLE
 394 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 395 /* revent EV_IDLE */
 396 typedef struct ev_idle
 397 {
 398   EV_WATCHER (ev_idle)
 399 } ev_idle;
 400 #endif
 401
 402 /* invoked for each run of the mainloop, just before the blocking call */
 403 /* you can still change events in any way you like */
 404 /* revent EV_PREPARE */
 405 typedef struct ev_prepare
 406 {
 407   EV_WATCHER (ev_prepare)
 408 } ev_prepare;
 409
 410 /* invoked for each run of the mainloop, just after the blocking call */
 411 /* revent EV_CHECK */
 412 typedef struct ev_check
 413 {
 414   EV_WATCHER (ev_check)
 415 } ev_check;
 416
 417 #if EV_FORK_ENABLE
 418 /* the callback gets invoked before check in the child process when a fork was detected */
 419 /* revent EV_FORK */
 420 typedef struct ev_fork
 421 {
 422   EV_WATCHER (ev_fork)
 423 } ev_fork;
 424 #endif
 425
 426 #if EV_CLEANUP_ENABLE
 427 /* is invoked just before the loop gets destroyed */
 428 /* revent EV_CLEANUP */
 429 typedef struct ev_cleanup
 430 {
 431   EV_WATCHER (ev_cleanup)
 432 } ev_cleanup;
 433 #endif
 434
 435 #if EV_EMBED_ENABLE
 436 /* used to embed an event loop inside another */
 437 /* the callback gets invoked when the event loop has handled events, and can be 0 */
 438 typedef struct ev_embed
 439 {
 440   EV_WATCHER (ev_embed)
 441
 442   struct ev_loop *other; /* ro */
 443   ev_io io;              /* private */
 444   ev_prepare prepare;    /* private */
 445   ev_check check;        /* unused */
 446   ev_timer timer;        /* unused */
 447   ev_periodic periodic;  /* unused */
 448   ev_idle idle;          /* unused */
 449   ev_fork fork;          /* private */
 450 #if EV_CLEANUP_ENABLE
 451   ev_cleanup cleanup;    /* unused */
 452 #endif
 453 } ev_embed;
 454 #endif
 455
 456 #if EV_ASYNC_ENABLE
 457 /* invoked when somebody calls ev_async_send on the watcher */
 458 /* revent EV_ASYNC */
 459 typedef struct ev_async
 460 {
 461   EV_WATCHER (ev_async)
 462
 463   EV_ATOMIC_T sent; /* private */
 464 } ev_async;
 465
 466 # define ev_async_pending(w) (+(w)->sent)
 467 #endif
 468
 469 /* the presence of this union forces similar struct layout */
 470 union ev_any_watcher
 471 {
 472   struct ev_watcher w;
 473   struct ev_watcher_list wl;
 474
 475   struct ev_io io;
 476   struct ev_timer timer;
 477   struct ev_periodic periodic;
 478   struct ev_signal signal;
 479   struct ev_child child;
 480 #if EV_STAT_ENABLE
 481   struct ev_stat stat;
 482 #endif
 483 #if EV_IDLE_ENABLE
 484   struct ev_idle idle;
 485 #endif
 486   struct ev_prepare prepare;
 487   struct ev_check check;
 488 #if EV_FORK_ENABLE
 489   struct ev_fork fork;
 490 #endif
 491 #if EV_CLEANUP_ENABLE
 492   struct ev_cleanup cleanup;
 493 #endif
 494 #if EV_EMBED_ENABLE
 495   struct ev_embed embed;
 496 #endif
 497 #if EV_ASYNC_ENABLE
 498   struct ev_async async;
 499 #endif
 500 };
 501
 502 /* flag bits for ev_default_loop and ev_loop_new */
 503 enum {
 504   /* the default */
 505   EVFLAG_AUTO      = 0x00000000U, /* not quite a mask */
 506   /* flag bits */
 507   EVFLAG_NOENV     = 0x01000000U, /* do NOT consult environment */
 508   EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
 509   /* debugging/feature disable */
 510   EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
 511 #if EV_COMPAT3
 512   EVFLAG_NOSIGFD   = 0, /* compatibility to pre-3.9 */
 513 #endif
 514   EVFLAG_SIGNALFD  = 0x00200000U, /* attempt to use signalfd */
 515   EVFLAG_NOSIGMASK = 0x00400000U  /* avoid modifying the signal mask */
 516 };
 517
 518 /* method bits to be ored together */
 519 enum {
 520   EVBACKEND_SELECT  = 0x00000001U, /* about anywhere */
 521   EVBACKEND_POLL    = 0x00000002U, /* !win */
 522   EVBACKEND_EPOLL   = 0x00000004U, /* linux */
 523   EVBACKEND_KQUEUE  = 0x00000008U, /* bsd */
 524   EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
 525   EVBACKEND_PORT    = 0x00000020U, /* solaris 10 */
 526   EVBACKEND_ALL     = 0x0000003FU, /* all known backends */
 527   EVBACKEND_MASK    = 0x0000FFFFU  /* all future backends */
 528 };
 529
 530 #if EV_PROTOTYPES
 531 EV_API_DECL int ev_version_major (void) EV_THROW;
 532 EV_API_DECL int ev_version_minor (void) EV_THROW;
 533
 534 EV_API_DECL unsigned int ev_supported_backends (void) EV_THROW;
 535 EV_API_DECL unsigned int ev_recommended_backends (void) EV_THROW;
 536 EV_API_DECL unsigned int ev_embeddable_backends (void) EV_THROW;
 537
 538 EV_API_DECL ev_tstamp ev_time (void) EV_THROW;
 539 EV_API_DECL void ev_sleep (ev_tstamp delay) EV_THROW; /* sleep for a while */
 540
 541 /* Sets the allocation function to use, works like realloc.
 542  * It is used to allocate and free memory.
 543  * If it returns zero when memory needs to be allocated, the library might abort
 544  * or take some potentially destructive action.
 545  * The default is your system realloc function.
 546  */
 547 EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size) EV_THROW) EV_THROW;
 548
 549 /* set the callback function to call on a
 550  * retryable syscall error
 551  * (such as failed select, poll, epoll_wait)
 552  */
 553 EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg) EV_THROW) EV_THROW;
 554
 555 #if EV_MULTIPLICITY
 556
 557 /* the default loop is the only one that handles signals and child watchers */
 558 /* you can call this as often as you like */
 559 EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW;
 560
 561 #ifdef EV_API_STATIC
 562 EV_API_DECL struct ev_loop *ev_default_loop_ptr;
 563 #endif
 564
 565 EV_INLINE struct ev_loop *
 566 ev_default_loop_uc_ (void) EV_THROW
 567 {
 568   extern struct ev_loop *ev_default_loop_ptr;
 569
 570   return ev_default_loop_ptr;
 571 }
 572
 573 EV_INLINE int
 574 ev_is_default_loop (EV_P) EV_THROW
 575 {
 576   return EV_A == EV_DEFAULT_UC;
 577 }
 578
 579 /* create and destroy alternative loops that don't handle signals */
 580 EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)) EV_THROW;
 581
 582 EV_API_DECL ev_tstamp ev_now (EV_P) EV_THROW; /* time w.r.t. timers and the eventloop, updated after each poll */
 583
 584 #else
 585
 586 EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW; /* returns true when successful */
 587
 588 EV_API_DECL ev_tstamp ev_rt_now;
 589
 590 EV_INLINE ev_tstamp
 591 ev_now (void) EV_THROW
 592 {
 593   return ev_rt_now;
 594 }
 595
 596 /* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
 597 EV_INLINE int
 598 ev_is_default_loop (void) EV_THROW
 599 {
 600   return 1;
 601 }
 602
 603 #endif /* multiplicity */
 604
 605 /* destroy event loops, also works for the default loop */
 606 EV_API_DECL void ev_loop_destroy (EV_P);
 607
 608 /* this needs to be called after fork, to duplicate the loop */
 609 /* when you want to re-use it in the child */
 610 /* you can call it in either the parent or the child */
 611 /* you can actually call it at any time, anywhere :) */
 612 EV_API_DECL void ev_loop_fork (EV_P) EV_THROW;
 613
 614 EV_API_DECL unsigned int ev_backend (EV_P) EV_THROW; /* backend in use by loop */
 615
 616 EV_API_DECL void ev_now_update (EV_P) EV_THROW; /* update event loop time */
 617
 618 #if EV_WALK_ENABLE
 619 /* walk (almost) all watchers in the loop of a given type, invoking the */
 620 /* callback on every such watcher. The callback might stop the watcher, */
 621 /* but do nothing else with the loop */
 622 EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)) EV_THROW;
 623 #endif
 624
 625 #endif /* prototypes */
 626
 627 /* ev_run flags values */
 628 enum {
 629   EVRUN_NOWAIT = 1, /* do not block/wait */
 630   EVRUN_ONCE   = 2  /* block *once* only */
 631 };
 632
 633 /* ev_break how values */
 634 enum {
 635   EVBREAK_CANCEL = 0, /* undo unloop */
 636   EVBREAK_ONE    = 1, /* unloop once */
 637   EVBREAK_ALL    = 2  /* unloop all loops */
 638 };
 639
 640 #if EV_PROTOTYPES
 641 EV_API_DECL int  ev_run (EV_P_ int flags EV_CPP (= 0));
 642 EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)) EV_THROW; /* break out of the loop */
 643
 644 /*
 645  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
 646  * keeps one reference. if you have a long-running watcher you never unregister that
 647  * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
 648  */
 649 EV_API_DECL void ev_ref   (EV_P) EV_THROW;
 650 EV_API_DECL void ev_unref (EV_P) EV_THROW;
 651
 652 /*
 653  * convenience function, wait for a single event, without registering an event watcher
 654  * if timeout is < 0, do wait indefinitely
 655  */
 656 EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg) EV_THROW;
 657
 658 # if EV_FEATURE_API
 659 EV_API_DECL unsigned int ev_iteration (EV_P) EV_THROW; /* number of loop iterations */
 660 EV_API_DECL unsigned int ev_depth     (EV_P) EV_THROW; /* #ev_loop enters - #ev_loop leaves */
 661 EV_API_DECL void         ev_verify    (EV_P) EV_THROW; /* abort if loop data corrupted */
 662
 663 EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
 664 EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
 665
 666 /* advanced stuff for threading etc. support, see docs */
 667 EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_THROW;
 668 EV_API_DECL void *ev_userdata (EV_P) EV_THROW;
 669 typedef void (*ev_loop_callback)(EV_P);
 670 EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ ev_loop_callback invoke_pending_cb) EV_THROW;
 671 EV_API_DECL void ev_set_loop_release_cb (EV_P_ ev_loop_callback EV_THROW release, ev_loop_callback EV_THROW acquire) EV_THROW;
 672
 673 EV_API_DECL unsigned int ev_pending_count (EV_P) EV_THROW; /* number of pending events, if any */
 674 EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
 675
 676 /*
 677  * stop/start the timer handling.
 678  */
 679 EV_API_DECL void ev_suspend (EV_P) EV_THROW;
 680 EV_API_DECL void ev_resume  (EV_P) EV_THROW;
 681 #endif
 682
 683 #endif
 684
 685 /* these may evaluate ev multiple times, and the other arguments at most once */
 686 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
 687 #define ev_init(ev,cb_) do {                    \
 688   ((ev_watcher *)(void *)(ev))->active  =       \
 689   ((ev_watcher *)(void *)(ev))->pending = 0;    \
 690   ev_set_priority ((ev), 0);                    \
 691   ev_set_cb ((ev), cb_);                        \
 692 } while (0)
 693
 694 #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)
 696 #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)
 698 #define ev_child_set(ev,pid_,trace_)         do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
 699 #define ev_stat_set(ev,path_,interval_)      do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
 700 #define ev_idle_set(ev)                      /* nop, yes, this is a serious in-joke */
 701 #define ev_prepare_set(ev)                   /* nop, yes, this is a serious in-joke */
 702 #define ev_check_set(ev)                     /* nop, yes, this is a serious in-joke */
 703 #define ev_embed_set(ev,other_)              do { (ev)->other = (other_); } while (0)
 704 #define ev_fork_set(ev)                      /* nop, yes, this is a serious in-joke */
 705 #define ev_cleanup_set(ev)                   /* nop, yes, this is a serious in-joke */
 706 #define ev_async_set(ev)                     /* nop, yes, this is a serious in-joke */
 707
 708 #define ev_io_init(ev,cb,fd,events)          do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 709 #define ev_timer_init(ev,cb,after,repeat)    do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
 710 #define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
 711 #define ev_signal_init(ev,cb,signum)         do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 712 #define ev_child_init(ev,cb,pid,trace)       do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
 713 #define ev_stat_init(ev,cb,path,interval)    do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
 714 #define ev_idle_init(ev,cb)                  do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 715 #define ev_prepare_init(ev,cb)               do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 716 #define ev_check_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 717 #define ev_embed_init(ev,cb,other)           do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
 718 #define ev_fork_init(ev,cb)                  do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
 719 #define ev_cleanup_init(ev,cb)               do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
 720 #define ev_async_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
 721
 722 #define ev_is_pending(ev)                    (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
 723 #define ev_is_active(ev)                     (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
 724
 725 #define ev_cb(ev)                            (ev)->cb /* rw */
 726
 727 #if EV_MINPRI == EV_MAXPRI
 728 # define ev_priority(ev)                     ((ev), EV_MINPRI)
 729 # define ev_set_priority(ev,pri)             ((ev), (pri))
 730 #else
 731 # define ev_priority(ev)                     (+(((ev_watcher *)(void *)(ev))->priority))
 732 # define ev_set_priority(ev,pri)             (   (ev_watcher *)(void *)(ev))->priority = (pri)
 733 #endif
 734
 735 #define ev_periodic_at(ev)                   (+((ev_watcher_time *)(ev))->at)
 736
 737 #ifndef ev_set_cb
 738 # define ev_set_cb(ev,cb_)                   ev_cb (ev) = (cb_)
 739 #endif
 740
 741 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 742 /* stopping (disabling, deleting) a watcher does nothing unless it's already running */
 743 #if EV_PROTOTYPES
 744
 745 /* feeds an event into a watcher as if the event actually occurred */
 746 /* accepts any ev_watcher type */
 747 EV_API_DECL void ev_feed_event     (EV_P_ void *w, int revents) EV_THROW;
 748 EV_API_DECL void ev_feed_fd_event  (EV_P_ int fd, int revents) EV_THROW;
 749 #if EV_SIGNAL_ENABLE
 750 EV_API_DECL void ev_feed_signal    (int signum) EV_THROW;
 751 EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_THROW;
 752 #endif
 753 EV_API_DECL void ev_invoke         (EV_P_ void *w, int revents);
 754 EV_API_DECL int  ev_clear_pending  (EV_P_ void *w) EV_THROW;
 755
 756 EV_API_DECL void ev_io_start       (EV_P_ ev_io *w) EV_THROW;
 757 EV_API_DECL void ev_io_stop        (EV_P_ ev_io *w) EV_THROW;
 758
 759 EV_API_DECL void ev_timer_start    (EV_P_ ev_timer *w) EV_THROW;
 760 EV_API_DECL void ev_timer_stop     (EV_P_ ev_timer *w) EV_THROW;
 761 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
 762 EV_API_DECL void ev_timer_again    (EV_P_ ev_timer *w) EV_THROW;
 763 /* return remaining time */
 764 EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_THROW;
 765
 766 #if EV_PERIODIC_ENABLE
 767 EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_THROW;
 768 EV_API_DECL void ev_periodic_stop  (EV_P_ ev_periodic *w) EV_THROW;
 769 EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_THROW;
 770 #endif
 771
 772 /* only supported in the default loop */
 773 #if EV_SIGNAL_ENABLE
 774 EV_API_DECL void ev_signal_start   (EV_P_ ev_signal *w) EV_THROW;
 775 EV_API_DECL void ev_signal_stop    (EV_P_ ev_signal *w) EV_THROW;
 776 #endif
 777
 778 /* only supported in the default loop */
 779 # if EV_CHILD_ENABLE
 780 EV_API_DECL void ev_child_start    (EV_P_ ev_child *w) EV_THROW;
 781 EV_API_DECL void ev_child_stop     (EV_P_ ev_child *w) EV_THROW;
 782 # endif
 783
 784 # if EV_STAT_ENABLE
 785 EV_API_DECL void ev_stat_start     (EV_P_ ev_stat *w) EV_THROW;
 786 EV_API_DECL void ev_stat_stop      (EV_P_ ev_stat *w) EV_THROW;
 787 EV_API_DECL void ev_stat_stat      (EV_P_ ev_stat *w) EV_THROW;
 788 # endif
 789
 790 # if EV_IDLE_ENABLE
 791 EV_API_DECL void ev_idle_start     (EV_P_ ev_idle *w) EV_THROW;
 792 EV_API_DECL void ev_idle_stop      (EV_P_ ev_idle *w) EV_THROW;
 793 # endif
 794
 795 #if EV_PREPARE_ENABLE
 796 EV_API_DECL void ev_prepare_start  (EV_P_ ev_prepare *w) EV_THROW;
 797 EV_API_DECL void ev_prepare_stop   (EV_P_ ev_prepare *w) EV_THROW;
 798 #endif
 799
 800 #if EV_CHECK_ENABLE
 801 EV_API_DECL void ev_check_start    (EV_P_ ev_check *w) EV_THROW;
 802 EV_API_DECL void ev_check_stop     (EV_P_ ev_check *w) EV_THROW;
 803 #endif
 804
 805 # if EV_FORK_ENABLE
 806 EV_API_DECL void ev_fork_start     (EV_P_ ev_fork *w) EV_THROW;
 807 EV_API_DECL void ev_fork_stop      (EV_P_ ev_fork *w) EV_THROW;
 808 # endif
 809
 810 # if EV_CLEANUP_ENABLE
 811 EV_API_DECL void ev_cleanup_start  (EV_P_ ev_cleanup *w) EV_THROW;
 812 EV_API_DECL void ev_cleanup_stop   (EV_P_ ev_cleanup *w) EV_THROW;
 813 # endif
 814
 815 # if EV_EMBED_ENABLE
 816 /* only supported when loop to be embedded is in fact embeddable */
 817 EV_API_DECL void ev_embed_start    (EV_P_ ev_embed *w) EV_THROW;
 818 EV_API_DECL void ev_embed_stop     (EV_P_ ev_embed *w) EV_THROW;
 819 EV_API_DECL void ev_embed_sweep    (EV_P_ ev_embed *w) EV_THROW;
 820 # endif
 821
 822 # if EV_ASYNC_ENABLE
 823 EV_API_DECL void ev_async_start    (EV_P_ ev_async *w) EV_THROW;
 824 EV_API_DECL void ev_async_stop     (EV_P_ ev_async *w) EV_THROW;
 825 EV_API_DECL void ev_async_send     (EV_P_ ev_async *w) EV_THROW;
 826 # endif
 827
 828 #if EV_COMPAT3
 829   #define EVLOOP_NONBLOCK EVRUN_NOWAIT
 830   #define EVLOOP_ONESHOT  EVRUN_ONCE
 831   #define EVUNLOOP_CANCEL EVBREAK_CANCEL
 832   #define EVUNLOOP_ONE    EVBREAK_ONE
 833   #define EVUNLOOP_ALL    EVBREAK_ALL
 834   #if EV_PROTOTYPES
 835     EV_INLINE void ev_loop   (EV_P_ int flags) { ev_run   (EV_A_ flags); }
 836     EV_INLINE void ev_unloop (EV_P_ int how  ) { ev_break (EV_A_ how  ); }
 837     EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
 838     EV_INLINE void ev_default_fork    (void) { ev_loop_fork    (EV_DEFAULT); }
 839     #if EV_FEATURE_API
 840       EV_INLINE unsigned int ev_loop_count  (EV_P) { return ev_iteration  (EV_A); }
 841       EV_INLINE unsigned int ev_loop_depth  (EV_P) { return ev_depth      (EV_A); }
 842       EV_INLINE void         ev_loop_verify (EV_P) {        ev_verify     (EV_A); }
 843     #endif
 844   #endif
 845 #else
 846   typedef struct ev_loop ev_loop;
 847 #endif
 848
 849 #endif
 850
 851 EV_CPP(})
 852
 853 #endif
 854