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 #include <sys/time.h>
  28
  29 struct tevent_context;
  30 struct tevent_ops;
  31 struct tevent_fd;
  32 struct tevent_timer;
  33 struct tevent_aio;
  34 struct tevent_signal;
  35
  36 /* event handler types */
  37 typedef void (*tevent_fd_handler_t)(struct tevent_context *ev,
  38                                     struct tevent_fd *fde,
  39                                     uint16_t flags,
  40                                     void *private_data);
  41 typedef void (*tevent_fd_close_fn_t)(struct tevent_context *ev,
  42                                      struct tevent_fd *fde,
  43                                      int fd,
  44                                      void *private_data);
  45 typedef void (*tevent_timer_handler_t)(struct tevent_context *ev,
  46                                        struct tevent_timer *te,
  47                                        struct timeval current_time,
  48                                        void *private_data);
  49 typedef void (*tevent_signal_handler_t)(struct tevent_context *ev,
  50                                         struct tevent_signal *se,
  51                                         int signum,
  52                                         int count,
  53                                         void *siginfo,
  54                                         void *private_data);
  55 typedef void (*tevent_aio_handler_t)(struct tevent_context *ev,
  56                                      struct tevent_aio *ae,
  57                                      int ret,
  58                                      void *private_data);
  59
  60 struct tevent_context *tevent_context_init(TALLOC_CTX *mem_ctx);
  61 struct tevent_context *tevent_context_init_byname(TALLOC_CTX *mem_ctx, const char *name);
  62 const char **tevent_backend_list(TALLOC_CTX *mem_ctx);
  63 void tevent_set_default_backend(const char *backend);
  64
  65 struct tevent_fd *_tevent_add_fd(struct tevent_context *ev,
  66                                  TALLOC_CTX *mem_ctx,
  67                                  int fd,
  68                                  uint16_t flags,
  69                                  tevent_fd_handler_t handler,
  70                                  void *private_data,
  71                                  const char *handler_name,
  72                                  const char *location);
  73 #define tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data) \
  74         _tevent_add_fd(ev, mem_ctx, fd, flags, handler, private_data, \
  75                        #handler, __location__)
  76
  77 struct tevent_timer *_tevent_add_timer(struct tevent_context *ev,
  78                                        TALLOC_CTX *mem_ctx,
  79                                        struct timeval next_event,
  80                                        tevent_timer_handler_t handler,
  81                                        void *private_data,
  82                                        const char *handler_name,
  83                                        const char *location);
  84 #define tevent_add_timer(ev, mem_ctx, next_event, handler, private_data) \
  85         _tevent_add_timer(ev, mem_ctx, next_event, handler, private_data, \
  86                           #handler, __location__)
  87
  88 struct tevent_signal *_tevent_add_signal(struct tevent_context *ev,
  89                                          TALLOC_CTX *mem_ctx,
  90                                          int signum,
  91                                          int sa_flags,
  92                                          tevent_signal_handler_t handler,
  93                                          void *private_data,
  94                                          const char *handler_name,
  95                                          const char *location);
  96 #define tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data) \
  97         _tevent_add_signal(ev, mem_ctx, signum, sa_flags, handler, private_data, \
  98                            #handler, __location__)
  99
 100 struct iocb;
 101 struct tevent_aio *_tevent_add_aio(struct tevent_context *ev,
 102                                    TALLOC_CTX *mem_ctx,
 103                                    struct iocb *iocb,
 104                                    tevent_aio_handler_t handler,
 105                                    void *private_data,
 106                                    const char *handler_name,
 107                                    const char *location);
 108 #define tevent_add_aio(ev, mem_ctx, iocb, handler, private_data) \
 109         _tevent_add_aio(ev, mem_ctx, iocb, handler, private_data, \
 110                         #handler, __location__)
 111
 112 int tevent_loop_once(struct tevent_context *ev);
 113 int tevent_loop_wait(struct tevent_context *ev);
 114
 115 void tevent_fd_set_close_fn(struct tevent_fd *fde,
 116                             tevent_fd_close_fn_t close_fn);
 117 void tevent_fd_set_auto_close(struct tevent_fd *fde);
 118 uint16_t tevent_fd_get_flags(struct tevent_fd *fde);
 119 void tevent_fd_set_flags(struct tevent_fd *fde, uint16_t flags);
 120
 121 /* bits for file descriptor event flags */
 122 #define TEVENT_FD_READ 1
 123 #define TEVENT_FD_WRITE 2
 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
 204 #define EVENT_FD_WRITEABLE(fde) \
 205         TEVENT_FD_WRITEABLE(fde)
 206
 207 #define EVENT_FD_READABLE(fde) \
 208         TEVENT_FD_READABLE(fde)
 209
 210 #define EVENT_FD_NOT_WRITEABLE(fde) \
 211         TEVENT_FD_NOT_WRITEABLE(fde)
 212
 213 #define EVENT_FD_NOT_READABLE(fde) \
 214         TEVENT_FD_NOT_READABLE(fde)
 215
 216 #define ev_debug_level          tevent_debug_level
 217
 218 #define EV_DEBUG_FATAL          TEVENT_DEBUG_FATAL
 219 #define EV_DEBUG_ERROR          TEVENT_DEBUG_ERROR
 220 #define EV_DEBUG_WARNING        TEVENT_DEBUG_WARNING
 221 #define EV_DEBUG_TRACE          TEVENT_DEBUG_TRACE
 222
 223 #define ev_set_debug(ev, debug, context) \
 224         tevent_set_debug(ev, debug, context)
 225
 226 #define ev_set_debug_stderr(_ev) tevent_set_debug_stderr(ev)
 227
 228 #endif /* TEVENT_COMPAT_DEFINES */
 229
 230 #endif /* __TEVENT_H__ */