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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines