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_
28 #define _EVENT2_EVENT_COMPAT_H_
29 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #include <event2/event-config.h>
50 #ifdef _EVENT_HAVE_SYS_TYPES_H
51 #include <sys/types.h>
52 #endif
53 #ifdef _EVENT_HAVE_SYS_TIME_H
54 #include <sys/time.h>
55 #endif
56 
57 /* For int types. */
58 #include <event2/util.h>
59 
73 struct event_base *event_init(void);
74 
86 int event_dispatch(void);
87 
99 int event_loop(int);
100 
101 
114 int event_loopexit(const struct timeval *);
115 
116 
129 int event_loopbreak(void);
130 
140 int event_once(evutil_socket_t , short,
141  void (*)(evutil_socket_t, short, void *), void *, const struct timeval *);
142 
143 
153 const char *event_get_method(void);
154 
155 
165 int event_priority_init(int);
166 
174 void event_set(struct event *, evutil_socket_t, short, void (*)(evutil_socket_t, short, void *), void *);
175 
176 #define evtimer_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg))
177 #define evsignal_set(ev, x, cb, arg) \
178  event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
179 
180 
188 #define timeout_add(ev, tv) event_add((ev), (tv))
189 #define timeout_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg))
190 #define timeout_del(ev) event_del(ev)
191 #define timeout_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv))
192 #define timeout_initialized(ev) event_initialized(ev)
193 
202 #define signal_add(ev, tv) event_add((ev), (tv))
203 #define signal_set(ev, x, cb, arg) \
204  event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
205 #define signal_del(ev) event_del(ev)
206 #define signal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv))
207 #define signal_initialized(ev) event_initialized(ev)
208 
210 #ifndef EVENT_FD
211 /* These macros are obsolete; use event_get_fd and event_get_signal instead. */
212 #define EVENT_FD(ev) ((int)event_get_fd(ev))
213 #define EVENT_SIGNAL(ev) event_get_signal(ev)
214 #endif
215 
216 #ifdef __cplusplus
217 }
218 #endif
219 
220 #endif /* _EVENT2_EVENT_COMPAT_H_ */
int event_priority_init(int)
Set the number of different event priorities.
int event_loopbreak(void)
Abort the active event_loop() immediately.
Structure to represent a single event.
Definition: event.h:272
void event_set(struct event *, evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *)
Prepare an event structure to be added.
int event_loop(int)
Handle events.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:274
struct event_base * event_init(void)
Initialize the event API.
const char * event_get_method(void)
Get the kernel event notification mechanism used by Libevent.
Common convenience functions for cross-platform portability and related socket manipulations.
int event_loopexit(const struct timeval *)
Exit the event loop after the specified time.
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:213
int event_dispatch(void)
Loop to process events.