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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines