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.90 by root, Tue Dec 25 07:05:45 2007 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007 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_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1
79#endif
80
81/*****************************************************************************/
82
83#if EV_STAT_ENABLE
84# include <sys/stat.h>
49#endif 85#endif
50 86
51/* support multiple event loops? */ 87/* support multiple event loops? */
52#if EV_MULTIPLICITY 88#if EV_MULTIPLICITY
53struct ev_loop; 89struct ev_loop;
54# define EV_P struct ev_loop *loop 90# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P, 91# define EV_P_ EV_P,
56# define EV_A loop 92# define EV_A loop
57# define EV_A_ EV_A, 93# define EV_A_ EV_A,
94# define EV_DEFAULT ev_default_loop (0)
95# define EV_DEFAULT_ EV_DEFAULT,
58#else 96#else
59# define EV_P void 97# define EV_P void
60# define EV_P_ 98# define EV_P_
61# define EV_A 99# define EV_A
62# define EV_A_ 100# define EV_A_
101# define EV_DEFAULT
102# define EV_DEFAULT_
103
104# undef EV_EMBED_ENABLE
63#endif 105#endif
64 106
65/* eventmask, revents, events... */ 107/* eventmask, revents, events... */
66#define EV_UNDEF -1 /* guaranteed to be invalid */ 108#define EV_UNDEF -1L /* guaranteed to be invalid */
67#define EV_NONE 0x00 109#define EV_NONE 0x00L /* no events */
68#define EV_READ 0x01 110#define EV_READ 0x01L /* ev_io detected read will not block */
69#define EV_WRITE 0x02 111#define EV_WRITE 0x02L /* ev_io detected write will not block */
70#define EV_TIMEOUT 0x000100 112#define EV_IOFDSET 0x80L /* internal use only */
71#define EV_PERIODIC 0x000200 113#define EV_TIMEOUT 0x00000100L /* timer timed out */
72#define EV_SIGNAL 0x000400 114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
73#define EV_IDLE 0x000800 115#define EV_SIGNAL 0x00000400L /* signal was received */
74#define EV_CHECK 0x001000 116#define EV_CHILD 0x00000800L /* child/pid had status change */
75#define EV_PREPARE 0x002000 117#define EV_STAT 0x00001000L /* stat data changed */
76#define EV_CHILD 0x004000 118#define EV_IDLE 0x00002000L /* event loop is idling */
119#define EV_PREPARE 0x00004000L /* event loop about to poll */
120#define EV_CHECK 0x00008000L /* event loop finished poll */
121#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */
122#define EV_FORK 0x00020000L /* event loop resumed in child */
77#define EV_ERROR 0x800000 /* sent when an error occurs */ 123#define EV_ERROR 0x80000000L /* sent when an error occurs */
78 124
79/* can be used to add custom fields to all watchers */ 125/* can be used to add custom fields to all watchers, while losing binary compatibility */
80#ifndef EV_COMMON 126#ifndef EV_COMMON
81# define EV_COMMON void *data 127# define EV_COMMON void *data;
82#endif 128#endif
83#ifndef EV_PROTOTYPES 129#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1 130# define EV_PROTOTYPES 1
85#endif 131#endif
86 132
87#define EV_VERSION_MAJOR 1 133#define EV_VERSION_MAJOR 2
88#define EV_VERSION_MINOR 1 134#define EV_VERSION_MINOR 0
135
136#ifndef EV_CB_DECLARE
137# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
138#endif
139#ifndef EV_CB_INVOKE
140# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
141#endif
89 142
90/* 143/*
91 * struct member types: 144 * struct member types:
92 * private: you can look at them, but not change them, and they might not mean anything to you. 145 * private: you can look at them, but not change them, and they might not mean anything to you.
93 * ro: can be read anytime, but only changed when the watcher isn't active 146 * ro: can be read anytime, but only changed when the watcher isn't active
96 149
97/* shared by all watchers */ 150/* shared by all watchers */
98#define EV_WATCHER(type) \ 151#define EV_WATCHER(type) \
99 int active; /* private */ \ 152 int active; /* private */ \
100 int pending; /* private */ \ 153 int pending; /* private */ \
101 int priority; /* ro */ \ 154 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 155 EV_COMMON /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 156 EV_CB_DECLARE (type) /* private */
104 157
105#define EV_WATCHER_LIST(type) \ 158#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 159 EV_WATCHER (type) \
107 struct ev_watcher_list *next /* private */ 160 struct ev_watcher_list *next; /* private */
108 161
109#define EV_WATCHER_TIME(type) \ 162#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \ 163 EV_WATCHER (type) \
111 ev_tstamp at /* private */ 164 ev_tstamp at; /* private */
112 165
113/* base class, nothing to see here unless you subclass */ 166/* base class, nothing to see here unless you subclass */
114struct ev_watcher { 167typedef struct ev_watcher
168{
115 EV_WATCHER (ev_watcher); 169 EV_WATCHER (ev_watcher)
116}; 170} ev_watcher;
117 171
118/* base class, nothing to see here unless you subclass */ 172/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list { 173typedef struct ev_watcher_list
174{
120 EV_WATCHER_LIST (ev_watcher_list); 175 EV_WATCHER_LIST (ev_watcher_list)
121}; 176} ev_watcher_list;
122 177
123/* base class, nothing to see here unless you subclass */ 178/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time { 179typedef struct ev_watcher_time
180{
125 EV_WATCHER_TIME (ev_watcher_time); 181 EV_WATCHER_TIME (ev_watcher_time)
126}; 182} ev_watcher_time;
183
184/* invoked when fd is either EV_READable or EV_WRITEable */
185/* revent EV_READ, EV_WRITE */
186typedef struct ev_io
187{
188 EV_WATCHER_LIST (ev_io)
189
190 int fd; /* ro */
191 int events; /* ro */
192} ev_io;
127 193
128/* invoked after a specific time, repeatable (based on monotonic clock) */ 194/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */ 195/* revent EV_TIMEOUT */
130struct ev_timer 196typedef struct ev_timer
131{ 197{
132 EV_WATCHER_TIME (ev_timer); 198 EV_WATCHER_TIME (ev_timer)
133 199
134 ev_tstamp repeat; /* rw */ 200 ev_tstamp repeat; /* rw */
135}; 201} ev_timer;
136 202
137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 203/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */ 204/* revent EV_PERIODIC */
139struct ev_periodic 205typedef struct ev_periodic
140{ 206{
141 EV_WATCHER_TIME (ev_periodic); 207 EV_WATCHER_TIME (ev_periodic)
142 208
209 ev_tstamp offset; /* rw */
143 ev_tstamp interval; /* rw */ 210 ev_tstamp interval; /* rw */
144}; 211 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
145 212} 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 213
156/* invoked when the given signal has been received */ 214/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */ 215/* revent EV_SIGNAL */
158struct ev_signal 216typedef struct ev_signal
159{ 217{
160 EV_WATCHER_LIST (ev_signal); 218 EV_WATCHER_LIST (ev_signal)
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
164 219
165 int signum; /* ro */ 220 int signum; /* ro */
166}; 221} ev_signal;
167 222
223/* invoked when sigchld is received and waitpid indicates the given pid */
224/* revent EV_CHILD */
225/* does not support priorities */
226typedef struct ev_child
227{
228 EV_WATCHER_LIST (ev_child)
229
230 int pid; /* ro */
231 int rpid; /* rw, holds the received pid */
232 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
233} ev_child;
234
235#if EV_STAT_ENABLE
236/* st_nlink = 0 means missing file or other error */
237# ifdef _WIN32
238typedef struct _stati64 ev_statdata;
239# else
240typedef struct stat ev_statdata;
241# endif
242
243/* invoked each time the stat data changes for a given path */
244/* revent EV_STAT */
245typedef struct ev_stat
246{
247 EV_WATCHER_LIST (ev_stat)
248
249 ev_timer timer; /* private */
250 ev_tstamp interval; /* ro */
251 const char *path; /* ro */
252 ev_statdata prev; /* ro */
253 ev_statdata attr; /* ro */
254
255 int wd; /* wd for inotify, fd for kqueue */
256} ev_stat;
257#endif
258
259#if EV_IDLE_ENABLE
168/* invoked when the nothing else needs to be done, keeps the process from blocking */ 260/* invoked when the nothing else needs to be done, keeps the process from blocking */
169/* revent EV_IDLE */ 261/* revent EV_IDLE */
170struct ev_idle 262typedef struct ev_idle
171{ 263{
172 EV_WATCHER (ev_idle); 264 EV_WATCHER (ev_idle)
173}; 265} ev_idle;
266#endif
174 267
175/* invoked for each run of the mainloop, just before the blocking call */ 268/* invoked for each run of the mainloop, just before the blocking call */
176/* you can still change events in any way you like */ 269/* you can still change events in any way you like */
177/* revent EV_PREPARE */ 270/* revent EV_PREPARE */
178struct ev_prepare 271typedef struct ev_prepare
179{ 272{
180 EV_WATCHER (ev_prepare); 273 EV_WATCHER (ev_prepare)
181}; 274} ev_prepare;
182 275
183/* invoked for each run of the mainloop, just after the blocking call */ 276/* invoked for each run of the mainloop, just after the blocking call */
184/* revent EV_CHECK */ 277/* revent EV_CHECK */
185struct ev_check 278typedef struct ev_check
186{ 279{
187 EV_WATCHER (ev_check); 280 EV_WATCHER (ev_check)
281} ev_check;
282
283#if EV_FORK_ENABLE
284/* the callback gets invoked before check in the child process when a fork was detected */
285typedef struct ev_fork
286{
287 EV_WATCHER (ev_fork)
288} ev_fork;
289#endif
290
291#if EV_EMBED_ENABLE
292/* used to embed an event loop inside another */
293/* the callback gets invoked when the event loop has handled events, and can be 0 */
294typedef struct ev_embed
295{
296 EV_WATCHER (ev_embed)
297
298 struct ev_loop *other; /* ro */
299 ev_io io; /* private */
300 ev_prepare prepare; /* private */
301 ev_check check; /* unused */
302 ev_timer timer; /* unused */
303 ev_periodic periodic; /* unused */
304 ev_idle idle; /* unused */
305 ev_fork fork; /* unused */
306} ev_embed;
307#endif
308
309/* the presence of this union forces similar struct layout */
310union ev_any_watcher
311{
312 struct ev_watcher w;
313 struct ev_watcher_list wl;
314
315 struct ev_io io;
316 struct ev_timer timer;
317 struct ev_periodic periodic;
318 struct ev_signal signal;
319 struct ev_child child;
320#if EV_STAT_ENABLE
321 struct ev_stat stat;
322#endif
323#if EV_IDLE_ENABLE
324 struct ev_idle idle;
325#endif
326 struct ev_prepare prepare;
327 struct ev_check check;
328#if EV_FORK_ENABLE
329 struct ev_fork fork;
330#endif
331#if EV_EMBED_ENABLE
332 struct ev_embed embed;
333#endif
188}; 334};
189 335
190/* invoked when sigchld is received and waitpid indicates the givne pid */ 336/* bits for ev_default_loop and ev_loop_new */
191/* revent EV_CHILD */ 337/* the default */
192/* does not support priorities */ 338#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
193struct ev_child 339/* flag bits */
194{ 340#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
195 EV_WATCHER_LIST (ev_child); 341#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */
196 342/* method bits to be ored together */
197 int pid; /* ro */ 343#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
198 int rpid; /* rw, holds the received pid */ 344#define EVBACKEND_POLL 0x00000002UL /* !win */
199 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 345#define EVBACKEND_EPOLL 0x00000004UL /* linux */
200}; 346#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
201 347#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
202#define EVMETHOD_AUTO 0 /* consults environment */ 348#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
203#define EVMETHOD_SELECT 1
204#define EVMETHOD_POLL 2
205#define EVMETHOD_EPOLL 4
206#define EVMETHOD_KQUEUE 8
207#define EVMETHOD_DEVPOLL 16 /* NYI */
208#define EVMETHOD_PORT 32 /* NYI */
209#define EVMETHOD_ANY ~0 /* any method, do not consult env */
210 349
211#if EV_PROTOTYPES 350#if EV_PROTOTYPES
212int ev_version_major (void); 351int ev_version_major (void);
213int ev_version_minor (void); 352int ev_version_minor (void);
214 353
215/* these three calls are suitable for plugging into pthread_atfork */ 354unsigned int ev_supported_backends (void);
216void ev_fork_prepare (void); 355unsigned int ev_recommended_backends (void);
217void ev_fork_parent (void); 356unsigned int ev_embeddable_backends (void);
218void ev_fork_child (void);
219 357
220ev_tstamp ev_time (void); 358ev_tstamp ev_time (void);
359void ev_sleep (ev_tstamp delay); /* sleep for a while */
360
361/* Sets the allocation function to use, works like realloc.
362 * It is used to allocate and free memory.
363 * If it returns zero when memory needs to be allocated, the library might abort
364 * or take some potentially destructive action.
365 * The default is your system realloc function.
366 */
367void ev_set_allocator (void *(*cb)(void *ptr, long size));
368
369/* set the callback function to call on a
370 * retryable syscall error
371 * (such as failed select, poll, epoll_wait)
372 */
373void ev_set_syserr_cb (void (*cb)(const char *msg));
221 374
222# if EV_MULTIPLICITY 375# if EV_MULTIPLICITY
376/* the default loop is the only one that handles signals and child watchers */
377/* you can call this as often as you like */
378static struct ev_loop *
379ev_default_loop (unsigned int flags)
380{
381 extern struct ev_loop *ev_default_loop_ptr;
382 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
383
384 if (!ev_default_loop_ptr)
385 ev_default_loop_init (flags);
386
387 return ev_default_loop_ptr;
388}
389
390/* create and destroy alternative loops that don't handle signals */
223struct ev_loop *ev_loop_new (int methods); 391struct ev_loop *ev_loop_new (unsigned int flags);
224void ev_loop_delete (EV_P); 392void ev_loop_destroy (EV_P);
393void ev_loop_fork (EV_P);
394
395ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
396
225# else 397# else
226int ev_init (int methods); /* returns ev_method */ 398
399int ev_default_loop (unsigned int flags); /* returns true when successful */
400
401static ev_tstamp
402ev_now (void)
403{
404 extern ev_tstamp ev_rt_now;
405
406 return ev_rt_now;
407}
227# endif 408# endif
228 409
229int ev_method (EV_P); 410void ev_default_destroy (void); /* destroy the default loop */
411/* this needs to be called after fork, to duplicate the default loop */
412/* if you create alternative loops you have to call ev_loop_fork on them */
413/* you can call it in either the parent or the child */
414/* you can actually call it at any time, anywhere :) */
415void ev_default_fork (void);
230 416
417unsigned int ev_backend (EV_P); /* backend in use by loop */
418unsigned int ev_loop_count (EV_P); /* number of loop iterations */
231#endif 419#endif
232 420
233#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 421#define EVLOOP_NONBLOCK 1 /* do not block/wait */
234#define EVLOOP_ONESHOT 2 /* block *once* only */ 422#define EVLOOP_ONESHOT 2 /* block *once* only */
423#define EVUNLOOP_CANCEL 0 /* undo unloop */
235#define EVUNLOOP_ONCE 1 /* unloop once */ 424#define EVUNLOOP_ONE 1 /* unloop once */
236#define EVUNLOOP_ALL 2 /* unloop all loops */ 425#define EVUNLOOP_ALL 2 /* unloop all loops */
237 426
238#if EV_PROTOTYPES 427#if EV_PROTOTYPES
239void ev_loop (EV_P_ int flags); 428void 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 */ 429void 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 430
242ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 431void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
432void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
243 433
244/* 434/*
245 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 435 * 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 436 * keeps one reference. if you have a long-runing watcher you never unregister that
247 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 437 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
253/* if timeout is < 0, do wait indefinitely */ 443/* if timeout is < 0, do wait indefinitely */
254void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 444void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
255#endif 445#endif
256 446
257/* these may evaluate ev multiple times, and the other arguments at most once */ 447/* 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 */ 448/* 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) 449#define ev_init(ev,cb_) do { \
450 ((ev_watcher *)(void *)(ev))->active = \
451 ((ev_watcher *)(void *)(ev))->pending = \
452 ((ev_watcher *)(void *)(ev))->priority = 0; \
453 ev_set_cb ((ev), cb_); \
454} while (0)
260 455
261#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 456#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) 457#define ev_timer_set(ev,after_,repeat_) do { (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) 458#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
264#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 459#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
460#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
461#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 */ 462#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 */ 463#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 */ 464#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) 465#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
466#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
269 467
270#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 468#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) 469#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) 470#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
273#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 471#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
274#define ev_idle_init(ev,cb) do { ev_watcher_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)
276#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_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) 472#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
473#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
474#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
475#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
476#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
477#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
478#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
278 479
480#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 */ 481#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
482
483#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
484#define ev_cb(ev) (ev)->cb /* rw */
280#define ev_set_priority(ev,pri) (ev)->priority = pri 485#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
486
487#ifndef ev_set_cb
488# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
489#endif
281 490
282/* stopping (enabling, adding) a watcher does nothing if it is already running */ 491/* stopping (enabling, adding) a watcher does nothing if it is already running */
283/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 492/* stopping (disabling, deleting) a watcher does nothing unless its already running */
284#if EV_PROTOTYPES 493#if EV_PROTOTYPES
494
495/* feeds an event into a watcher as if the event actually occured */
496/* accepts any ev_watcher type */
497void ev_feed_event (EV_P_ void *w, int revents);
498void ev_feed_fd_event (EV_P_ int fd, int revents);
499void ev_feed_signal_event (EV_P_ int signum);
500void ev_invoke (EV_P_ void *w, int revents);
501int ev_clear_pending (EV_P_ void *w);
502
285void ev_io_start (EV_P_ struct ev_io *w); 503void ev_io_start (EV_P_ ev_io *w);
286void ev_io_stop (EV_P_ struct ev_io *w); 504void ev_io_stop (EV_P_ ev_io *w);
287 505
288void ev_timer_start (EV_P_ struct ev_timer *w); 506void ev_timer_start (EV_P_ ev_timer *w);
289void ev_timer_stop (EV_P_ struct ev_timer *w); 507void 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 */ 508/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
509void ev_timer_again (EV_P_ ev_timer *w);
291 510
511#if EV_PERIODIC_ENABLE
292void ev_periodic_start (EV_P_ struct ev_periodic *w); 512void ev_periodic_start (EV_P_ ev_periodic *w);
293void ev_periodic_stop (EV_P_ struct ev_periodic *w); 513void ev_periodic_stop (EV_P_ ev_periodic *w);
514void ev_periodic_again (EV_P_ ev_periodic *w);
515#endif
294 516
517/* only supported in the default loop */
295void ev_signal_start (EV_P_ struct ev_signal *w); 518void ev_signal_start (EV_P_ ev_signal *w);
296void ev_signal_stop (EV_P_ struct ev_signal *w); 519void ev_signal_stop (EV_P_ ev_signal *w);
297 520
521/* only supported in the default loop */
522void ev_child_start (EV_P_ ev_child *w);
523void ev_child_stop (EV_P_ ev_child *w);
524
525# if EV_STAT_ENABLE
526void ev_stat_start (EV_P_ ev_stat *w);
527void ev_stat_stop (EV_P_ ev_stat *w);
528void ev_stat_stat (EV_P_ ev_stat *w);
529# endif
530
531# if EV_IDLE_ENABLE
298void ev_idle_start (EV_P_ struct ev_idle *w); 532void ev_idle_start (EV_P_ ev_idle *w);
299void ev_idle_stop (EV_P_ struct ev_idle *w); 533void ev_idle_stop (EV_P_ ev_idle *w);
534# endif
300 535
301void ev_prepare_start (EV_P_ struct ev_prepare *w); 536void ev_prepare_start (EV_P_ ev_prepare *w);
302void ev_prepare_stop (EV_P_ struct ev_prepare *w); 537void ev_prepare_stop (EV_P_ ev_prepare *w);
303 538
304void ev_check_start (EV_P_ struct ev_check *w); 539void ev_check_start (EV_P_ ev_check *w);
305void ev_check_stop (EV_P_ struct ev_check *w); 540void ev_check_stop (EV_P_ ev_check *w);
306 541
542# if EV_FORK_ENABLE
543void ev_fork_start (EV_P_ ev_fork *w);
544void ev_fork_stop (EV_P_ ev_fork *w);
545# endif
546
547# if EV_EMBED_ENABLE
548/* only supported when loop to be embedded is in fact embeddable */
307void ev_child_start (EV_P_ struct ev_child *w); 549void ev_embed_start (EV_P_ ev_embed *w);
308void ev_child_stop (EV_P_ struct ev_child *w); 550void ev_embed_stop (EV_P_ ev_embed *w);
551void ev_embed_sweep (EV_P_ ev_embed *w);
552# endif
553
309#endif 554#endif
310 555
311#ifdef __cplusplus 556#ifdef __cplusplus
312} 557}
313#endif 558#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines