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

Comparing libev/ev.h (file contents):
Revision 1.134 by root, Tue Mar 16 00:20:17 2010 UTC vs.
Revision 1.161 by root, Sat Oct 15 09:05:03 2011 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 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
50# define EV_FEATURES 0x3f 59# define EV_FEATURES 0x7f
51#endif 60#endif
52 61
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 62#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2) 63#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
64#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
55#define EV_FEATURE_API ((EV_FEATURES) & 4) 65#define EV_FEATURE_API ((EV_FEATURES) & 8)
56#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 8) 66#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
57#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 16) 67#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
58#define EV_FEATURE_OS ((EV_FEATURES) & 32) 68#define EV_FEATURE_OS ((EV_FEATURES) & 64)
59 69
60/* these priorities are inclusive, higher priorities will be called earlier */ 70/* these priorities are inclusive, higher priorities will be invoked earlier */
61#ifndef EV_MINPRI 71#ifndef EV_MINPRI
62# define EV_MINPRI (EV_FEATURE_API ? -2 : 0) 72# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
63#endif 73#endif
64#ifndef EV_MAXPRI 74#ifndef EV_MAXPRI
65# define EV_MAXPRI (EV_FEATURE_API ? +2 : 0) 75# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
66#endif 76#endif
67 77
68#ifndef EV_MULTIPLICITY 78#ifndef EV_MULTIPLICITY
69# define EV_MULTIPLICITY EV_FEATURE_API 79# define EV_MULTIPLICITY EV_FEATURE_CONFIG
70#endif 80#endif
71 81
72#ifndef EV_PERIODIC_ENABLE 82#ifndef EV_PERIODIC_ENABLE
73# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS 83# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
74#endif 84#endif
89# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS 99# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
90#endif 100#endif
91 101
92#ifndef EV_FORK_ENABLE 102#ifndef EV_FORK_ENABLE
93# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 103# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
104#endif
105
106#ifndef EV_CLEANUP_ENABLE
107# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
94#endif 108#endif
95 109
96#ifndef EV_SIGNAL_ENABLE 110#ifndef EV_SIGNAL_ENABLE
97# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 111# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
98#endif 112#endif
123# undef EV_SIGNAL_ENABLE 137# undef EV_SIGNAL_ENABLE
124# define EV_SIGNAL_ENABLE 1 138# define EV_SIGNAL_ENABLE 1
125#endif 139#endif
126 140
127/*****************************************************************************/ 141/*****************************************************************************/
128
129#if !EV_FEATURE_CODE && !defined (NDEBUG)
130# define NDEBUG 1
131# include <assert.h>
132#endif
133 142
134typedef double ev_tstamp; 143typedef double ev_tstamp;
135 144
136#ifndef EV_ATOMIC_T 145#ifndef EV_ATOMIC_T
137# include <signal.h> 146# include <signal.h>
147#endif 156#endif
148 157
149/* support multiple event loops? */ 158/* support multiple event loops? */
150#if EV_MULTIPLICITY 159#if EV_MULTIPLICITY
151struct ev_loop; 160struct ev_loop;
152# define EV_P struct ev_loop *loop 161# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
153# define EV_P_ EV_P, 162# define EV_P_ EV_P, /* a loop as first of multiple parameters */
154# define EV_A loop 163# define EV_A loop /* a loop as sole argument to a function call */
155# define EV_A_ EV_A, 164# define EV_A_ EV_A, /* a loop as first of multiple arguments */
156# define EV_DEFAULT_UC ev_default_loop_uc () 165# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
157# define EV_DEFAULT_UC_ EV_DEFAULT_UC, 166# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
158# define EV_DEFAULT ev_default_loop (0) 167# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
159# define EV_DEFAULT_ EV_DEFAULT, 168# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
160#else 169#else
161# define EV_P void 170# define EV_P void
162# define EV_P_ 171# define EV_P_
163# define EV_A 172# define EV_A
164# define EV_A_ 173# define EV_A_
167# define EV_DEFAULT_UC 176# define EV_DEFAULT_UC
168# define EV_DEFAULT_UC_ 177# define EV_DEFAULT_UC_
169# undef EV_EMBED_ENABLE 178# undef EV_EMBED_ENABLE
170#endif 179#endif
171 180
181/* EV_INLINE is used for functions in header files */
172#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 182#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
173# define EV_INLINE static inline 183# define EV_INLINE static inline
174#else 184#else
175# define EV_INLINE static 185# define EV_INLINE static
176#endif 186#endif
177 187
188/* EV_PROTOTYPES can be used to switch of prototype declarations */
189#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1
191#endif
192
178/*****************************************************************************/ 193/*****************************************************************************/
179 194
195#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 4
197
180/* eventmask, revents, events... */ 198/* eventmask, revents, events... */
181#define EV_UNDEF -1 /* guaranteed to be invalid */ 199enum {
200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
182#define EV_NONE 0x00 /* no events */ 201 EV_NONE = 0x00, /* no events */
183#define EV_READ 0x01 /* ev_io detected read will not block */ 202 EV_READ = 0x01, /* ev_io detected read will not block */
184#define EV_WRITE 0x02 /* ev_io detected write will not block */ 203 EV_WRITE = 0x02, /* ev_io detected write will not block */
185#define EV__IOFDSET 0x80 /* internal use only */ 204 EV__IOFDSET = 0x80, /* internal use only */
186#define EV_IO EV_READ /* alias for type-detection */ 205 EV_IO = EV_READ, /* alias for type-detection */
187#define EV_TIMEOUT 0x00000100 /* timer timed out */ 206 EV_TIMER = 0x00000100, /* timer timed out */
188#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 207#if EV_COMPAT3
208 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
209#endif
189#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 210 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
190#define EV_SIGNAL 0x00000400 /* signal was received */ 211 EV_SIGNAL = 0x00000400, /* signal was received */
191#define EV_CHILD 0x00000800 /* child/pid had status change */ 212 EV_CHILD = 0x00000800, /* child/pid had status change */
192#define EV_STAT 0x00001000 /* stat data changed */ 213 EV_STAT = 0x00001000, /* stat data changed */
193#define EV_IDLE 0x00002000 /* event loop is idling */ 214 EV_IDLE = 0x00002000, /* event loop is idling */
194#define EV_PREPARE 0x00004000 /* event loop about to poll */ 215 EV_PREPARE = 0x00004000, /* event loop about to poll */
195#define EV_CHECK 0x00008000 /* event loop finished poll */ 216 EV_CHECK = 0x00008000, /* event loop finished poll */
196#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ 217 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
197#define EV_FORK 0x00020000 /* event loop resumed in child */ 218 EV_FORK = 0x00020000, /* event loop resumed in child */
219 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
198#define EV_ASYNC 0x00040000 /* async intra-loop signal */ 220 EV_ASYNC = 0x00080000, /* async intra-loop signal */
199#define EV_CUSTOM 0x01000000 /* for use by user code */ 221 EV_CUSTOM = 0x01000000, /* for use by user code */
200#define EV_ERROR 0x80000000 /* sent when an error occurs */ 222 EV_ERROR = 0x80000000 /* sent when an error occurs */
223};
201 224
202/* can be used to add custom fields to all watchers, while losing binary compatibility */ 225/* can be used to add custom fields to all watchers, while losing binary compatibility */
203#ifndef EV_COMMON 226#ifndef EV_COMMON
204# define EV_COMMON void *data; 227# define EV_COMMON void *data;
205#endif 228#endif
206#ifndef EV_PROTOTYPES
207# define EV_PROTOTYPES 1
208#endif
209
210#define EV_VERSION_MAJOR 3
211#define EV_VERSION_MINOR 9
212 229
213#ifndef EV_CB_DECLARE 230#ifndef EV_CB_DECLARE
214# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 231# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
215#endif 232#endif
216#ifndef EV_CB_INVOKE 233#ifndef EV_CB_INVOKE
217# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 234# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
218#endif 235#endif
236
237/* not official, do not use */
238#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
219 239
220/* 240/*
221 * struct member types: 241 * struct member types:
222 * private: you may look at them, but not change them, 242 * private: you may look at them, but not change them,
223 * and they might not mean anything to you. 243 * and they might not mean anything to you.
234 * or the array index + 1 in the pendings array. 254 * or the array index + 1 in the pendings array.
235 */ 255 */
236 256
237#if EV_MINPRI == EV_MAXPRI 257#if EV_MINPRI == EV_MAXPRI
238# define EV_DECL_PRIORITY 258# define EV_DECL_PRIORITY
239#else 259#elif !defined (EV_DECL_PRIORITY)
240# define EV_DECL_PRIORITY int priority; 260# define EV_DECL_PRIORITY int priority;
241#endif 261#endif
242 262
243/* shared by all watchers */ 263/* shared by all watchers */
244#define EV_WATCHER(type) \ 264#define EV_WATCHER(type) \
374 EV_WATCHER (ev_check) 394 EV_WATCHER (ev_check)
375} ev_check; 395} ev_check;
376 396
377#if EV_FORK_ENABLE 397#if EV_FORK_ENABLE
378/* the callback gets invoked before check in the child process when a fork was detected */ 398/* the callback gets invoked before check in the child process when a fork was detected */
399/* revent EV_FORK */
379typedef struct ev_fork 400typedef struct ev_fork
380{ 401{
381 EV_WATCHER (ev_fork) 402 EV_WATCHER (ev_fork)
382} ev_fork; 403} ev_fork;
404#endif
405
406#if EV_CLEANUP_ENABLE
407/* is invoked just before the loop gets destroyed */
408/* revent EV_CLEANUP */
409typedef struct ev_cleanup
410{
411 EV_WATCHER (ev_cleanup)
412} ev_cleanup;
383#endif 413#endif
384 414
385#if EV_EMBED_ENABLE 415#if EV_EMBED_ENABLE
386/* used to embed an event loop inside another */ 416/* used to embed an event loop inside another */
387/* the callback gets invoked when the event loop has handled events, and can be 0 */ 417/* the callback gets invoked when the event loop has handled events, and can be 0 */
395 ev_check check; /* unused */ 425 ev_check check; /* unused */
396 ev_timer timer; /* unused */ 426 ev_timer timer; /* unused */
397 ev_periodic periodic; /* unused */ 427 ev_periodic periodic; /* unused */
398 ev_idle idle; /* unused */ 428 ev_idle idle; /* unused */
399 ev_fork fork; /* private */ 429 ev_fork fork; /* private */
430#if EV_CLEANUP_ENABLE
431 ev_cleanup cleanup; /* unused */
432#endif
400} ev_embed; 433} ev_embed;
401#endif 434#endif
402 435
403#if EV_ASYNC_ENABLE 436#if EV_ASYNC_ENABLE
404/* invoked when somebody calls ev_async_send on the watcher */ 437/* invoked when somebody calls ev_async_send on the watcher */
433 struct ev_prepare prepare; 466 struct ev_prepare prepare;
434 struct ev_check check; 467 struct ev_check check;
435#if EV_FORK_ENABLE 468#if EV_FORK_ENABLE
436 struct ev_fork fork; 469 struct ev_fork fork;
437#endif 470#endif
471#if EV_CLEANUP_ENABLE
472 struct ev_cleanup cleanup;
473#endif
438#if EV_EMBED_ENABLE 474#if EV_EMBED_ENABLE
439 struct ev_embed embed; 475 struct ev_embed embed;
440#endif 476#endif
441#if EV_ASYNC_ENABLE 477#if EV_ASYNC_ENABLE
442 struct ev_async async; 478 struct ev_async async;
443#endif 479#endif
444}; 480};
445 481
446/* bits for ev_default_loop and ev_loop_new */ 482/* flag bits for ev_default_loop and ev_loop_new */
483enum {
447/* the default */ 484 /* the default */
448#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 485 EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
449/* flag bits */ 486 /* flag bits */
450#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 487 EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
451#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 488 EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
452/* debugging/feature disable */ 489 /* debugging/feature disable */
453#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 490 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
491#if EV_COMPAT3
454#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */ 492 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
493#endif
455#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */ 494 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
495 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
496};
497
456/* method bits to be ored together */ 498/* method bits to be ored together */
499enum {
457#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 500 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
458#define EVBACKEND_POLL 0x00000002U /* !win */ 501 EVBACKEND_POLL = 0x00000002U, /* !win */
459#define EVBACKEND_EPOLL 0x00000004U /* linux */ 502 EVBACKEND_EPOLL = 0x00000004U, /* linux */
460#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 503 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
461#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 504 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
462#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 505 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
463#define EVBACKEND_ALL 0x0000003FU 506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508};
464 509
465#if EV_PROTOTYPES 510#if EV_PROTOTYPES
466int ev_version_major (void); 511int ev_version_major (void);
467int ev_version_minor (void); 512int ev_version_minor (void);
468 513
486 * (such as failed select, poll, epoll_wait) 531 * (such as failed select, poll, epoll_wait)
487 */ 532 */
488void ev_set_syserr_cb (void (*cb)(const char *msg)); 533void ev_set_syserr_cb (void (*cb)(const char *msg));
489 534
490#if EV_MULTIPLICITY 535#if EV_MULTIPLICITY
536
537/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
540
491EV_INLINE struct ev_loop * 541EV_INLINE struct ev_loop *
492ev_default_loop_uc (void) 542ev_default_loop_uc_ (void)
493{ 543{
494 extern struct ev_loop *ev_default_loop_ptr; 544 extern struct ev_loop *ev_default_loop_ptr;
495 545
496 return ev_default_loop_ptr; 546 return ev_default_loop_ptr;
497} 547}
498 548
499/* the default loop is the only one that handles signals and child watchers */ 549EV_INLINE int
500/* you can call this as often as you like */ 550ev_is_default_loop (EV_P)
501EV_INLINE struct ev_loop *
502ev_default_loop (unsigned int flags)
503{ 551{
504 struct ev_loop *loop = ev_default_loop_uc (); 552 return EV_A == EV_DEFAULT_UC;
505
506 if (!loop)
507 {
508 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
509
510 loop = ev_default_loop_init (flags);
511 }
512
513 return loop;
514} 553}
515 554
516/* create and destroy alternative loops that don't handle signals */ 555/* create and destroy alternative loops that don't handle signals */
517struct ev_loop *ev_loop_new (unsigned int flags); 556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
518void ev_loop_destroy (EV_P);
519void ev_loop_fork (EV_P);
520 557
521ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 558ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
522 559
523#else 560#else
524 561
525int ev_default_loop (unsigned int flags); /* returns true when successful */ 562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
526 563
527EV_INLINE ev_tstamp 564EV_INLINE ev_tstamp
528ev_now (void) 565ev_now (void)
529{ 566{
530 extern ev_tstamp ev_rt_now; 567 extern ev_tstamp ev_rt_now;
531 568
532 return ev_rt_now; 569 return ev_rt_now;
533} 570}
571
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
573EV_INLINE int
574ev_is_default_loop (void)
575{
576 return 1;
577}
578
534#endif /* multiplicity */ 579#endif /* multiplicity */
535 580
536EV_INLINE int 581/* destroy event loops, also works for the default loop */
537ev_is_default_loop (EV_P) 582void ev_loop_destroy (EV_P);
538{
539#if EV_MULTIPLICITY
540 extern struct ev_loop *ev_default_loop_ptr;
541 583
542 return !!(EV_A == ev_default_loop_ptr);
543#else
544 return 1;
545#endif
546}
547
548void ev_default_destroy (void); /* destroy the default loop */
549/* this needs to be called after fork, to duplicate the default loop */ 584/* this needs to be called after fork, to duplicate the loop */
550/* if you create alternative loops you have to call ev_loop_fork on them */ 585/* when you want to re-use it in the child */
551/* you can call it in either the parent or the child */ 586/* you can call it in either the parent or the child */
552/* you can actually call it at any time, anywhere :) */ 587/* you can actually call it at any time, anywhere :) */
553void ev_default_fork (void); 588void ev_loop_fork (EV_P);
554 589
555unsigned int ev_backend (EV_P); /* backend in use by loop */ 590unsigned int ev_backend (EV_P); /* backend in use by loop */
556 591
557void ev_now_update (EV_P); /* update event loop time */ 592void ev_now_update (EV_P); /* update event loop time */
558 593
563void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 598void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
564#endif 599#endif
565 600
566#endif /* prototypes */ 601#endif /* prototypes */
567 602
568#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 603/* ev_run flags values */
569#define EVLOOP_ONESHOT 2 /* block *once* only */ 604enum {
570#define EVUNLOOP_CANCEL 0 /* undo unloop */ 605 EVRUN_NOWAIT = 1, /* do not block/wait */
571#define EVUNLOOP_ONE 1 /* unloop once */ 606 EVRUN_ONCE = 2 /* block *once* only */
607};
608
609/* ev_break how values */
610enum {
611 EVBREAK_CANCEL = 0, /* undo unloop */
612 EVBREAK_ONE = 1, /* unloop once */
572#define EVUNLOOP_ALL 2 /* unloop all loops */ 613 EVBREAK_ALL = 2 /* unloop all loops */
614};
573 615
574#if EV_PROTOTYPES 616#if EV_PROTOTYPES
575void ev_loop (EV_P_ int flags); 617void ev_run (EV_P_ int flags EV_CPP (= 0));
576void 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 */ 618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
577 619
578/* 620/*
579 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 621 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
580 * keeps one reference. if you have a long-running watcher you never unregister that 622 * keeps one reference. if you have a long-running watcher you never unregister that
581 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 623 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
588 * if timeout is < 0, do wait indefinitely 630 * if timeout is < 0, do wait indefinitely
589 */ 631 */
590void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 632void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
591 633
592# if EV_FEATURE_API 634# if EV_FEATURE_API
593unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 635unsigned int ev_iteration (EV_P); /* number of loop iterations */
594unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
595void ev_loop_verify (EV_P); /* abort if loop data corrupted */ 637void ev_verify (EV_P); /* abort if loop data corrupted */
596 638
597void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
598void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
599 641
600/* advanced stuff for threading etc. support, see docs */ 642/* advanced stuff for threading etc. support, see docs */
633#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 675#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
634#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 676#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
635#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 677#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
636#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 678#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
637#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 679#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
638#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 680#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
681#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
639 682
640#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 683#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
641#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 684#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
642#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 685#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
643#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 686#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
646#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 689#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
647#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 690#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
648#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 691#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
649#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 692#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
650#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 693#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
694#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
651#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 695#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
652 696
653#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 697#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
654#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 698#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
655 699
671 715
672/* stopping (enabling, adding) a watcher does nothing if it is already running */ 716/* stopping (enabling, adding) a watcher does nothing if it is already running */
673/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 717/* stopping (disabling, deleting) a watcher does nothing unless its already running */
674#if EV_PROTOTYPES 718#if EV_PROTOTYPES
675 719
676/* feeds an event into a watcher as if the event actually occured */ 720/* feeds an event into a watcher as if the event actually occurred */
677/* accepts any ev_watcher type */ 721/* accepts any ev_watcher type */
678void ev_feed_event (EV_P_ void *w, int revents); 722void ev_feed_event (EV_P_ void *w, int revents);
679void ev_feed_fd_event (EV_P_ int fd, int revents); 723void ev_feed_fd_event (EV_P_ int fd, int revents);
680#if EV_SIGNAL_ENABLE 724#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum);
681void ev_feed_signal_event (EV_P_ int signum); 726void ev_feed_signal_event (EV_P_ int signum);
682#endif 727#endif
683void ev_invoke (EV_P_ void *w, int revents); 728void ev_invoke (EV_P_ void *w, int revents);
684int ev_clear_pending (EV_P_ void *w); 729int ev_clear_pending (EV_P_ void *w);
685 730
735# if EV_FORK_ENABLE 780# if EV_FORK_ENABLE
736void ev_fork_start (EV_P_ ev_fork *w); 781void ev_fork_start (EV_P_ ev_fork *w);
737void ev_fork_stop (EV_P_ ev_fork *w); 782void ev_fork_stop (EV_P_ ev_fork *w);
738# endif 783# endif
739 784
785# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w);
788# endif
789
740# if EV_EMBED_ENABLE 790# if EV_EMBED_ENABLE
741/* only supported when loop to be embedded is in fact embeddable */ 791/* only supported when loop to be embedded is in fact embeddable */
742void ev_embed_start (EV_P_ ev_embed *w); 792void ev_embed_start (EV_P_ ev_embed *w);
743void ev_embed_stop (EV_P_ ev_embed *w); 793void ev_embed_stop (EV_P_ ev_embed *w);
744void ev_embed_sweep (EV_P_ ev_embed *w); 794void ev_embed_sweep (EV_P_ ev_embed *w);
748void ev_async_start (EV_P_ ev_async *w); 798void ev_async_start (EV_P_ ev_async *w);
749void ev_async_stop (EV_P_ ev_async *w); 799void ev_async_stop (EV_P_ ev_async *w);
750void ev_async_send (EV_P_ ev_async *w); 800void ev_async_send (EV_P_ ev_async *w);
751# endif 801# endif
752 802
803#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE
806 #define EVUNLOOP_CANCEL EVBREAK_CANCEL
807 #define EVUNLOOP_ONE EVBREAK_ONE
808 #define EVUNLOOP_ALL EVBREAK_ALL
809 #if EV_PROTOTYPES
810 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
811 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
812 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
813 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
814 #if EV_FEATURE_API
815 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
816 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
817 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
818 #endif
753#endif 819 #endif
754 820#else
755#ifdef __cplusplus 821 typedef struct ev_loop ev_loop;
756}
757#endif 822#endif
758 823
759#endif 824#endif
760 825
826EV_CPP(})
827
828#endif
829

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines