tevent: add tevent_fd_set_auto_close()
[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 *ev,
37                                     struct tevent_fd *fde,
38                                     uint16_t flags,
39                                     void *private_data);
40 typedef void (*tevent_fd_close_fn_t)(struct tevent_context *ev,
41                                      struct tevent_fd *fde,
42                                      int fd,
43                                      void *private_data);
44 typedef void (*tevent_timer_handler_t)(struct tevent_context *ev,
45                                        struct tevent_timer *te,
46                                        struct timeval current_time,
47                                        void *private_data);
48 typedef void (*tevent_signal_handler_t)(struct tevent_context *ev,
49                                         struct tevent_signal *se,
50                                         int signum,
51                                         int count,
52                                         void *siginfo,
53                                         void *private_data);
54 typedef void (*tevent_aio_handler_t)(struct tevent_context *ev,
55                                      struct tevent_aio *ae,
56                                      int ret,
57                                      void *private_data);
58
59 struct tevent_context *tevent_context_init(TALLOC_CTX *mem_ctx);
60 struct tevent_context *tevent_context_init_byname(TALLOC_CTX *mem_ctx, const char *name);
61 const char **tevent_backend_list(TALLOC_CTX *mem_ctx);
62 void tevent_set_default_backend(const char *backend);
63
64 struct tevent_fd *_tevent_add_fd(struct tevent_context *ev,
65                                  TALLOC_CTX *mem_ctx,
66                                  int fd,
67                                  uint16_t flags,
68                                  tevent_fd_handler_t handler,
69                                  void *private_data,
70                                  const char *handler_name,
71                                  const char *location);
72 #define tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
73         _tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data, \
74                        #handler, __location__)
75
76 struct tevent_timer *_tevent_add_timer(struct tevent_context *ev,
77                                        TALLOC_CTX *mem_ctx,
78                                        struct timeval next_event,
79                                        tevent_timer_handler_t handler,
80                                        void *private_data,
81                                        const char *handler_name,
82                                        const char *location);
83 #define tevent_add_timer(ev, mem_ctx, next_event, handler, private_data) \
84         _tevent_add_timer(ev, mem_ctx, next_event, handler, private_data, \
85                           #handler, __location__);
86
87 struct tevent_signal *_tevent_add_signal(struct tevent_context *ev,
88                                          TALLOC_CTX *mem_ctx,
89                                          int signum,
90                                          int sa_flags,
91                                          tevent_signal_handler_t handler,
92                                          void *private_data,
93                                          const char *handler_name,
94                                          const char *location);
95 #define tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
96         _tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data, \
97                            #handler, __location__)
98
99 struct iocb;
100 struct tevent_aio *_tevent_add_aio(struct tevent_context *ev,
101                                    TALLOC_CTX *mem_ctx,
102                                    struct iocb *iocb,
103                                    tevent_aio_handler_t handler,
104                                    void *private_data,
105                                    const char *handler_name,
106                                    const char *location);
107 #define tevent_add_aio(ev, mem_ctx, iocb, handler, private_data) \
108         _tevent_add_aio(ev, mem_ctx, iocb, handler, private_data, \
109                         #handler, __location__);
110
111 int tevent_loop_once(struct tevent_context *ev);
112 int tevent_loop_wait(struct tevent_context *ev);
113
114 void tevent_fd_set_close_fn(struct tevent_fd *fde,
115                             tevent_fd_close_fn_t close_fn);
116 void tevent_fd_set_auto_close(struct tevent_fd *fde);
117 uint16_t tevent_fd_get_flags(struct tevent_fd *fde);
118 void tevent_fd_set_flags(struct tevent_fd *fde, uint16_t flags);
119
120 /* bits for file descriptor event flags */
121 #define TEVENT_FD_READ 1
122 #define TEVENT_FD_WRITE 2
123 #define TEVENT_FD_AUTOCLOSE 4
124
125 #define TEVENT_FD_WRITEABLE(fde) \
126         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) | TEVENT_FD_WRITE)
127 #define TEVENT_FD_READABLE(fde) \
128         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) | TEVENT_FD_READ)
129
130 #define TEVENT_FD_NOT_WRITEABLE(fde) \
131         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) & ~TEVENT_FD_WRITE)
132 #define TEVENT_FD_NOT_READABLE(fde) \
133         tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) & ~TEVENT_FD_READ)
134
135 /* DEBUG */
136 enum tevent_debug_level {
137         TEVENT_DEBUG_FATAL,
138         TEVENT_DEBUG_ERROR,
139         TEVENT_DEBUG_WARNING,
140         TEVENT_DEBUG_TRACE
141 };
142
143 int tevent_set_debug(struct tevent_context *ev,
144                      void (*debug)(void *context,
145                                    enum tevent_debug_level level,
146                                    const char *fmt,
147                                    va_list ap) PRINTF_ATTRIBUTE(3,0),
148                      void *context);
149 int tevent_set_debug_stderr(struct tevent_context *ev);
150
151 #ifdef TEVENT_COMPAT_DEFINES
152
153 #define event_context   tevent_context
154 #define event_ops       tevent_ops
155 #define fd_event        tevent_fd
156 #define timed_event     tevent_timer
157 #define aio_event       tevent_aio
158 #define signal_event    tevent_signal
159
160 #define event_fd_handler_t      tevent_fd_handler_t
161 #define event_timed_handler_t   tevent_timer_handler_t
162 #define event_aio_handler_t     tevent_aio_handler_t
163 #define event_signal_handler_t  tevent_signal_handler_t
164
165 #define event_context_init(mem_ctx) \
166         tevent_context_init(mem_ctx)
167
168 #define event_context_init_byname(mem_ctx, name) \
169         tevent_context_init_byname(mem_ctx, name)
170
171 #define event_backend_list(mem_ctx) \
172         tevent_backend_list(mem_ctx)
173
174 #define event_set_default_backend(backend) \
175         tevent_set_default_backend(backend)
176
177 #define event_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
178         tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data)
179
180 #define event_add_timed(ev, mem_ctx, next_event, handler, private_data) \
181         tevent_add_timer(ev, mem_ctx, next_event, handler, private_data)
182
183 #define event_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
184         tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data)
185
186 #define event_add_aio(ev, mem_ctx, iocb, handler, private_data) \
187         tevent_add_aio(ev, mem_ctx, iocb, handler, private_data)
188
189 #define event_loop_once(ev) \
190         tevent_loop_once(ev)
191
192 #define event_loop_wait(ev) \
193         tevent_loop_wait(ev)
194
195 #define event_get_fd_flags(fde) \
196         tevent_fd_get_flags(fde)
197
198 #define event_set_fd_flags(fde, flags) \
199         tevent_fd_set_flags(fde, flags)
200
201 #define EVENT_FD_READ           TEVENT_FD_READ
202 #define EVENT_FD_WRITE          TEVENT_FD_WRITE
203 #define EVENT_FD_AUTOCLOSE      TEVENT_FD_AUTOCLOSE
204
205 #define EVENT_FD_WRITEABLE(fde) \
206         TEVENT_FD_WRITEABLE(fde)
207
208 #define EVENT_FD_READABLE(fde) \
209         TEVENT_FD_READABLE(fde)
210
211 #define EVENT_FD_NOT_WRITEABLE(fde) \
212         TEVENT_FD_NOT_WRITEABLE(fde)
213
214 #define EVENT_FD_NOT_READABLE(fde) \
215         TEVENT_FD_NOT_READABLE(fde)
216
217 #define ev_debug_level          tevent_debug_level
218
219 #define EV_DEBUG_FATAL          TEVENT_DEBUG_FATAL
220 #define EV_DEBUG_ERROR          TEVENT_DEBUG_ERROR
221 #define EV_DEBUG_WARNING        TEVENT_DEBUG_WARNING
222 #define EV_DEBUG_TRACE          TEVENT_DEBUG_TRACE
223
224 #define ev_set_debug(ev, debug, context) \
225         tevent_set_debug(ev, debug, context)
226
227 #define ev_set_debug_stderr(_ev) tevent_set_debug_stderr(ev)
228
229 #endif /* TEVENT_COMPAT_DEFINES */
230
231 #endif /* __TEVENT_H__ */