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

Diff Legend

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