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

Comparing libev/ev.h (file contents):
Revision 1.14 by root, Wed Oct 31 20:46:44 2007 UTC vs.
Revision 1.102 by root, Thu May 22 02:44:57 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines