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.10 by root, Wed Oct 31 14:44:15 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_ERROR (0x3f|0x80)
15 45
16/* can be used to add custom fields to all watchers */ 46/* can be used to add custom fields to all watchers */
17#ifndef EV_COMMON 47#ifndef EV_COMMON
18# define EV_COMMON void *data 48# define EV_COMMON void *data
49#endif
50#ifndef EV_PROTOTYPES
51# define EV_PROTOTYPES 1
19#endif 52#endif
20 53
21/* 54/*
22 * struct member types: 55 * struct member types:
23 * private: you can look at them, but not change them, and they might not mean anything to you. 56 * private: you can look at them, but not change them, and they might not mean anything to you.
… …
38 71
39#define EV_WATCHER_TIME(type) \ 72#define EV_WATCHER_TIME(type) \
40 EV_WATCHER (type); \ 73 EV_WATCHER (type); \
41 ev_tstamp at /* private */ 74 ev_tstamp at /* private */
42 75
76/* base class, nothing to see here unless you subclass */
77struct ev_watcher {
78 EV_WATCHER (ev_watcher);
79};
80
81/* base class, nothing to see here unless you subclass */
82struct ev_watcher_list {
83 EV_WATCHER_LIST (ev_watcher_list);
84};
85
86/* base class, nothing to see here unless you subclass */
87struct ev_watcher_time {
88 EV_WATCHER_TIME (ev_watcher_time);
89};
90
43/* invoked after a specific time, repeatable (based on monotonic clock) */ 91/* invoked after a specific time, repeatable (based on monotonic clock) */
44struct ev_timer 92struct ev_timer
45{ 93{
46 EV_WATCHER_TIME (ev_timer); 94 EV_WATCHER_TIME (ev_timer);
47 95
… …
86}; 134};
87 135
88#define EVMETHOD_NONE 0 136#define EVMETHOD_NONE 0
89#define EVMETHOD_SELECT 1 137#define EVMETHOD_SELECT 1
90#define EVMETHOD_EPOLL 2 138#define EVMETHOD_EPOLL 2
139#if EV_PROTOTYPES
140extern int ev_method;
91int ev_init (int flags); /* returns ev_method */ 141int ev_init (int flags); /* returns ev_method */
92extern int ev_method;
93 142
94/* these three calls are suitable for plugging into pthread_atfork */ 143/* these three calls are suitable for plugging into pthread_atfork */
95void ev_prefork (void); 144void ev_prefork (void);
96void ev_postfork_parent (void); 145void ev_postfork_parent (void);
97void ev_postfork_child (void); 146void ev_postfork_child (void);
98 147
99extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 148extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
100ev_tstamp ev_time (void); 149ev_tstamp ev_time (void);
150#endif
101 151
102#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 152#define EVLOOP_NONBLOCK 1 /* do not block/wait */
103#define EVLOOP_ONESHOT 2 /* block *once* only */ 153#define EVLOOP_ONESHOT 2 /* block *once* only */
154#if EV_PROTOTYPES
104void ev_loop (int flags); 155void ev_loop (int flags);
105extern int ev_loop_done; /* set to 1 to break out of event loop */ 156extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
157
158/* convinience function, wait for a single event, without registering an event watcher */
159/* if timeout is < 0, do wait indefinitely */
160void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
161#endif
106 162
107/* these may evaluate ev multiple times, and the other arguments at most once */ 163/* 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 */ 164/* 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) 165#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
110 166
111#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 167#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) 168#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) 169#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) 170#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
115#define evcheck_set(ev) /* nop, yes this is a serious in-joke */ 171#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 */ 172#define evidle_set(ev) /* nop, yes, this is a serious in-joke */
117 173
118#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 174#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) 175#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) 176#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) 177#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
… …
124 180
125#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 181#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
126 182
127/* stopping (enabling, adding) a watcher does nothing if it is already running */ 183/* stopping (enabling, adding) a watcher does nothing if it is already running */
128/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 184/* stopping (disabling, deleting) a watcher does nothing unless its already running */
185#if EV_PROTOTYPES
129void evio_start (struct ev_io *w); 186void evio_start (struct ev_io *w);
130void evio_stop (struct ev_io *w); 187void evio_stop (struct ev_io *w);
131 188
132void evtimer_start (struct ev_timer *w); 189void evtimer_start (struct ev_timer *w);
133void evtimer_stop (struct ev_timer *w); 190void evtimer_stop (struct ev_timer *w);
191void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
134 192
135void evperiodic_start (struct ev_periodic *w); 193void evperiodic_start (struct ev_periodic *w);
136void evperiodic_stop (struct ev_periodic *w); 194void evperiodic_stop (struct ev_periodic *w);
137 195
138void evsignal_start (struct ev_signal *w); 196void evsignal_start (struct ev_signal *w);
… …
141void evidle_start (struct ev_idle *w); 199void evidle_start (struct ev_idle *w);
142void evidle_stop (struct ev_idle *w); 200void evidle_stop (struct ev_idle *w);
143 201
144void evcheck_start (struct ev_check *w); 202void evcheck_start (struct ev_check *w);
145void evcheck_stop (struct ev_check *w); 203void evcheck_stop (struct ev_check *w);
146
147#endif 204#endif
148 205
206#endif
207

Diff Legend

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