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

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

Diff Legend

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