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

Diff Legend

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