event_struct.h revision 290001
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_STRUCT_H_INCLUDED_ 28#define EVENT2_EVENT_STRUCT_H_INCLUDED_ 29 30/** @file event2/event_struct.h 31 32 Structures used by event.h. Using these structures directly WILL harm 33 forward compatibility: be careful. 34 35 No field declared in this file should be used directly in user code. Except 36 for historical reasons, these fields would not be exposed at all. 37 */ 38 39#ifdef __cplusplus 40extern "C" { 41#endif 42 43#include <event2/event-config.h> 44#ifdef EVENT__HAVE_SYS_TYPES_H 45#include <sys/types.h> 46#endif 47#ifdef EVENT__HAVE_SYS_TIME_H 48#include <sys/time.h> 49#endif 50 51/* For int types. */ 52#include <event2/util.h> 53 54/* For evkeyvalq */ 55#include <event2/keyvalq_struct.h> 56 57#define EVLIST_TIMEOUT 0x01 58#define EVLIST_INSERTED 0x02 59#define EVLIST_SIGNAL 0x04 60#define EVLIST_ACTIVE 0x08 61#define EVLIST_INTERNAL 0x10 62#define EVLIST_ACTIVE_LATER 0x20 63#define EVLIST_FINALIZING 0x40 64#define EVLIST_INIT 0x80 65 66#define EVLIST_ALL 0xff 67 68/* Fix so that people don't have to run with <sys/queue.h> */ 69#ifndef TAILQ_ENTRY 70#define EVENT_DEFINED_TQENTRY_ 71#define TAILQ_ENTRY(type) \ 72struct { \ 73 struct type *tqe_next; /* next element */ \ 74 struct type **tqe_prev; /* address of previous next element */ \ 75} 76#endif /* !TAILQ_ENTRY */ 77 78#ifndef TAILQ_HEAD 79#define EVENT_DEFINED_TQHEAD_ 80#define TAILQ_HEAD(name, type) \ 81struct name { \ 82 struct type *tqh_first; \ 83 struct type **tqh_last; \ 84} 85#endif 86 87/* Fix so that people don't have to run with <sys/queue.h> */ 88#ifndef LIST_ENTRY 89#define EVENT_DEFINED_LISTENTRY_ 90#define LIST_ENTRY(type) \ 91struct { \ 92 struct type *le_next; /* next element */ \ 93 struct type **le_prev; /* address of previous next element */ \ 94} 95#endif /* !LIST_ENTRY */ 96 97#ifndef LIST_HEAD 98#define EVENT_DEFINED_LISTHEAD_ 99#define LIST_HEAD(name, type) \ 100struct name { \ 101 struct type *lh_first; /* first element */ \ 102 } 103#endif /* !LIST_HEAD */ 104 105struct event; 106 107struct event_callback { 108 TAILQ_ENTRY(event_callback) evcb_active_next; 109 short evcb_flags; 110 ev_uint8_t evcb_pri; /* smaller numbers are higher priority */ 111 ev_uint8_t evcb_closure; 112 /* allows us to adopt for different types of events */ 113 union { 114 void (*evcb_callback)(evutil_socket_t, short, void *); 115 void (*evcb_selfcb)(struct event_callback *, void *); 116 void (*evcb_evfinalize)(struct event *, void *); 117 void (*evcb_cbfinalize)(struct event_callback *, void *); 118 } evcb_cb_union; 119 void *evcb_arg; 120}; 121 122struct event_base; 123struct event { 124 struct event_callback ev_evcallback; 125 126 /* for managing timeouts */ 127 union { 128 TAILQ_ENTRY(event) ev_next_with_common_timeout; 129 int min_heap_idx; 130 } ev_timeout_pos; 131 evutil_socket_t ev_fd; 132 133 struct event_base *ev_base; 134 135 union { 136 /* used for io events */ 137 struct { 138 LIST_ENTRY (event) ev_io_next; 139 struct timeval ev_timeout; 140 } ev_io; 141 142 /* used by signal events */ 143 struct { 144 LIST_ENTRY (event) ev_signal_next; 145 short ev_ncalls; 146 /* Allows deletes in callback */ 147 short *ev_pncalls; 148 } ev_signal; 149 } ev_; 150 151 short ev_events; 152 short ev_res; /* result passed to event callback */ 153 struct timeval ev_timeout; 154}; 155 156TAILQ_HEAD (event_list, event); 157 158#ifdef EVENT_DEFINED_TQENTRY_ 159#undef TAILQ_ENTRY 160#endif 161 162#ifdef EVENT_DEFINED_TQHEAD_ 163#undef TAILQ_HEAD 164#endif 165 166LIST_HEAD (event_dlist, event); 167 168#ifdef EVENT_DEFINED_LISTENTRY_ 169#undef LIST_ENTRY 170#endif 171 172#ifdef EVENT_DEFINED_LISTHEAD_ 173#undef LIST_HEAD 174#endif 175 176#ifdef __cplusplus 177} 178#endif 179 180#endif /* EVENT2_EVENT_STRUCT_H_INCLUDED_ */ 181