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

Comparing libev/ev.h (file contents):
Revision 1.2 by root, Tue Oct 30 21:42:13 2007 UTC vs.
Revision 1.13 by root, Wed Oct 31 20:10:17 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
4typedef double ev_tstamp; 33typedef double ev_tstamp;
5 34
6/* eventmask, revents, events... */ 35/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 36#define EV_UNDEF -1 /* guaranteed to be invalid */
8#define EV_NONE 0 37#define EV_NONE 0x00
9#define EV_READ 1 38#define EV_READ 0x01
10#define EV_WRITE 2 39#define EV_WRITE 0x02
11#define EV_TIMEOUT 4 40#define EV_TIMEOUT 0x04
12#define EV_SIGNAL 8 41#define EV_SIGNAL 0x08
42#define EV_IDLE 0x10
43#define EV_CHECK 0x20
44#define EV_PREPARE 0x40
45#define EV_CHILD 0x80
46#define EV_ERROR (0xff|0x8000)
47
48/* can be used to add custom fields to all watchers */
49#ifndef EV_COMMON
50# define EV_COMMON void *data
51#endif
52#ifndef EV_PROTOTYPES
53# define EV_PROTOTYPES 1
54#endif
55
56/*
57 * struct member types:
58 * private: you can look at them, but not change them, and they might not mean anything to you.
59 * ro: can be read anytime, but only changed when the watcher isn't active
60 * rw: can be read and modified anytime, even when the watcher is active
61 */
13 62
14/* shared by all watchers */ 63/* shared by all watchers */
15#define EV_WATCHER(type) \ 64#define EV_WATCHER(type) \
16 int active; /* private */ \ 65 int active; /* private */ \
17 int pending; /* private */ \ 66 int pending; /* private */ \
18 void *data; /* rw */ \ 67 EV_COMMON; /* rw */ \
19 void (*cb)(struct type *, int revents) /* rw */ 68 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
20 69
21#define EV_WATCHER_LIST(type) \ 70#define EV_WATCHER_LIST(type) \
22 EV_WATCHER (type); \ 71 EV_WATCHER (type); \
23 struct type *next /* private */ 72 struct type *next /* private */
24 73
74#define EV_WATCHER_TIME(type) \
75 EV_WATCHER (type); \
76 ev_tstamp at /* private */
77
78/* base class, nothing to see here unless you subclass */
79struct ev_watcher {
80 EV_WATCHER (ev_watcher);
81};
82
83/* base class, nothing to see here unless you subclass */
84struct ev_watcher_list {
85 EV_WATCHER_LIST (ev_watcher_list);
86};
87
88/* base class, nothing to see here unless you subclass */
89struct ev_watcher_time {
90 EV_WATCHER_TIME (ev_watcher_time);
91};
92
93/* invoked after a specific time, repeatable (based on monotonic clock) */
25struct ev_timer 94struct ev_timer
26{ 95{
27 EV_WATCHER_LIST (ev_timer); 96 EV_WATCHER_TIME (ev_timer);
28 97
29 ev_tstamp at; /* ro */
30 ev_tstamp repeat; /* rw */ 98 ev_tstamp repeat; /* rw */
31 unsigned char is_abs; /* rw */
32}; 99};
33 100
101/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
102struct ev_periodic
103{
104 EV_WATCHER_TIME (ev_periodic);
105
106 ev_tstamp interval; /* rw */
107};
108
109/* invoked when fd is either EV_READable or EV_WRITEable */
34struct ev_io 110struct ev_io
35{ 111{
36 EV_WATCHER_LIST (ev_io); 112 EV_WATCHER_LIST (ev_io);
37 113
38 int fd; /* ro */ 114 int fd; /* ro */
39 int events; /* ro */ 115 int events; /* ro */
40}; 116};
41 117
118/* invoked when the given signal has been received */
42struct ev_signal 119struct ev_signal
43{ 120{
44 EV_WATCHER_LIST (ev_signal); 121 EV_WATCHER_LIST (ev_signal);
45 122
46 int signum; /* ro */ 123 int signum; /* ro */
124};
125
126/* invoked when the nothing else needs to be done, keeps the process from blocking */
127struct ev_idle
128{
129 EV_WATCHER (ev_idle);
130};
131
132/* invoked for each run of the mainloop, just before the blocking call */
133/* you can still change events in any way you like */
134struct ev_prepare
135{
136 EV_WATCHER (ev_prepare);
137};
138
139/* invoked for each run of the mainloop, just after the blocking call */
140struct ev_check
141{
142 EV_WATCHER (ev_check);
143};
144
145/* invoked when sigchld is received and waitpid indicates the givne pid */
146struct ev_child
147{
148 EV_WATCHER_LIST (ev_child);
149
150 int pid; /* ro */
151 int status; /* rw, holds the exit status, use the macros from sys/wait.h */
47}; 152};
48 153
49#define EVMETHOD_NONE 0 154#define EVMETHOD_NONE 0
50#define EVMETHOD_SELECT 1 155#define EVMETHOD_SELECT 1
51#define EVMETHOD_EPOLL 2 156#define EVMETHOD_EPOLL 2
52int ev_init (int flags); 157#if EV_PROTOTYPES
53extern int ev_method; 158extern int ev_method;
159int ev_init (int flags); /* returns ev_method */
54 160
161/* these three calls are suitable for plugging into pthread_atfork */
55void ev_prefork (void); 162void ev_prefork (void);
56void ev_postfork_parent (void); 163void ev_postfork_parent (void);
57void ev_postfork_child (void); 164void ev_postfork_child (void);
58 165
59extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 166extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
60ev_tstamp ev_time (void); 167ev_tstamp ev_time (void);
168#endif
61 169
62#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 170#define EVLOOP_NONBLOCK 1 /* do not block/wait */
63#define EVLOOP_ONESHOT 2 /* block *once* only */ 171#define EVLOOP_ONESHOT 2 /* block *once* only */
172#if EV_PROTOTYPES
64int ev_loop (int flags); 173void ev_loop (int flags);
65extern int ev_loop_done; /* set to 1 to break out of event loop */ 174extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
175
176/* convinience function, wait for a single event, without registering an event watcher */
177/* if timeout is < 0, do wait indefinitely */
178void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
179#endif
66 180
67/* these may evaluate ev multiple times, and the other arguments at most once */ 181/* these may evaluate ev multiple times, and the other arguments at most once */
182/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
68#define evw_init(ev,cb_,data_) do { (ev)->active = 0; (ev)->cb = (cb_); (ev)->data = (void *)data_; } while (0) 183#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
184
69#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 185#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
70#define evtimer_set_rel(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); (ev)->is_abs = 0; } while (0) 186#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
71#define evtimer_set_abs(ev,at_,repeat_) do { (ev)->at = (at_); (ev)->repeat = (repeat_); (ev)->is_abs = 1; } while (0) 187#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
72#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 188#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
189#define evidle_set(ev) /* nop, yes, this is a serious in-joke */
190#define evprepare_set(ev) /* nop, yes, this is a serious in-joke */
191#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
192#define evchild_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
193
194#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
195#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
196#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
197#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
198#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
199#define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
200#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
201#define evchild_init(ev,cb,pid) do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0)
73 202
74#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 203#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
75 204
205/* stopping (enabling, adding) a watcher does nothing if it is already running */
206/* stopping (disabling, deleting) a watcher does nothing unless its already running */
207#if EV_PROTOTYPES
76void evio_start (struct ev_io *w); 208void evio_start (struct ev_io *w);
77void evio_stop (struct ev_io *w); 209void evio_stop (struct ev_io *w);
78 210
79void evtimer_start (struct ev_timer *w); 211void evtimer_start (struct ev_timer *w);
80void evtimer_stop (struct ev_timer *w); 212void evtimer_stop (struct ev_timer *w);
213void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
81 214
215void evperiodic_start (struct ev_periodic *w);
216void evperiodic_stop (struct ev_periodic *w);
217
82void evsignal_start (struct ev_signal *w); 218void evsignal_start (struct ev_signal *w);
83void evsignal_stop (struct ev_signal *w); 219void evsignal_stop (struct ev_signal *w);
84 220
85#endif 221void evidle_start (struct ev_idle *w);
222void evidle_stop (struct ev_idle *w);
86 223
224void evprepare_start (struct ev_prepare *w);
225void evprepare_stop (struct ev_prepare *w);
226
227void evcheck_start (struct ev_check *w);
228void evcheck_stop (struct ev_check *w);
229
230void evchild_start (struct ev_child *w);
231void evchild_stop (struct ev_child *w);
232#endif
233
234#endif
235

Diff Legend

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