tevent: only provide compat macros if the caller wants them
[ira/wip.git] / lib / tevent / tevent.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    generalised event loop handling
5
6    Copyright (C) Andrew Tridgell 2005
7    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #ifndef __TEVENT_H__
23 #define __TEVENT_H__
24
25 #include <stdint.h>
26 #include <talloc.h>
27
28 struct tevent_context;
29 struct tevent_ops;
30 struct tevent_fd;
31 struct tevent_timer;
32 struct tevent_aio;
33 struct tevent_signal;
34
35 /* event handler types */
36 typedef void (*tevent_fd_handler_t)(struct tevent_context *,
37                                     struct tevent_fd *,
38                                     uint16_t , void *);
39 typedef void (*tevent_timer_handler_t)(struct tevent_context *,
40                                        struct tevent_timer *,
41                                        struct timeval , void *);
42 typedef void (*tevent_signal_handler_t)(struct tevent_context *,
43                                         struct tevent_signal *,
44                                         int , int, void *, void *);
45 typedef void (*tevent_aio_handler_t)(struct tevent_context *,
46                                      struct tevent_aio *,
47                                      int, void *);
48
49 struct tevent_context *tevent_context_init(TALLOC_CTX *mem_ctx);
50 struct tevent_context *tevent_context_init_byname(TALLOC_CTX *mem_ctx, const char *name);
51 const char **tevent_backend_list(TALLOC_CTX *mem_ctx);
52 void tevent_set_default_backend(const char *backend);
53
54 struct tevent_fd *_tevent_add_fd(struct tevent_context *ev,
55                                  TALLOC_CTX *mem_ctx,
56                                  int fd,
57                                  uint16_t flags,
58                                  tevent_fd_handler_t handler,
59                                  void *private_data,
60                                  const char *handler_name,
61                                  const char *location);
62 #define tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
63         _tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data, \
64                        #handler, __location__)
65
66 struct tevent_timer *_tevent_add_timer(struct tevent_context *ev,
67                                        TALLOC_CTX *mem_ctx,
68                                        struct timeval next_event,
69                                        tevent_timer_handler_t handler,
70                                        void *private_data,
71                                        const char *handler_name,
72                                        const char *location);
73 #define tevent_add_timer(ev, mem_ctx, next_event, handler, private_data) \
74         _tevent_add_timer(ev, mem_ctx, next_event, handler, private_data, \
75                           #handler, __location__);
76
77 struct tevent_signal *_tevent_add_signal(struct tevent_context *ev,
78                                          TALLOC_CTX *mem_ctx,
79                                          int signum,
80                                          int sa_flags,
81                                          tevent_signal_handler_t handler,
82                                          void *private_data,
83                                          const char *handler_name,
84                                          const char *location);
85 #define tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
86         _tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data, \
87                            #handler, __location__)
88
89 struct iocb;
90 struct tevent_aio *_tevent_add_aio(struct tevent_context *ev,
91                                    TALLOC_CTX *mem_ctx,
92                                    struct iocb *iocb,
93                                    tevent_aio_handler_t handler,
94                                    void *private_data,
95                                    const char *handler_name,
96                                    const char *location);
97 #define tevent_add_aio(ev, mem_ctx, iocb, handler, private_data) \
98         _tevent_add_aio(ev, mem_ctx, iocb, handler, private_data, \
99                         #handler, __location__);
100
101 int tevent_loop_once(struct tevent_context *ev);
102 int tevent_loop_wait(struct tevent_context *ev);
103
104 uint16_t tevent_fd_get_flags(struct tevent_fd *fde);
105 void tevent_fd_set_flags(struct tevent_fd *fde, uint16_t flags);
106
107 /* bits for file descriptor event flags */
108 #define TEVENT_FD_READ 1
109 #define TEVENT_FD_WRITE 2
110 #define TEVENT_FD_AUTOCLOSE 4
111
112 #define TEVENT_FD_WRITEABLE(fde) \
113         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) | TEVENT_FD_WRITE)
114 #define TEVENT_FD_READABLE(fde) \
115         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) | TEVENT_FD_READ)
116
117 #define TEVENT_FD_NOT_WRITEABLE(fde) \
118         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) & ~TEVENT_FD_WRITE)
119 #define TEVENT_FD_NOT_READABLE(fde) \
120         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) & ~TEVENT_FD_READ)
121
122 /* DEBUG */
123 enum tevent_debug_level {
124         TEVENT_DEBUG_FATAL,
125         TEVENT_DEBUG_ERROR,
126         TEVENT_DEBUG_WARNING,
127         TEVENT_DEBUG_TRACE
128 };
129
130 int tevent_set_debug(struct tevent_context *ev,
131                      void (*debug)(void *context,
132                                    enum tevent_debug_level level,
133                                    const char *fmt,
134                                    va_list ap) PRINTF_ATTRIBUTE(3,0),
135                      void *context);
136 int tevent_set_debug_stderr(struct tevent_context *ev);
137
138 #ifdef TEVENT_COMPAT_DEFINES
139
140 #define event_context   tevent_context
141 #define event_ops       tevent_ops
142 #define fd_event        tevent_fd
143 #define timed_event     tevent_timer
144 #define aio_event       tevent_aio
145 #define signal_event    tevent_signal
146
147 #define event_fd_handler_t      tevent_fd_handler_t
148 #define event_timed_handler_t   tevent_timer_handler_t
149 #define event_aio_handler_t     tevent_aio_handler_t
150 #define event_signal_handler_t  tevent_signal_handler_t
151
152 #define event_context_init(mem_ctx) \
153         tevent_context_init(mem_ctx)
154
155 #define event_context_init_byname(mem_ctx, name) \
156         tevent_context_init_byname(mem_ctx, name)
157
158 #define event_backend_list(mem_ctx) \
159         tevent_backend_list(mem_ctx)
160
161 #define event_set_default_backend(backend) \
162         tevent_set_default_backend(backend)
163
164 #define event_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
165         tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data)
166
167 #define event_add_timed(ev, mem_ctx, next_event, handler, private_data) \
168         tevent_add_timer(ev, mem_ctx, next_event, handler, private_data)
169
170 #define event_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
171         tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data)
172
173 #define event_add_aio(ev, mem_ctx, iocb, handler, private_data) \
174         tevent_add_aio(ev, mem_ctx, iocb, handler, private_data)
175
176 #define event_loop_once(ev) \
177         tevent_loop_once(ev)
178
179 #define event_loop_wait(ev) \
180         tevent_loop_wait(ev)
181
182 #define event_get_fd_flags(fde) \
183         tevent_fd_get_flags(fde)
184
185 #define event_set_fd_flags(fde, flags) \
186         tevent_fd_set_flags(fde, flags)
187
188 #define EVENT_FD_READ           TEVENT_FD_READ
189 #define EVENT_FD_WRITE          TEVENT_FD_WRITE
190 #define EVENT_FD_AUTOCLOSE      TEVENT_FD_AUTOCLOSE
191
192 #define EVENT_FD_WRITEABLE(fde) \
193         TEVENT_FD_WRITEABLE(fde)
194
195 #define EVENT_FD_READABLE(fde) \
196         TEVENT_FD_READABLE(fde)
197
198 #define EVENT_FD_NOT_WRITEABLE(fde) \
199         TEVENT_FD_NOT_WRITEABLE(fde)
200
201 #define EVENT_FD_NOT_READABLE(fde) \
202         TEVENT_FD_NOT_READABLE(fde)
203
204 #define ev_debug_level          tevent_debug_level
205
206 #define EV_DEBUG_FATAL          TEVENT_DEBUG_FATAL
207 #define EV_DEBUG_ERROR          TEVENT_DEBUG_ERROR
208 #define EV_DEBUG_WARNING        TEVENT_DEBUG_WARNING
209 #define EV_DEBUG_TRACE          TEVENT_DEBUG_TRACE
210
211 #define ev_set_debug(ev, debug, context) \
212         tevent_set_debug(ev, debug, context)
213
214 #define ev_set_debug_stderr(_ev) tevent_set_debug_stderr(ev)
215
216 #endif /* TEVENT_COMPAT_DEFINES */
217
218 #endif /* __TEVENT_H__ */