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