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

Comparing libev/ev.h (file contents):
Revision 1.7 by root, Wed Oct 31 10:50:05 2007 UTC vs.
Revision 1.38 by root, Tue Nov 6 13:17:55 2007 UTC

1/*
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials provided
15 * with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
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 */
29
1#ifndef EV_H 30#ifndef EV_H
2#define EV_H 31#define EV_H
3 32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
4typedef double ev_tstamp; 37typedef double ev_tstamp;
5 38
39/* these priorities are inclusive, higher priorities will be called earlier */
40#ifndef EV_MINPRI
41# define EV_MINPRI -2
42#endif
43#ifndef EV_MAXPRI
44# define EV_MAXPRI +2
45#endif
46
47#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1
49#endif
50
51/* support multiple event loops? */
52#if EV_MULTIPLICITY
53struct ev_loop;
54# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P,
56# define EV_A loop
57# define EV_A_ EV_A,
58#else
59# define EV_P void
60# define EV_P_
61# define EV_A
62# define EV_A_
63#endif
64
6/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
8#define EV_NONE 0x00 67#define EV_NONE 0x00
9#define EV_READ 0x01 68#define EV_READ 0x01
10#define EV_WRITE 0x02 69#define EV_WRITE 0x02
11#define EV_TIMEOUT 0x04 70#define EV_TIMEOUT 0x000100
71#define EV_PERIODIC 0x000200
12#define EV_SIGNAL 0x08 72#define EV_SIGNAL 0x000400
13#define EV_IDLE 0x10 73#define EV_IDLE 0x000800
14#define EV_CHECK 0x20 74#define EV_CHECK 0x001000
75#define EV_PREPARE 0x002000
76#define EV_CHILD 0x004000
77#define EV_ERROR 0x800000 /* sent when an error occurs */
15 78
16/* can be used to add custom fields to all watchers */ 79/* can be used to add custom fields to all watchers */
17#ifndef EV_COMMON 80#ifndef EV_COMMON
18# define EV_COMMON void *data 81# define EV_COMMON void *data
19#endif 82#endif
83#ifndef EV_PROTOTYPES
84# define EV_PROTOTYPES 1
85#endif
86
87#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1
20 89
21/* 90/*
22 * struct member types: 91 * struct member types:
23 * private: you can look at them, but not change them, and they might not mean anything to you. 92 * private: you can look at them, but not change them, and they might not mean anything to you.
24 * ro: can be read anytime, but only changed when the watcher isn't active 93 * ro: can be read anytime, but only changed when the watcher isn't active
… …
27 96
28/* shared by all watchers */ 97/* shared by all watchers */
29#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
30 int active; /* private */ \ 99 int active; /* private */ \
31 int pending; /* private */ \ 100 int pending; /* private */ \
101 int priority; /* private */ \
32 EV_COMMON; /* rw */ \ 102 EV_COMMON; /* rw */ \
33 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */
34 104
35#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
36 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
37 struct type *next /* private */ 107 struct ev_watcher_list *next /* private */
38 108
39#define EV_WATCHER_TIME(type) \ 109#define EV_WATCHER_TIME(type) \
40 EV_WATCHER (type); \ 110 EV_WATCHER (type); \
41 ev_tstamp at /* private */ 111 ev_tstamp at /* private */
42 112
… …
54struct ev_watcher_time { 124struct ev_watcher_time {
55 EV_WATCHER_TIME (ev_watcher_time); 125 EV_WATCHER_TIME (ev_watcher_time);
56}; 126};
57 127
58/* invoked after a specific time, repeatable (based on monotonic clock) */ 128/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */
59struct ev_timer 130struct ev_timer
60{ 131{
61 EV_WATCHER_TIME (ev_timer); 132 EV_WATCHER_TIME (ev_timer);
62 133
63 ev_tstamp repeat; /* rw */ 134 ev_tstamp repeat; /* rw */
64}; 135};
65 136
66/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */
67struct ev_periodic 139struct ev_periodic
68{ 140{
69 EV_WATCHER_TIME (ev_periodic); 141 EV_WATCHER_TIME (ev_periodic);
70 142
71 ev_tstamp interval; /* rw */ 143 ev_tstamp interval; /* rw */
72}; 144};
73 145
74/* invoked when fd is either EV_READable or EV_WRITEable */ 146/* invoked when fd is either EV_READable or EV_WRITEable */
147/* revent EV_READ, EV_WRITE */
75struct ev_io 148struct ev_io
76{ 149{
77 EV_WATCHER_LIST (ev_io); 150 EV_WATCHER_LIST (ev_io);
78 151
79 int fd; /* ro */ 152 int fd; /* ro */
80 int events; /* ro */ 153 int events; /* ro */
81}; 154};
82 155
83/* invoked when the given signal has been received */ 156/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */
84struct ev_signal 158struct ev_signal
85{ 159{
86 EV_WATCHER_LIST (ev_signal); 160 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
87 164
88 int signum; /* ro */ 165 int signum; /* ro */
89}; 166};
90 167
91/* invoked when the nothing else needs to be done, keeps the process from blocking */ 168/* invoked when the nothing else needs to be done, keeps the process from blocking */
169/* revent EV_IDLE */
92struct ev_idle 170struct ev_idle
93{ 171{
94 EV_WATCHER (ev_idle); 172 EV_WATCHER (ev_idle);
95}; 173};
96 174
97/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 175/* invoked for each run of the mainloop, just before the blocking call */
176/* you can still change events in any way you like */
177/* revent EV_PREPARE */
178struct ev_prepare
179{
180 EV_WATCHER (ev_prepare);
181};
182
183/* invoked for each run of the mainloop, just after the blocking call */
184/* revent EV_CHECK */
98struct ev_check 185struct ev_check
99{ 186{
100 EV_WATCHER (ev_check); 187 EV_WATCHER (ev_check);
101}; 188};
102 189
103#define EVMETHOD_NONE 0 190/* invoked when sigchld is received and waitpid indicates the givne pid */
191/* revent EV_CHILD */
192/* does not support priorities */
193struct ev_child
194{
195 EV_WATCHER_LIST (ev_child);
196
197 int pid; /* ro */
198 int rpid; /* rw, holds the received pid */
199 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
200};
201
202union ev_any_watcher
203{
204 struct ev_watcher w;
205 struct ev_watcher_list wl;
206 struct ev_io io;
207 struct ev_timer timer;
208 struct ev_periodic periodic;
209 struct ev_signal signal;
210 struct ev_idle idle;
211 struct ev_child child;
212 struct ev_prepare prepare;
213 struct ev_check check;
214};
215
216#define EVMETHOD_AUTO 0 /* consults environment */
104#define EVMETHOD_SELECT 1 217#define EVMETHOD_SELECT 1
105#define EVMETHOD_EPOLL 2 218#define EVMETHOD_POLL 2
106int ev_init (int flags); /* returns ev_method */ 219#define EVMETHOD_EPOLL 4
107extern int ev_method; 220#define EVMETHOD_KQUEUE 8
221#define EVMETHOD_DEVPOLL 16 /* NYI */
222#define EVMETHOD_PORT 32 /* NYI */
223#define EVMETHOD_WIN32 64 /* NYI */
224#define EVMETHOD_ANY ~0 /* any method, do not consult env */
108 225
109/* these three calls are suitable for plugging into pthread_atfork */ 226#if EV_PROTOTYPES
110void ev_prefork (void); 227int ev_version_major (void);
111void ev_postfork_parent (void); 228int ev_version_minor (void);
112void ev_postfork_child (void);
113 229
114extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
115ev_tstamp ev_time (void); 230ev_tstamp ev_time (void);
231
232/* Sets the allocation function to use, works like realloc.
233 * It is used to allocate and free memory.
234 * If it returns zero when memory needs to be allocated, the library might abort
235 * or take some potentially destructive action.
236 * The default is your system realloc function.
237 */
238void ev_set_allocator (void *(*cb)(void *ptr, long size));
239
240/* set the callback function to call on a
241 * retryable syscall error
242 * (such as failed select, poll, epoll_wait)
243 */
244void ev_set_syserr_cb (void (*cb)(const char *msg));
245
246# if EV_MULTIPLICITY
247/* the default loop is the only one that handles signals and child watchers */
248/* you can call this as often as you like */
249struct ev_loop *ev_default_loop (int methods); /* returns default loop */
250
251/* create and destroy alternative loops that don't handle signals */
252struct ev_loop *ev_loop_new (int methods);
253void ev_loop_destroy (EV_P);
254void ev_loop_fork (EV_P);
255# else
256int ev_default_loop (int methods); /* returns true when successful */
257# endif
258
259void ev_default_destroy (void); /* destroy the default loop */
260/* this needs to be called after fork, to duplicate the default loop */
261/* if you create alternative loops you have to call ev_loop_fork on them */
262/* you can call it in either the parent or the child */
263/* you can actually call it at any time, anywhere :) */
264void ev_default_fork (void);
265
266int ev_method (EV_P);
267#endif
116 268
117#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 269#define EVLOOP_NONBLOCK 1 /* do not block/wait */
118#define EVLOOP_ONESHOT 2 /* block *once* only */ 270#define EVLOOP_ONESHOT 2 /* block *once* only */
271#define EVUNLOOP_ONCE 1 /* unloop once */
272#define EVUNLOOP_ALL 2 /* unloop all loops */
273
274#if EV_PROTOTYPES
119void ev_loop (int flags); 275void ev_loop (EV_P_ int flags);
120extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 276void 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 */
277
278ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
279
280/*
281 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
282 * keeps one reference. if you have a long-runing watcher you never unregister that
283 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
284 */
285void ev_ref (EV_P);
286void ev_unref (EV_P);
287
288/* convinience function, wait for a single event, without registering an event watcher */
289/* if timeout is < 0, do wait indefinitely */
290void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
291#endif
121 292
122/* these may evaluate ev multiple times, and the other arguments at most once */ 293/* these may evaluate ev multiple times, and the other arguments at most once */
123/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 294/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
124#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->cb = (cb_); } while (0) 295#define ev_watcher_init(ev,cb_) do { \
296 ((struct ev_watcher *)(void *)(ev))->active = \
297 ((struct ev_watcher *)(void *)(ev))->pending = \
298 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
299 (ev)->cb = (cb_); \
300} while (0)
125 301
126#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 302#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
127#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 303#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
128#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 304#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
129#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 305#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
130#define evcheck_set(ev) /* nop, yes this is a serious in-joke */
131#define evidle_set(ev) /* nop, yes this is a serious in-joke */ 306#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
307#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
308#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
309#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
132 310
133#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 311#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
134#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 312#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
135#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 313#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
136#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 314#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
315#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
316#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
137#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 317#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
138#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 318#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
139 319
320#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
140#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 321#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
322
323#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
324#define ev_cb(ev) (ev)->cb /* rw */
325#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
326#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
141 327
142/* stopping (enabling, adding) a watcher does nothing if it is already running */ 328/* stopping (enabling, adding) a watcher does nothing if it is already running */
143/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 329/* stopping (disabling, deleting) a watcher does nothing unless its already running */
330#if EV_PROTOTYPES
144void evio_start (struct ev_io *w); 331void ev_io_start (EV_P_ struct ev_io *w);
145void evio_stop (struct ev_io *w); 332void ev_io_stop (EV_P_ struct ev_io *w);
146 333
147void evtimer_start (struct ev_timer *w); 334void ev_timer_start (EV_P_ struct ev_timer *w);
148void evtimer_stop (struct ev_timer *w); 335void ev_timer_stop (EV_P_ struct ev_timer *w);
336/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
337void ev_timer_again (EV_P_ struct ev_timer *w);
149 338
150void evperiodic_start (struct ev_periodic *w); 339void ev_periodic_start (EV_P_ struct ev_periodic *w);
151void evperiodic_stop (struct ev_periodic *w); 340void ev_periodic_stop (EV_P_ struct ev_periodic *w);
152 341
342void ev_idle_start (EV_P_ struct ev_idle *w);
343void ev_idle_stop (EV_P_ struct ev_idle *w);
344
345void ev_prepare_start (EV_P_ struct ev_prepare *w);
346void ev_prepare_stop (EV_P_ struct ev_prepare *w);
347
348void ev_check_start (EV_P_ struct ev_check *w);
349void ev_check_stop (EV_P_ struct ev_check *w);
350
351/* only supported in the default loop */
153void evsignal_start (struct ev_signal *w); 352void ev_signal_start (EV_P_ struct ev_signal *w);
154void evsignal_stop (struct ev_signal *w); 353void ev_signal_stop (EV_P_ struct ev_signal *w);
155 354
355/* only supported in the default loop */
156void evidle_start (struct ev_idle *w); 356void ev_child_start (EV_P_ struct ev_child *w);
157void evidle_stop (struct ev_idle *w); 357void ev_child_stop (EV_P_ struct ev_child *w);
158
159void evcheck_start (struct ev_check *w);
160void evcheck_stop (struct ev_check *w);
161
162#endif 358#endif
163 359
360#ifdef __cplusplus
361}
362#endif
363
364#endif
365

Diff Legend

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