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

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

Diff Legend

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