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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines