libevent
event_compat.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
3  * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 #ifndef EVENT2_EVENT_COMPAT_H_INCLUDED_
28 #define EVENT2_EVENT_COMPAT_H_INCLUDED_
29 
44 #include <event2/visibility.h>
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 #include <event2/event-config.h>
51 #ifdef EVENT__HAVE_SYS_TYPES_H
52 #include <sys/types.h>
53 #endif
54 #ifdef EVENT__HAVE_SYS_TIME_H
55 #include <sys/time.h>
56 #endif
57 
58 /* For int types. */
59 #include <event2/util.h>
60 
74 EVENT2_EXPORT_SYMBOL
75 struct event_base *event_init(void);
76 
88 EVENT2_EXPORT_SYMBOL
89 int event_dispatch(void);
90 
102 EVENT2_EXPORT_SYMBOL
103 int event_loop(int);
104 
105 
118 EVENT2_EXPORT_SYMBOL
119 int event_loopexit(const struct timeval *);
120 
121 
134 EVENT2_EXPORT_SYMBOL
135 int event_loopbreak(void);
136 
146 EVENT2_EXPORT_SYMBOL
147 int event_once(evutil_socket_t , short,
148  void (*)(evutil_socket_t, short, void *), void *, const struct timeval *);
149 
150 
160 EVENT2_EXPORT_SYMBOL
161 const char *event_get_method(void);
162 
163 
173 EVENT2_EXPORT_SYMBOL
174 int event_priority_init(int);
175 
183 EVENT2_EXPORT_SYMBOL
184 void event_set(struct event *, evutil_socket_t, short, void (*)(evutil_socket_t, short, void *), void *);
185 
186 #define evtimer_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg))
187 #define evsignal_set(ev, x, cb, arg) \
188  event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
189 
190 
198 #define timeout_add(ev, tv) event_add((ev), (tv))
199 #define timeout_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg))
200 #define timeout_del(ev) event_del(ev)
201 #define timeout_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv))
202 #define timeout_initialized(ev) event_initialized(ev)
203 
212 #define signal_add(ev, tv) event_add((ev), (tv))
213 #define signal_set(ev, x, cb, arg) \
214  event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
215 #define signal_del(ev) event_del(ev)
216 #define signal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv))
217 #define signal_initialized(ev) event_initialized(ev)
218 
220 #ifndef EVENT_FD
221 /* These macros are obsolete; use event_get_fd and event_get_signal instead. */
222 #define EVENT_FD(ev) ((int)event_get_fd(ev))
223 #define EVENT_SIGNAL(ev) event_get_signal(ev)
224 #endif
225 
226 #ifdef __cplusplus
227 }
228 #endif
229 
230 #endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */
EVENT2_EXPORT_SYMBOL int event_loop(int)
Handle events.
Structure to represent a single event.
Definition: event.h:276
EVENT2_EXPORT_SYMBOL int event_priority_init(int)
Set the number of different event priorities.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
EVENT2_EXPORT_SYMBOL int event_loopexit(const struct timeval *)
Exit the event loop after the specified time.
EVENT2_EXPORT_SYMBOL int event_loopbreak(void)
Abort the active event_loop() immediately.
Common convenience functions for cross-platform portability and related socket manipulations.
EVENT2_EXPORT_SYMBOL const char * event_get_method(void)
Get the kernel event notification mechanism used by Libevent.
EVENT2_EXPORT_SYMBOL struct event_base * event_init(void)
Initialize the event API.
EVENT2_EXPORT_SYMBOL int event_dispatch(void)
Loop to process events.
EVENT2_EXPORT_SYMBOL void event_set(struct event *, evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *)
Prepare an event structure to be added.
EVENT2_EXPORT_SYMBOL int event_once(evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *, const struct timeval *)
Schedule a one-time event to occur.
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:217