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

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

Diff Legend

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