2 Unix SMB/CIFS implementation.
4 generalised event loop handling
6 Copyright (C) Andrew Tridgell 2005
7 Copyright (C) Stefan Metzmacher 2005-2009
8 Copyright (C) Volker Lendecke 2008
10 ** NOTE! The following LGPL license applies to the tevent
11 ** library. This does NOT imply that all of Samba is released
14 This library is free software; you can redistribute it and/or
15 modify it under the terms of the GNU Lesser General Public
16 License as published by the Free Software Foundation; either
17 version 3 of the License, or (at your option) any later version.
19 This library is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public
25 License along with this library; if not, see <http://www.gnu.org/licenses/>.
36 struct tevent_context
;
40 struct tevent_immediate
;
43 /* event handler types */
44 typedef void (*tevent_fd_handler_t
)(struct tevent_context
*ev
,
45 struct tevent_fd
*fde
,
48 typedef void (*tevent_fd_close_fn_t
)(struct tevent_context
*ev
,
49 struct tevent_fd
*fde
,
52 typedef void (*tevent_timer_handler_t
)(struct tevent_context
*ev
,
53 struct tevent_timer
*te
,
54 struct timeval current_time
,
56 typedef void (*tevent_immediate_handler_t
)(struct tevent_context
*ctx
,
57 struct tevent_immediate
*im
,
59 typedef void (*tevent_signal_handler_t
)(struct tevent_context
*ev
,
60 struct tevent_signal
*se
,
66 struct tevent_context
*tevent_context_init(TALLOC_CTX
*mem_ctx
);
67 struct tevent_context
*tevent_context_init_byname(TALLOC_CTX
*mem_ctx
, const char *name
);
68 const char **tevent_backend_list(TALLOC_CTX
*mem_ctx
);
69 void tevent_set_default_backend(const char *backend
);
71 struct tevent_fd
*_tevent_add_fd(struct tevent_context
*ev
,
75 tevent_fd_handler_t handler
,
77 const char *handler_name
,
78 const char *location
);
79 #define tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
80 _tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data, \
81 #handler, __location__)
83 struct tevent_timer
*_tevent_add_timer(struct tevent_context
*ev
,
85 struct timeval next_event
,
86 tevent_timer_handler_t handler
,
88 const char *handler_name
,
89 const char *location
);
90 #define tevent_add_timer(ev, mem_ctx, next_event, handler, private_data) \
91 _tevent_add_timer(ev, mem_ctx, next_event, handler, private_data, \
92 #handler, __location__)
94 struct tevent_immediate
*_tevent_create_immediate(TALLOC_CTX
*mem_ctx
,
95 const char *location
);
96 #define tevent_create_immediate(mem_ctx) \
97 _tevent_create_immediate(mem_ctx, __location__)
99 void _tevent_schedule_immediate(struct tevent_immediate
*im
,
100 struct tevent_context
*ctx
,
101 tevent_immediate_handler_t handler
,
103 const char *handler_name
,
104 const char *location
);
105 #define tevent_schedule_immediate(im, ctx, handler, private_data) \
106 _tevent_schedule_immediate(im, ctx, handler, private_data, \
107 #handler, __location__);
109 struct tevent_signal
*_tevent_add_signal(struct tevent_context
*ev
,
113 tevent_signal_handler_t handler
,
115 const char *handler_name
,
116 const char *location
);
117 #define tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
118 _tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data, \
119 #handler, __location__)
121 int _tevent_loop_once(struct tevent_context
*ev
, const char *location
);
122 #define tevent_loop_once(ev) \
123 _tevent_loop_once(ev, __location__) \
125 int _tevent_loop_wait(struct tevent_context *ev, const char *location);
126 #define tevent_loop_wait(ev) \
127 _tevent_loop_wait(ev, __location__) \
129 void tevent_fd_set_close_fn(struct tevent_fd *fde,
130 tevent_fd_close_fn_t close_fn
);
131 void tevent_fd_set_auto_close(struct tevent_fd
*fde
);
132 uint16_t tevent_fd_get_flags(struct tevent_fd
*fde
);
133 void tevent_fd_set_flags(struct tevent_fd
*fde
, uint16_t flags
);
135 bool tevent_signal_support(struct tevent_context
*ev
);
137 void tevent_set_abort_fn(void (*abort_fn
)(const char *reason
));
139 /* bits for file descriptor event flags */
140 #define TEVENT_FD_READ 1
141 #define TEVENT_FD_WRITE 2
143 #define TEVENT_FD_WRITEABLE(fde) \
144 tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) | TEVENT_FD_WRITE)
145 #define TEVENT_FD_READABLE(fde) \
146 tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) | TEVENT_FD_READ)
148 #define TEVENT_FD_NOT_WRITEABLE(fde) \
149 tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) & ~TEVENT_FD_WRITE)
150 #define TEVENT_FD_NOT_READABLE(fde) \
151 tevent_fd_set_flags(fde, tevent_fd_get_flags(fde) & ~TEVENT_FD_READ)
154 enum tevent_debug_level
{
157 TEVENT_DEBUG_WARNING
,
161 int tevent_set_debug(struct tevent_context
*ev
,
162 void (*debug
)(void *context
,
163 enum tevent_debug_level level
,
165 va_list ap
) PRINTF_ATTRIBUTE(3,0),
167 int tevent_set_debug_stderr(struct tevent_context
*ev
);
170 * An async request moves between the following 4 states:
172 enum tevent_req_state
{
174 * we are creating the request
178 * we are waiting the request to complete
180 TEVENT_REQ_IN_PROGRESS
,
182 * the request is finished
186 * A user error has occured
188 TEVENT_REQ_USER_ERROR
,
192 TEVENT_REQ_TIMED_OUT
,
194 * No memory in between
196 TEVENT_REQ_NO_MEMORY
,
198 * the request is already received by the caller
204 * @brief An async request
206 * This represents an async request being processed by callbacks via an event
207 * context. A user can issue for example a write request to a socket, giving
208 * an implementation function the fd, the buffer and the number of bytes to
209 * transfer. The function issuing the request will immediately return without
210 * blocking most likely without having sent anything. The API user then fills
211 * in req->async.fn and req->async.private_data, functions that are called
212 * when the request is finished.
214 * It is up to the user of the async request to talloc_free it after it has
215 * finished. This can happen while the completion function is called.
220 typedef void (*tevent_req_fn
)(struct tevent_req
*);
222 void tevent_req_set_callback(struct tevent_req
*req
, tevent_req_fn fn
, void *pvt
);
223 void *_tevent_req_callback_data(struct tevent_req
*req
);
224 void *_tevent_req_data(struct tevent_req
*req
);
226 #define tevent_req_callback_data(_req, _type) \
227 talloc_get_type_abort(_tevent_req_callback_data(_req), _type)
228 #define tevent_req_callback_data_void(_req) \
229 _tevent_req_callback_data(_req)
230 #define tevent_req_data(_req, _type) \
231 talloc_get_type_abort(_tevent_req_data(_req), _type)
233 typedef char *(*tevent_req_print_fn
)(struct tevent_req
*, TALLOC_CTX
*);
235 void tevent_req_set_print_fn(struct tevent_req
*req
, tevent_req_print_fn fn
);
237 char *tevent_req_default_print(struct tevent_req
*req
, TALLOC_CTX
*mem_ctx
);
239 char *tevent_req_print(TALLOC_CTX
*mem_ctx
, struct tevent_req
*req
);
241 struct tevent_req
*_tevent_req_create(TALLOC_CTX
*mem_ctx
,
245 const char *location
);
247 #define tevent_req_create(_mem_ctx, _pstate, _type) \
248 _tevent_req_create((_mem_ctx), (_pstate), sizeof(_type), \
249 #_type, __location__)
251 bool tevent_req_set_endtime(struct tevent_req
*req
,
252 struct tevent_context
*ev
,
253 struct timeval endtime
);
255 void _tevent_req_done(struct tevent_req
*req
,
256 const char *location
);
257 #define tevent_req_done(req) \
258 _tevent_req_done(req, __location__)
260 bool _tevent_req_error(struct tevent_req
*req
,
262 const char *location
);
263 #define tevent_req_error(req, error) \
264 _tevent_req_error(req, error, __location__)
266 bool _tevent_req_nomem(const void *p
,
267 struct tevent_req
*req
,
268 const char *location
);
269 #define tevent_req_nomem(p, req) \
270 _tevent_req_nomem(p, req, __location__)
272 struct tevent_req
*tevent_req_post(struct tevent_req
*req
,
273 struct tevent_context
*ev
);
275 bool tevent_req_is_in_progress(struct tevent_req
*req
);
277 bool tevent_req_poll(struct tevent_req
*req
,
278 struct tevent_context
*ev
);
280 bool tevent_req_is_error(struct tevent_req
*req
,
281 enum tevent_req_state
*state
,
284 void tevent_req_received(struct tevent_req
*req
);
286 struct tevent_req
*tevent_wakeup_send(TALLOC_CTX
*mem_ctx
,
287 struct tevent_context
*ev
,
288 struct timeval wakeup_time
);
289 bool tevent_wakeup_recv(struct tevent_req
*req
);
291 int tevent_timeval_compare(const struct timeval
*tv1
,
292 const struct timeval
*tv2
);
294 struct timeval
tevent_timeval_zero(void);
296 struct timeval
tevent_timeval_current(void);
298 struct timeval
tevent_timeval_set(uint32_t secs
, uint32_t usecs
);
300 struct timeval
tevent_timeval_until(const struct timeval
*tv1
,
301 const struct timeval
*tv2
);
303 bool tevent_timeval_is_zero(const struct timeval
*tv
);
305 struct timeval
tevent_timeval_add(const struct timeval
*tv
, uint32_t secs
,
308 struct timeval
tevent_timeval_current_ofs(uint32_t secs
, uint32_t usecs
);
312 struct tevent_queue
*_tevent_queue_create(TALLOC_CTX
*mem_ctx
,
314 const char *location
);
316 #define tevent_queue_create(_mem_ctx, _name) \
317 _tevent_queue_create((_mem_ctx), (_name), __location__)
319 typedef void (*tevent_queue_trigger_fn_t
)(struct tevent_req
*req
,
321 bool tevent_queue_add(struct tevent_queue
*queue
,
322 struct tevent_context
*ev
,
323 struct tevent_req
*req
,
324 tevent_queue_trigger_fn_t trigger
,
326 void tevent_queue_start(struct tevent_queue
*queue
);
327 void tevent_queue_stop(struct tevent_queue
*queue
);
329 size_t tevent_queue_length(struct tevent_queue
*queue
);
331 typedef int (*tevent_nesting_hook
)(struct tevent_context
*ev
,
336 const char *location
);
337 #ifdef TEVENT_DEPRECATED
339 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
340 #define _DEPRECATED_ __attribute__ ((deprecated))
345 void tevent_loop_allow_nesting(struct tevent_context
*ev
) _DEPRECATED_
;
346 void tevent_loop_set_nesting_hook(struct tevent_context
*ev
,
347 tevent_nesting_hook hook
,
348 void *private_data
) _DEPRECATED_
;
349 int _tevent_loop_until(struct tevent_context
*ev
,
350 bool (*finished
)(void *private_data
),
352 const char *location
) _DEPRECATED_
;
353 #define tevent_loop_until(ev, finished, private_data) \
354 _tevent_loop_until(ev, finished, private_data, __location__)
357 #ifdef TEVENT_COMPAT_DEFINES
359 #define event_context tevent_context
360 #define event_ops tevent_ops
361 #define fd_event tevent_fd
362 #define timed_event tevent_timer
363 #define signal_event tevent_signal
365 #define event_fd_handler_t tevent_fd_handler_t
366 #define event_timed_handler_t tevent_timer_handler_t
367 #define event_signal_handler_t tevent_signal_handler_t
369 #define event_context_init(mem_ctx) \
370 tevent_context_init(mem_ctx)
372 #define event_context_init_byname(mem_ctx, name) \
373 tevent_context_init_byname(mem_ctx, name)
375 #define event_backend_list(mem_ctx) \
376 tevent_backend_list(mem_ctx)
378 #define event_set_default_backend(backend) \
379 tevent_set_default_backend(backend)
381 #define event_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
382 tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data)
384 #define event_add_timed(ev, mem_ctx, next_event, handler, private_data) \
385 tevent_add_timer(ev, mem_ctx, next_event, handler, private_data)
387 #define event_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
388 tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data)
390 #define event_loop_once(ev) \
393 #define event_loop_wait(ev) \
396 #define event_get_fd_flags(fde) \
397 tevent_fd_get_flags(fde)
399 #define event_set_fd_flags(fde, flags) \
400 tevent_fd_set_flags(fde, flags)
402 #define EVENT_FD_READ TEVENT_FD_READ
403 #define EVENT_FD_WRITE TEVENT_FD_WRITE
405 #define EVENT_FD_WRITEABLE(fde) \
406 TEVENT_FD_WRITEABLE(fde)
408 #define EVENT_FD_READABLE(fde) \
409 TEVENT_FD_READABLE(fde)
411 #define EVENT_FD_NOT_WRITEABLE(fde) \
412 TEVENT_FD_NOT_WRITEABLE(fde)
414 #define EVENT_FD_NOT_READABLE(fde) \
415 TEVENT_FD_NOT_READABLE(fde)
417 #define ev_debug_level tevent_debug_level
419 #define EV_DEBUG_FATAL TEVENT_DEBUG_FATAL
420 #define EV_DEBUG_ERROR TEVENT_DEBUG_ERROR
421 #define EV_DEBUG_WARNING TEVENT_DEBUG_WARNING
422 #define EV_DEBUG_TRACE TEVENT_DEBUG_TRACE
424 #define ev_set_debug(ev, debug, context) \
425 tevent_set_debug(ev, debug, context)
427 #define ev_set_debug_stderr(_ev) tevent_set_debug_stderr(ev)
429 #endif /* TEVENT_COMPAT_DEFINES */
431 #endif /* __TEVENT_H__ */