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

Comparing libev/ev.h (file contents):
Revision 1.133 by root, Wed Mar 10 09:23:07 2010 UTC vs.
Revision 1.162 by root, Tue Dec 20 04:08:35 2011 UTC

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

Diff Legend

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