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_ 28 #define _EVENT2_EVENT_STRUCT_H_ 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 40 extern "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_INIT 0x80 63 64 /* EVLIST_X_ Private space: 0x1000-0xf000 */ 65 #define EVLIST_ALL (0xf000 | 0x9f) 66 67 /* Fix so that people don't have to run with <sys/queue.h> */ 68 #ifndef TAILQ_ENTRY 69 #define _EVENT_DEFINED_TQENTRY 70 #define TAILQ_ENTRY(type) \ 71 struct { \ 72 struct type *tqe_next; /* next element */ \ 73 struct type **tqe_prev; /* address of previous next element */ \ 74 } 75 #endif /* !TAILQ_ENTRY */ 76 77 #ifndef TAILQ_HEAD 78 #define _EVENT_DEFINED_TQHEAD 79 #define TAILQ_HEAD(name, type) \ 80 struct name { \ 81 struct type *tqh_first; \ 82 struct type **tqh_last; \ 83 } 84 #endif 85 86 struct event_base; 87 struct event { 88 TAILQ_ENTRY(event) ev_active_next; 89 TAILQ_ENTRY(event) ev_next; 90 /* for managing timeouts */ 91 union { 92 TAILQ_ENTRY(event) ev_next_with_common_timeout; 93 int min_heap_idx; 94 } ev_timeout_pos; 95 evutil_socket_t ev_fd; 96 97 struct event_base *ev_base; 98 99 union { 100 /* used for io events */ 101 struct { 102 TAILQ_ENTRY(event) ev_io_next; 103 struct timeval ev_timeout; 104 } ev_io; 105 106 /* used by signal events */ 107 struct { 108 TAILQ_ENTRY(event) ev_signal_next; 109 short ev_ncalls; 110 /* Allows deletes in callback */ 111 short *ev_pncalls; 112 } ev_signal; 113 } _ev; 114 115 short ev_events; 116 short ev_res; /* result passed to event callback */ 117 short ev_flags; 118 ev_uint8_t ev_pri; /* smaller numbers are higher priority */ 119 ev_uint8_t ev_closure; 120 struct timeval ev_timeout; 121 122 /* allows us to adopt for different types of events */ 123 void (*ev_callback)(evutil_socket_t, short, void *arg); 124 void *ev_arg; 125 }; 126 127 TAILQ_HEAD (event_list, event); 128 129 #ifdef _EVENT_DEFINED_TQENTRY 130 #undef TAILQ_ENTRY 131 #endif 132 133 #ifdef _EVENT_DEFINED_TQHEAD 134 #undef TAILQ_HEAD 135 #endif 136 137 #ifdef __cplusplus 138 } 139 #endif 140 141 #endif /* _EVENT2_EVENT_STRUCT_H_ */ 142