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

Comparing libev/ev.h (file contents):
Revision 1.42 by root, Fri Nov 9 15:15:21 2007 UTC vs.
Revision 1.135 by root, Tue Mar 16 00:26:41 2010 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de>
3 * All rights reserved. 5 * All rights reserved.
4 * 6 *
5 * Redistribution and use in source and binary forms, with or without 7 * Redistribution and use in source and binary forms, with or without modifica-
6 * modification, are permitted provided that the following conditions are 8 * tion, are permitted provided that the following conditions are met:
7 * met: 9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
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-
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-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE.
8 * 27 *
9 * * Redistributions of source code must retain the above copyright 28 * Alternatively, the contents of this file may be used under the terms of
10 * notice, this list of conditions and the following disclaimer. 29 * the GNU General Public License ("GPL") version 2 or any later version,
11 * 30 * in which case the provisions of the GPL are applicable instead of
12 * * Redistributions in binary form must reproduce the above 31 * the above. If you wish to allow the use of your version of this file
13 * copyright notice, this list of conditions and the following 32 * only under the terms of the GPL and not to allow others to use your
14 * disclaimer in the documentation and/or other materials provided 33 * version of this file under the BSD license, indicate your decision
15 * with the distribution. 34 * by deleting the provisions above and replace them with the notice
16 * 35 * and other provisions required by the GPL. If you do not delete the
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 36 * provisions above, a recipient may use your version of this file under
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 37 * either the BSD or the GPL.
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 38 */
29 39
30#ifndef EV_H 40#ifndef EV_H_
31#define EV_H 41#define EV_H_
32 42
33#ifdef __cplusplus 43#ifdef __cplusplus
34extern "C" { 44extern "C" {
35#endif 45#endif
36 46
37typedef double ev_tstamp; 47/*****************************************************************************/
48
49#ifndef EV_FEATURES
50# define EV_FEATURES 0x3f
51#endif
52
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
55#define EV_FEATURE_API ((EV_FEATURES) & 4)
56#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 8)
57#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 16)
58#define EV_FEATURE_OS ((EV_FEATURES) & 32)
38 59
39/* these priorities are inclusive, higher priorities will be called earlier */ 60/* these priorities are inclusive, higher priorities will be called earlier */
40#ifndef EV_MINPRI 61#ifndef EV_MINPRI
41# define EV_MINPRI -2 62# define EV_MINPRI (EV_FEATURE_API ? -2 : 0)
42#endif 63#endif
43#ifndef EV_MAXPRI 64#ifndef EV_MAXPRI
44# define EV_MAXPRI +2 65# define EV_MAXPRI (EV_FEATURE_API ? +2 : 0)
45#endif 66#endif
46 67
47#ifndef EV_MULTIPLICITY 68#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1 69# define EV_MULTIPLICITY EV_FEATURE_API
70#endif
71
72#ifndef EV_PERIODIC_ENABLE
73# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
74#endif
75
76#ifndef EV_STAT_ENABLE
77# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
78#endif
79
80#ifndef EV_PREPARE_ENABLE
81# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
82#endif
83
84#ifndef EV_CHECK_ENABLE
85# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
86#endif
87
88#ifndef EV_IDLE_ENABLE
89# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
90#endif
91
92#ifndef EV_FORK_ENABLE
93# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
94#endif
95
96#ifndef EV_SIGNAL_ENABLE
97# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
98#endif
99
100#ifndef EV_CHILD_ENABLE
101# ifdef _WIN32
102# define EV_CHILD_ENABLE 0
103# else
104# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
105#endif
106#endif
107
108#ifndef EV_ASYNC_ENABLE
109# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
110#endif
111
112#ifndef EV_EMBED_ENABLE
113# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
114#endif
115
116#ifndef EV_WALK_ENABLE
117# define EV_WALK_ENABLE 0 /* not yet */
118#endif
119
120/*****************************************************************************/
121
122#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
123# undef EV_SIGNAL_ENABLE
124# define EV_SIGNAL_ENABLE 1
125#endif
126
127/*****************************************************************************/
128
129typedef double ev_tstamp;
130
131#ifndef EV_ATOMIC_T
132# include <signal.h>
133# define EV_ATOMIC_T sig_atomic_t volatile
134#endif
135
136#if EV_STAT_ENABLE
137# ifdef _WIN32
138# include <time.h>
139# include <sys/types.h>
140# endif
141# include <sys/stat.h>
49#endif 142#endif
50 143
51/* support multiple event loops? */ 144/* support multiple event loops? */
52#if EV_MULTIPLICITY 145#if EV_MULTIPLICITY
53struct ev_loop; 146struct ev_loop;
54# define EV_P struct ev_loop *loop 147# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P, 148# define EV_P_ EV_P,
56# define EV_A loop 149# define EV_A loop
57# define EV_A_ EV_A, 150# define EV_A_ EV_A,
151# define EV_DEFAULT_UC ev_default_loop_uc ()
152# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
153# define EV_DEFAULT ev_default_loop (0)
154# define EV_DEFAULT_ EV_DEFAULT,
58#else 155#else
59# define EV_P void 156# define EV_P void
60# define EV_P_ 157# define EV_P_
61# define EV_A 158# define EV_A
62# define EV_A_ 159# define EV_A_
160# define EV_DEFAULT
161# define EV_DEFAULT_
162# define EV_DEFAULT_UC
163# define EV_DEFAULT_UC_
164# undef EV_EMBED_ENABLE
63#endif 165#endif
166
167#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
168# define EV_INLINE static inline
169#else
170# define EV_INLINE static
171#endif
172
173/*****************************************************************************/
64 174
65/* eventmask, revents, events... */ 175/* eventmask, revents, events... */
66#define EV_UNDEF -1 /* guaranteed to be invalid */ 176#define EV_UNDEF -1 /* guaranteed to be invalid */
67#define EV_NONE 0x00 177#define EV_NONE 0x00 /* no events */
68#define EV_READ 0x01 178#define EV_READ 0x01 /* ev_io detected read will not block */
69#define EV_WRITE 0x02 179#define EV_WRITE 0x02 /* ev_io detected write will not block */
70#define EV_TIMEOUT 0x000100 180#define EV__IOFDSET 0x80 /* internal use only */
71#define EV_PERIODIC 0x000200 181#define EV_IO EV_READ /* alias for type-detection */
72#define EV_SIGNAL 0x000400 182#define EV_TIMEOUT 0x00000100 /* timer timed out */
73#define EV_IDLE 0x000800 183#define EV_TIMER EV_TIMEOUT /* alias for type-detection */
74#define EV_CHECK 0x001000 184#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
75#define EV_PREPARE 0x002000 185#define EV_SIGNAL 0x00000400 /* signal was received */
76#define EV_CHILD 0x004000 186#define EV_CHILD 0x00000800 /* child/pid had status change */
187#define EV_STAT 0x00001000 /* stat data changed */
188#define EV_IDLE 0x00002000 /* event loop is idling */
189#define EV_PREPARE 0x00004000 /* event loop about to poll */
190#define EV_CHECK 0x00008000 /* event loop finished poll */
191#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
192#define EV_FORK 0x00020000 /* event loop resumed in child */
193#define EV_ASYNC 0x00040000 /* async intra-loop signal */
194#define EV_CUSTOM 0x01000000 /* for use by user code */
77#define EV_ERROR 0x800000 /* sent when an error occurs */ 195#define EV_ERROR 0x80000000 /* sent when an error occurs */
78 196
79/* can be used to add custom fields to all watchers */ 197/* can be used to add custom fields to all watchers, while losing binary compatibility */
80#ifndef EV_COMMON 198#ifndef EV_COMMON
81# define EV_COMMON void *data 199# define EV_COMMON void *data;
82#endif 200#endif
83#ifndef EV_PROTOTYPES 201#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1 202# define EV_PROTOTYPES 1
85#endif 203#endif
86 204
87#define EV_VERSION_MAJOR 1 205#define EV_VERSION_MAJOR 3
88#define EV_VERSION_MINOR 1 206#define EV_VERSION_MINOR 9
207
208#ifndef EV_CB_DECLARE
209# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
210#endif
211#ifndef EV_CB_INVOKE
212# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
213#endif
89 214
90/* 215/*
91 * struct member types: 216 * struct member types:
92 * private: you can look at them, but not change them, and they might not mean anything to you. 217 * private: you may look at them, but not change them,
218 * and they might not mean anything to you.
93 * ro: can be read anytime, but only changed when the watcher isn't active 219 * ro: can be read anytime, but only changed when the watcher isn't active.
94 * rw: can be read and modified anytime, even when the watcher is active 220 * rw: can be read and modified anytime, even when the watcher is active.
221 *
222 * some internal details that might be helpful for debugging:
223 *
224 * active is either 0, which means the watcher is not active,
225 * or the array index of the watcher (periodics, timers)
226 * or the array index + 1 (most other watchers)
227 * or simply 1 for watchers that aren't in some array.
228 * pending is either 0, in which case the watcher isn't,
229 * or the array index + 1 in the pendings array.
95 */ 230 */
231
232#if EV_MINPRI == EV_MAXPRI
233# define EV_DECL_PRIORITY
234#else
235# define EV_DECL_PRIORITY int priority;
236#endif
96 237
97/* shared by all watchers */ 238/* shared by all watchers */
98#define EV_WATCHER(type) \ 239#define EV_WATCHER(type) \
99 int active; /* private */ \ 240 int active; /* private */ \
100 int pending; /* private */ \ 241 int pending; /* private */ \
101 int priority; /* private */ \ 242 EV_DECL_PRIORITY /* private */ \
102 EV_COMMON; /* rw */ \ 243 EV_COMMON /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */ 244 EV_CB_DECLARE (type) /* private */
104 245
105#define EV_WATCHER_LIST(type) \ 246#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 247 EV_WATCHER (type) \
107 struct ev_watcher_list *next /* private */ 248 struct ev_watcher_list *next; /* private */
108 249
109#define EV_WATCHER_TIME(type) \ 250#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \ 251 EV_WATCHER (type) \
111 ev_tstamp at /* private */ 252 ev_tstamp at; /* private */
112 253
113/* base class, nothing to see here unless you subclass */ 254/* base class, nothing to see here unless you subclass */
114struct ev_watcher { 255typedef struct ev_watcher
256{
115 EV_WATCHER (ev_watcher); 257 EV_WATCHER (ev_watcher)
116}; 258} ev_watcher;
117 259
118/* base class, nothing to see here unless you subclass */ 260/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list { 261typedef struct ev_watcher_list
262{
120 EV_WATCHER_LIST (ev_watcher_list); 263 EV_WATCHER_LIST (ev_watcher_list)
121}; 264} ev_watcher_list;
122 265
123/* base class, nothing to see here unless you subclass */ 266/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time { 267typedef struct ev_watcher_time
268{
125 EV_WATCHER_TIME (ev_watcher_time); 269 EV_WATCHER_TIME (ev_watcher_time)
126}; 270} ev_watcher_time;
271
272/* invoked when fd is either EV_READable or EV_WRITEable */
273/* revent EV_READ, EV_WRITE */
274typedef struct ev_io
275{
276 EV_WATCHER_LIST (ev_io)
277
278 int fd; /* ro */
279 int events; /* ro */
280} ev_io;
127 281
128/* invoked after a specific time, repeatable (based on monotonic clock) */ 282/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */ 283/* revent EV_TIMEOUT */
130struct ev_timer 284typedef struct ev_timer
131{ 285{
132 EV_WATCHER_TIME (ev_timer); 286 EV_WATCHER_TIME (ev_timer)
133 287
134 ev_tstamp repeat; /* rw */ 288 ev_tstamp repeat; /* rw */
135}; 289} ev_timer;
136 290
137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 291/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */ 292/* revent EV_PERIODIC */
139struct ev_periodic 293typedef struct ev_periodic
140{ 294{
141 EV_WATCHER_TIME (ev_periodic); 295 EV_WATCHER_TIME (ev_periodic)
142 296
297 ev_tstamp offset; /* rw */
143 ev_tstamp interval; /* rw */ 298 ev_tstamp interval; /* rw */
144 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 299 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
145}; 300} ev_periodic;
146
147/* invoked when fd is either EV_READable or EV_WRITEable */
148/* revent EV_READ, EV_WRITE */
149struct ev_io
150{
151 EV_WATCHER_LIST (ev_io);
152
153 int fd; /* ro */
154 int events; /* ro */
155};
156 301
157/* invoked when the given signal has been received */ 302/* invoked when the given signal has been received */
158/* revent EV_SIGNAL */ 303/* revent EV_SIGNAL */
159struct ev_signal 304typedef struct ev_signal
160{ 305{
161 EV_WATCHER_LIST (ev_signal); 306 EV_WATCHER_LIST (ev_signal)
162 307
163 int signum; /* ro */ 308 int signum; /* ro */
164}; 309} ev_signal;
165 310
311/* invoked when sigchld is received and waitpid indicates the given pid */
312/* revent EV_CHILD */
313/* does not support priorities */
314typedef struct ev_child
315{
316 EV_WATCHER_LIST (ev_child)
317
318 int flags; /* private */
319 int pid; /* ro */
320 int rpid; /* rw, holds the received pid */
321 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
322} ev_child;
323
324#if EV_STAT_ENABLE
325/* st_nlink = 0 means missing file or other error */
326# ifdef _WIN32
327typedef struct _stati64 ev_statdata;
328# else
329typedef struct stat ev_statdata;
330# endif
331
332/* invoked each time the stat data changes for a given path */
333/* revent EV_STAT */
334typedef struct ev_stat
335{
336 EV_WATCHER_LIST (ev_stat)
337
338 ev_timer timer; /* private */
339 ev_tstamp interval; /* ro */
340 const char *path; /* ro */
341 ev_statdata prev; /* ro */
342 ev_statdata attr; /* ro */
343
344 int wd; /* wd for inotify, fd for kqueue */
345} ev_stat;
346#endif
347
348#if EV_IDLE_ENABLE
166/* invoked when the nothing else needs to be done, keeps the process from blocking */ 349/* invoked when the nothing else needs to be done, keeps the process from blocking */
167/* revent EV_IDLE */ 350/* revent EV_IDLE */
168struct ev_idle 351typedef struct ev_idle
169{ 352{
170 EV_WATCHER (ev_idle); 353 EV_WATCHER (ev_idle)
171}; 354} ev_idle;
355#endif
172 356
173/* invoked for each run of the mainloop, just before the blocking call */ 357/* invoked for each run of the mainloop, just before the blocking call */
174/* you can still change events in any way you like */ 358/* you can still change events in any way you like */
175/* revent EV_PREPARE */ 359/* revent EV_PREPARE */
176struct ev_prepare 360typedef struct ev_prepare
177{ 361{
178 EV_WATCHER (ev_prepare); 362 EV_WATCHER (ev_prepare)
179}; 363} ev_prepare;
180 364
181/* invoked for each run of the mainloop, just after the blocking call */ 365/* invoked for each run of the mainloop, just after the blocking call */
182/* revent EV_CHECK */ 366/* revent EV_CHECK */
183struct ev_check 367typedef struct ev_check
184{ 368{
185 EV_WATCHER (ev_check); 369 EV_WATCHER (ev_check)
186}; 370} ev_check;
187 371
188/* invoked when sigchld is received and waitpid indicates the givne pid */ 372#if EV_FORK_ENABLE
373/* the callback gets invoked before check in the child process when a fork was detected */
374typedef struct ev_fork
375{
376 EV_WATCHER (ev_fork)
377} ev_fork;
378#endif
379
380#if EV_EMBED_ENABLE
381/* used to embed an event loop inside another */
382/* the callback gets invoked when the event loop has handled events, and can be 0 */
383typedef struct ev_embed
384{
385 EV_WATCHER (ev_embed)
386
387 struct ev_loop *other; /* ro */
388 ev_io io; /* private */
389 ev_prepare prepare; /* private */
390 ev_check check; /* unused */
391 ev_timer timer; /* unused */
392 ev_periodic periodic; /* unused */
393 ev_idle idle; /* unused */
394 ev_fork fork; /* private */
395} ev_embed;
396#endif
397
398#if EV_ASYNC_ENABLE
399/* invoked when somebody calls ev_async_send on the watcher */
189/* revent EV_CHILD */ 400/* revent EV_ASYNC */
190/* does not support priorities */ 401typedef struct ev_async
191struct ev_child
192{ 402{
193 EV_WATCHER_LIST (ev_child); 403 EV_WATCHER (ev_async)
194 404
195 int pid; /* ro */ 405 EV_ATOMIC_T sent; /* private */
196 int rpid; /* rw, holds the received pid */ 406} ev_async;
197 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 407
198}; 408# define ev_async_pending(w) (+(w)->sent)
409#endif
199 410
200/* the presence of this union forces similar struct layout */ 411/* the presence of this union forces similar struct layout */
201union ev_any_watcher 412union ev_any_watcher
202{ 413{
203 struct ev_watcher w; 414 struct ev_watcher w;
204 struct ev_watcher_list wl; 415 struct ev_watcher_list wl;
416
205 struct ev_io io; 417 struct ev_io io;
206 struct ev_timer timer; 418 struct ev_timer timer;
207 struct ev_periodic periodic; 419 struct ev_periodic periodic;
208 struct ev_signal signal; 420 struct ev_signal signal;
421 struct ev_child child;
422#if EV_STAT_ENABLE
423 struct ev_stat stat;
424#endif
425#if EV_IDLE_ENABLE
209 struct ev_idle idle; 426 struct ev_idle idle;
210 struct ev_child child; 427#endif
211 struct ev_prepare prepare; 428 struct ev_prepare prepare;
212 struct ev_check check; 429 struct ev_check check;
430#if EV_FORK_ENABLE
431 struct ev_fork fork;
432#endif
433#if EV_EMBED_ENABLE
434 struct ev_embed embed;
435#endif
436#if EV_ASYNC_ENABLE
437 struct ev_async async;
438#endif
213}; 439};
214 440
215#define EVMETHOD_AUTO 0 /* consults environment */ 441/* bits for ev_default_loop and ev_loop_new */
216#define EVMETHOD_SELECT 1 442/* the default */
217#define EVMETHOD_POLL 2 443#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
218#define EVMETHOD_EPOLL 4 444/* flag bits */
219#define EVMETHOD_KQUEUE 8 445#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
220#define EVMETHOD_DEVPOLL 16 /* NYI */ 446#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
221#define EVMETHOD_PORT 32 /* NYI */ 447/* debugging/feature disable */
222#define EVMETHOD_WIN32 64 /* NYI */ 448#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
223#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 449#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
450#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
451/* method bits to be ored together */
452#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
453#define EVBACKEND_POLL 0x00000002U /* !win */
454#define EVBACKEND_EPOLL 0x00000004U /* linux */
455#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
456#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
457#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
458#define EVBACKEND_ALL 0x0000003FU
224 459
225#if EV_PROTOTYPES 460#if EV_PROTOTYPES
226int ev_version_major (void); 461int ev_version_major (void);
227int ev_version_minor (void); 462int ev_version_minor (void);
228 463
464unsigned int ev_supported_backends (void);
465unsigned int ev_recommended_backends (void);
466unsigned int ev_embeddable_backends (void);
467
229ev_tstamp ev_time (void); 468ev_tstamp ev_time (void);
469void ev_sleep (ev_tstamp delay); /* sleep for a while */
230 470
231/* Sets the allocation function to use, works like realloc. 471/* Sets the allocation function to use, works like realloc.
232 * It is used to allocate and free memory. 472 * It is used to allocate and free memory.
233 * If it returns zero when memory needs to be allocated, the library might abort 473 * If it returns zero when memory needs to be allocated, the library might abort
234 * or take some potentially destructive action. 474 * or take some potentially destructive action.
… …
240 * retryable syscall error 480 * retryable syscall error
241 * (such as failed select, poll, epoll_wait) 481 * (such as failed select, poll, epoll_wait)
242 */ 482 */
243void ev_set_syserr_cb (void (*cb)(const char *msg)); 483void ev_set_syserr_cb (void (*cb)(const char *msg));
244 484
245# if EV_MULTIPLICITY 485#if EV_MULTIPLICITY
486EV_INLINE struct ev_loop *
487ev_default_loop_uc (void)
488{
489 extern struct ev_loop *ev_default_loop_ptr;
490
491 return ev_default_loop_ptr;
492}
493
246/* the default loop is the only one that handles signals and child watchers */ 494/* the default loop is the only one that handles signals and child watchers */
247/* you can call this as often as you like */ 495/* you can call this as often as you like */
248struct ev_loop *ev_default_loop (int methods); /* returns default loop */ 496EV_INLINE struct ev_loop *
497ev_default_loop (unsigned int flags)
498{
499 struct ev_loop *loop = ev_default_loop_uc ();
500
501 if (!loop)
502 {
503 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
504
505 loop = ev_default_loop_init (flags);
506 }
507
508 return loop;
509}
249 510
250/* create and destroy alternative loops that don't handle signals */ 511/* create and destroy alternative loops that don't handle signals */
251struct ev_loop *ev_loop_new (int methods); 512struct ev_loop *ev_loop_new (unsigned int flags);
252void ev_loop_destroy (EV_P); 513void ev_loop_destroy (EV_P);
253void ev_loop_fork (EV_P); 514void ev_loop_fork (EV_P);
515
516ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
517
254# else 518#else
519
255int ev_default_loop (int methods); /* returns true when successful */ 520int ev_default_loop (unsigned int flags); /* returns true when successful */
521
522EV_INLINE ev_tstamp
523ev_now (void)
524{
525 extern ev_tstamp ev_rt_now;
526
527 return ev_rt_now;
528}
529#endif /* multiplicity */
530
531EV_INLINE int
532ev_is_default_loop (EV_P)
533{
534#if EV_MULTIPLICITY
535 extern struct ev_loop *ev_default_loop_ptr;
536
537 return !!(EV_A == ev_default_loop_ptr);
538#else
539 return 1;
256# endif 540#endif
541}
257 542
258void ev_default_destroy (void); /* destroy the default loop */ 543void ev_default_destroy (void); /* destroy the default loop */
259/* this needs to be called after fork, to duplicate the default loop */ 544/* this needs to be called after fork, to duplicate the default loop */
260/* if you create alternative loops you have to call ev_loop_fork on them */ 545/* if you create alternative loops you have to call ev_loop_fork on them */
261/* you can call it in either the parent or the child */ 546/* you can call it in either the parent or the child */
262/* you can actually call it at any time, anywhere :) */ 547/* you can actually call it at any time, anywhere :) */
263void ev_default_fork (void); 548void ev_default_fork (void);
264 549
265int ev_method (EV_P); 550unsigned int ev_backend (EV_P); /* backend in use by loop */
551
552void ev_now_update (EV_P); /* update event loop time */
553
554#if EV_WALK_ENABLE
555/* walk (almost) all watchers in the loop of a given type, invoking the */
556/* callback on every such watcher. The callback might stop the watcher, */
557/* but do nothing else with the loop */
558void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
266#endif 559#endif
560
561#endif /* prototypes */
267 562
268#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 563#define EVLOOP_NONBLOCK 1 /* do not block/wait */
269#define EVLOOP_ONESHOT 2 /* block *once* only */ 564#define EVLOOP_ONESHOT 2 /* block *once* only */
565#define EVUNLOOP_CANCEL 0 /* undo unloop */
270#define EVUNLOOP_ONCE 1 /* unloop once */ 566#define EVUNLOOP_ONE 1 /* unloop once */
271#define EVUNLOOP_ALL 2 /* unloop all loops */ 567#define EVUNLOOP_ALL 2 /* unloop all loops */
272 568
273#if EV_PROTOTYPES 569#if EV_PROTOTYPES
274void ev_loop (EV_P_ int flags); 570void ev_loop (EV_P_ int flags);
275void 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 */ 571void 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 */
276 572
277ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
278
279/* 573/*
280 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 574 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
281 * keeps one reference. if you have a long-runing watcher you never unregister that 575 * keeps one reference. if you have a long-running watcher you never unregister that
282 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 576 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
283 */ 577 */
284void ev_ref (EV_P); 578void ev_ref (EV_P);
285void ev_unref (EV_P); 579void ev_unref (EV_P);
286 580
581/*
287/* convinience function, wait for a single event, without registering an event watcher */ 582 * convenience function, wait for a single event, without registering an event watcher
288/* if timeout is < 0, do wait indefinitely */ 583 * if timeout is < 0, do wait indefinitely
584 */
289void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 585void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
586
587# if EV_FEATURE_API
588unsigned int ev_loop_count (EV_P); /* number of loop iterations */
589unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
590void ev_loop_verify (EV_P); /* abort if loop data corrupted */
591
592void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
593void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
594
595/* advanced stuff for threading etc. support, see docs */
596void ev_set_userdata (EV_P_ void *data);
597void *ev_userdata (EV_P);
598void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
599void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
600
601unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
602void ev_invoke_pending (EV_P); /* invoke all pending watchers */
603
604/*
605 * stop/start the timer handling.
606 */
607void ev_suspend (EV_P);
608void ev_resume (EV_P);
609#endif
610
290#endif 611#endif
291 612
292/* these may evaluate ev multiple times, and the other arguments at most once */ 613/* these may evaluate ev multiple times, and the other arguments at most once */
293/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 614/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
294#define ev_watcher_init(ev,cb_) do { \ 615#define ev_init(ev,cb_) do { \
295 ((struct ev_watcher *)(void *)(ev))->active = \ 616 ((ev_watcher *)(void *)(ev))->active = \
296 ((struct ev_watcher *)(void *)(ev))->pending = \ 617 ((ev_watcher *)(void *)(ev))->pending = 0; \
297 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 618 ev_set_priority ((ev), 0); \
298 (ev)->cb = (cb_); \ 619 ev_set_cb ((ev), cb_); \
299} while (0) 620} while (0)
300 621
301#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 622#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
302#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 623#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
303#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 624#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
304#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 625#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
626#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
627#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
305#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 628#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
306#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 629#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
307#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 630#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
308#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 631#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
632#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
633#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
309 634
310#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 635#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
311#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 636#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
312#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 637#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
313#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 638#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
639#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
640#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
314#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 641#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
315#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 642#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
316#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 643#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
644#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
645#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
317#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 646#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
318 647
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 648#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
320#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 649#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
321 650
322#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
323#define ev_cb(ev) (ev)->cb /* rw */ 651#define ev_cb(ev) (ev)->cb /* rw */
652
653#if EV_MINPRI == EV_MAXPRI
654# define ev_priority(ev) ((ev), EV_MINPRI)
324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 655# define ev_set_priority(ev,pri) ((ev), (pri))
656#else
657# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
658# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
659#endif
660
661#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
662
663#ifndef ev_set_cb
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 664# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
665#endif
326 666
327/* stopping (enabling, adding) a watcher does nothing if it is already running */ 667/* stopping (enabling, adding) a watcher does nothing if it is already running */
328/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 668/* stopping (disabling, deleting) a watcher does nothing unless its already running */
329#if EV_PROTOTYPES 669#if EV_PROTOTYPES
330 670
331/* feeds an event into a watcher as if the event actually occured */ 671/* feeds an event into a watcher as if the event actually occured */
332/* accepts any ev_watcher type */ 672/* accepts any ev_watcher type */
333void ev_feed_event (EV_P_ void *w, int revents); 673void ev_feed_event (EV_P_ void *w, int revents);
334void ev_feed_fd_event (EV_P_ int fd, int revents); 674void ev_feed_fd_event (EV_P_ int fd, int revents);
675#if EV_SIGNAL_ENABLE
335void ev_feed_signal_event (EV_P_ int signum); 676void ev_feed_signal_event (EV_P_ int signum);
677#endif
678void ev_invoke (EV_P_ void *w, int revents);
679int ev_clear_pending (EV_P_ void *w);
336 680
337void ev_io_start (EV_P_ struct ev_io *w); 681void ev_io_start (EV_P_ ev_io *w);
338void ev_io_stop (EV_P_ struct ev_io *w); 682void ev_io_stop (EV_P_ ev_io *w);
339 683
340void ev_timer_start (EV_P_ struct ev_timer *w); 684void ev_timer_start (EV_P_ ev_timer *w);
341void ev_timer_stop (EV_P_ struct ev_timer *w); 685void ev_timer_stop (EV_P_ ev_timer *w);
342/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 686/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
343void ev_timer_again (EV_P_ struct ev_timer *w); 687void ev_timer_again (EV_P_ ev_timer *w);
688/* return remaining time */
689ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
344 690
691#if EV_PERIODIC_ENABLE
345void ev_periodic_start (EV_P_ struct ev_periodic *w); 692void ev_periodic_start (EV_P_ ev_periodic *w);
346void ev_periodic_stop (EV_P_ struct ev_periodic *w); 693void ev_periodic_stop (EV_P_ ev_periodic *w);
347void ev_periodic_again (EV_P_ struct ev_periodic *w); 694void ev_periodic_again (EV_P_ ev_periodic *w);
348 695#endif
349void ev_idle_start (EV_P_ struct ev_idle *w);
350void ev_idle_stop (EV_P_ struct ev_idle *w);
351
352void ev_prepare_start (EV_P_ struct ev_prepare *w);
353void ev_prepare_stop (EV_P_ struct ev_prepare *w);
354
355void ev_check_start (EV_P_ struct ev_check *w);
356void ev_check_stop (EV_P_ struct ev_check *w);
357 696
358/* only supported in the default loop */ 697/* only supported in the default loop */
698#if EV_SIGNAL_ENABLE
359void ev_signal_start (EV_P_ struct ev_signal *w); 699void ev_signal_start (EV_P_ ev_signal *w);
360void ev_signal_stop (EV_P_ struct ev_signal *w); 700void ev_signal_stop (EV_P_ ev_signal *w);
701#endif
361 702
362/* only supported in the default loop */ 703/* only supported in the default loop */
704# if EV_CHILD_ENABLE
363void ev_child_start (EV_P_ struct ev_child *w); 705void ev_child_start (EV_P_ ev_child *w);
364void ev_child_stop (EV_P_ struct ev_child *w); 706void ev_child_stop (EV_P_ ev_child *w);
707# endif
708
709# if EV_STAT_ENABLE
710void ev_stat_start (EV_P_ ev_stat *w);
711void ev_stat_stop (EV_P_ ev_stat *w);
712void ev_stat_stat (EV_P_ ev_stat *w);
713# endif
714
715# if EV_IDLE_ENABLE
716void ev_idle_start (EV_P_ ev_idle *w);
717void ev_idle_stop (EV_P_ ev_idle *w);
718# endif
719
720#if EV_PREPARE_ENABLE
721void ev_prepare_start (EV_P_ ev_prepare *w);
722void ev_prepare_stop (EV_P_ ev_prepare *w);
723#endif
724
725#if EV_CHECK_ENABLE
726void ev_check_start (EV_P_ ev_check *w);
727void ev_check_stop (EV_P_ ev_check *w);
728#endif
729
730# if EV_FORK_ENABLE
731void ev_fork_start (EV_P_ ev_fork *w);
732void ev_fork_stop (EV_P_ ev_fork *w);
733# endif
734
735# if EV_EMBED_ENABLE
736/* only supported when loop to be embedded is in fact embeddable */
737void ev_embed_start (EV_P_ ev_embed *w);
738void ev_embed_stop (EV_P_ ev_embed *w);
739void ev_embed_sweep (EV_P_ ev_embed *w);
740# endif
741
742# if EV_ASYNC_ENABLE
743void ev_async_start (EV_P_ ev_async *w);
744void ev_async_stop (EV_P_ ev_async *w);
745void ev_async_send (EV_P_ ev_async *w);
746# endif
747
365#endif 748#endif
366 749
367#ifdef __cplusplus 750#ifdef __cplusplus
368} 751}
369#endif 752#endif

Diff Legend

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