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

Comparing libev/ev.h (file contents):
Revision 1.6 by root, Wed Oct 31 09:23:18 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)
15 46
16/* can be used to add custom fields to all watchers */ 47/* can be used to add custom fields to all watchers */
17#ifndef EV_COMMON 48#ifndef EV_COMMON
18# define EV_COMMON void *data 49# define EV_COMMON void *data
50#endif
51#ifndef EV_PROTOTYPES
52# define EV_PROTOTYPES 1
19#endif 53#endif
20 54
21/* 55/*
22 * struct member types: 56 * struct member types:
23 * private: you can look at them, but not change them, and they might not mean anything to you. 57 * private: you can look at them, but not change them, and they might not mean anything to you.
… …
38 72
39#define EV_WATCHER_TIME(type) \ 73#define EV_WATCHER_TIME(type) \
40 EV_WATCHER (type); \ 74 EV_WATCHER (type); \
41 ev_tstamp at /* private */ 75 ev_tstamp at /* private */
42 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
43/* invoked after a specific time, repeatable (based on monotonic clock) */ 92/* invoked after a specific time, repeatable (based on monotonic clock) */
44struct ev_timer 93struct ev_timer
45{ 94{
46 EV_WATCHER_TIME (ev_timer); 95 EV_WATCHER_TIME (ev_timer);
47 96
… …
77struct ev_idle 126struct ev_idle
78{ 127{
79 EV_WATCHER (ev_idle); 128 EV_WATCHER (ev_idle);
80}; 129};
81 130
82/* 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 */
83struct ev_check 139struct ev_check
84{ 140{
85 EV_WATCHER (ev_check); 141 EV_WATCHER (ev_check);
86}; 142};
87 143
88#define EVMETHOD_NONE 0 144#define EVMETHOD_NONE 0
89#define EVMETHOD_SELECT 1 145#define EVMETHOD_SELECT 1
90#define EVMETHOD_EPOLL 2 146#define EVMETHOD_EPOLL 2
147#if EV_PROTOTYPES
148extern int ev_method;
91int ev_init (int flags); /* returns ev_method */ 149int ev_init (int flags); /* returns ev_method */
92extern int ev_method;
93 150
94/* these three calls are suitable for plugging into pthread_atfork */ 151/* these three calls are suitable for plugging into pthread_atfork */
95void ev_prefork (void); 152void ev_prefork (void);
96void ev_postfork_parent (void); 153void ev_postfork_parent (void);
97void ev_postfork_child (void); 154void ev_postfork_child (void);
98 155
99extern 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 */
100ev_tstamp ev_time (void); 157ev_tstamp ev_time (void);
158#endif
101 159
102#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 160#define EVLOOP_NONBLOCK 1 /* do not block/wait */
103#define EVLOOP_ONESHOT 2 /* block *once* only */ 161#define EVLOOP_ONESHOT 2 /* block *once* only */
162#if EV_PROTOTYPES
104void ev_loop (int flags); 163void ev_loop (int flags);
105extern 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
106 170
107/* 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 */
108/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 172/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
109#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->cb = (cb_); } while (0) 173#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
110 174
111#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)
112#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 176#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
113#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 177#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
114#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 178#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
115#define evcheck_set(ev) /* nop, yes this is a serious in-joke */
116#define evidle_set(ev) /* nop, yes this is a serious in-joke */ 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 */
117 182
118#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 183#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
119#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 184#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
120#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 185#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
121#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } 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)
122#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 189#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
123#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
124 190
125#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 */
126 192
127/* 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 */
128/* 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
129void evio_start (struct ev_io *w); 196void evio_start (struct ev_io *w);
130void evio_stop (struct ev_io *w); 197void evio_stop (struct ev_io *w);
131 198
132void evtimer_start (struct ev_timer *w); 199void evtimer_start (struct ev_timer *w);
133void 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 */
134 202
135void evperiodic_start (struct ev_periodic *w); 203void evperiodic_start (struct ev_periodic *w);
136void evperiodic_stop (struct ev_periodic *w); 204void evperiodic_stop (struct ev_periodic *w);
137 205
138void evsignal_start (struct ev_signal *w); 206void evsignal_start (struct ev_signal *w);
139void evsignal_stop (struct ev_signal *w); 207void evsignal_stop (struct ev_signal *w);
140 208
141void evidle_start (struct ev_idle *w); 209void evidle_start (struct ev_idle *w);
142void evidle_stop (struct ev_idle *w); 210void evidle_stop (struct ev_idle *w);
143 211
212void evprepare_start (struct ev_prepare *w);
213void evprepare_stop (struct ev_prepare *w);
214
144void evcheck_start (struct ev_check *w); 215void evcheck_start (struct ev_check *w);
145void evcheck_stop (struct ev_check *w); 216void evcheck_stop (struct ev_check *w);
146
147#endif 217#endif
148 218
219#endif
220

Diff Legend

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