s3: signals are processed twice in child.
[ira/wip.git] / lib / tevent / tevent_internal.h
index 475d00661a0c82f4d04df0579a98333e5827b514..7f5fd6485406e3033301239e0b17f59459a3728b 100644 (file)
@@ -3,7 +3,9 @@
 
    generalised event loop handling
 
-   Internal structs
+   INTERNAL STRUCTS. THERE ARE NO API GUARANTEES.
+   External users should only ever have to include this header when 
+   implementing new tevent backends.
 
    Copyright (C) Stefan Metzmacher 2005-2009
 
@@ -62,6 +64,15 @@ struct tevent_req {
         */
        tevent_req_print_fn private_print;
 
+       /**
+        * @brief A function to cancel the request
+        *
+        * The implementation might want to set a function
+        * that is called when the tevent_req_cancel() function
+        * was called.
+        */
+       tevent_req_cancel_fn private_cancel;
+
        /**
         * @brief Internal state of the request
         *
@@ -85,7 +96,27 @@ struct tevent_req {
                 *
                 * This for debugging only.
                 */
-               const char *location;
+               const char *create_location;
+
+               /**
+                * @brief The location where the request was finished
+                *
+                * This uses the __location__ macro via the tevent_req_done(),
+                * tevent_req_error() or tevent_req_nomem() macro.
+                *
+                * This for debugging only.
+                */
+               const char *finish_location;
+
+               /**
+                * @brief The location where the request was canceled
+                *
+                * This uses the __location__ macro via the
+                * tevent_req_cancel() macro.
+                *
+                * This for debugging only.
+                */
+               const char *cancel_location;
 
                /**
                 * @brief The external state - will be queried by the caller
@@ -105,58 +136,19 @@ struct tevent_req {
                uint64_t error;
 
                /**
-                * @brief the timer event if tevent_req_post was used
+                * @brief the immediate event used by tevent_req_post
                 *
                 */
-               struct tevent_timer *trigger;
+               struct tevent_immediate *trigger;
 
                /**
-                * @brief the timer event if tevent_req_set_timeout was used
+                * @brief the timer event if tevent_req_set_endtime was used
                 *
                 */
                struct tevent_timer *timer;
        } internal;
 };
 
-struct tevent_ops {
-       /* conntext init */
-       int (*context_init)(struct tevent_context *ev);
-
-       /* fd_event functions */
-       struct tevent_fd *(*add_fd)(struct tevent_context *ev,
-                                   TALLOC_CTX *mem_ctx,
-                                   int fd, uint16_t flags,
-                                   tevent_fd_handler_t handler,
-                                   void *private_data,
-                                   const char *handler_name,
-                                   const char *location);
-       void (*set_fd_close_fn)(struct tevent_fd *fde,
-                               tevent_fd_close_fn_t close_fn);
-       uint16_t (*get_fd_flags)(struct tevent_fd *fde);
-       void (*set_fd_flags)(struct tevent_fd *fde, uint16_t flags);
-
-       /* timed_event functions */
-       struct tevent_timer *(*add_timer)(struct tevent_context *ev,
-                                         TALLOC_CTX *mem_ctx,
-                                         struct timeval next_event,
-                                         tevent_timer_handler_t handler,
-                                         void *private_data,
-                                         const char *handler_name,
-                                         const char *location);
-       /* signal functions */
-       struct tevent_signal *(*add_signal)(struct tevent_context *ev,
-                                           TALLOC_CTX *mem_ctx,
-                                           int signum, int sa_flags,
-                                           tevent_signal_handler_t handler,
-                                           void *private_data,
-                                           const char *handler_name,
-                                           const char *location);
-
-       /* loop functions */
-       int (*loop_once)(struct tevent_context *ev, const char *location);
-       int (*loop_wait)(struct tevent_context *ev, const char *location);
-};
-
 struct tevent_fd {
        struct tevent_fd *prev, *next;
        struct tevent_context *event_ctx;
@@ -188,6 +180,21 @@ struct tevent_timer {
        void *additional_data;
 };
 
+struct tevent_immediate {
+       struct tevent_immediate *prev, *next;
+       struct tevent_context *event_ctx;
+       tevent_immediate_handler_t handler;
+       /* this is private for the specific handler */
+       void *private_data;
+       /* this is for debugging only! */
+       const char *handler_name;
+       const char *create_location;
+       const char *schedule_location;
+       /* this is private for the events_ops implementation */
+       void (*cancel_fn)(struct tevent_immediate *im);
+       void *additional_data;
+};
+
 struct tevent_signal {
        struct tevent_signal *prev, *next;
        struct tevent_context *event_ctx;
@@ -222,6 +229,9 @@ struct tevent_context {
        /* list of timed events - used by common code */
        struct tevent_timer *timer_events;
 
+       /* list of immediate events - used by common code */
+       struct tevent_immediate *immediate_events;
+
        /* list of signal events - used by common code */
        struct tevent_signal *signal_events;
 
@@ -230,6 +240,7 @@ struct tevent_context {
 
        /* pipe hack used with signal handlers */
        struct tevent_fd *pipe_fde;
+       int pipe_fds[2];
 
        /* debugging operations */
        struct tevent_debug_ops debug_ops;
@@ -238,13 +249,15 @@ struct tevent_context {
        struct {
                bool allowed;
                uint32_t level;
+               tevent_nesting_hook hook_fn;
+               void *hook_private;
        } nesting;
 };
 
 
-bool tevent_register_backend(const char *name, const struct tevent_ops *ops);
-
 int tevent_common_context_destructor(struct tevent_context *ev);
+int tevent_common_loop_wait(struct tevent_context *ev,
+                           const char *location);
 
 int tevent_common_fd_destructor(struct tevent_fd *fde);
 struct tevent_fd *tevent_common_add_fd(struct tevent_context *ev,
@@ -269,6 +282,14 @@ struct tevent_timer *tevent_common_add_timer(struct tevent_context *ev,
                                             const char *location);
 struct timeval tevent_common_loop_timer_delay(struct tevent_context *);
 
+void tevent_common_schedule_immediate(struct tevent_immediate *im,
+                                     struct tevent_context *ev,
+                                     tevent_immediate_handler_t handler,
+                                     void *private_data,
+                                     const char *handler_name,
+                                     const char *location);
+bool tevent_common_loop_immediate(struct tevent_context *ev);
+
 struct tevent_signal *tevent_common_add_signal(struct tevent_context *ev,
                                               TALLOC_CTX *mem_ctx,
                                               int signum,
@@ -278,6 +299,7 @@ struct tevent_signal *tevent_common_add_signal(struct tevent_context *ev,
                                               const char *handler_name,
                                               const char *location);
 int tevent_common_check_signal(struct tevent_context *ev);
+void tevent_cleanup_pending_signal_handlers(struct tevent_signal *se);
 
 bool tevent_standard_init(void);
 bool tevent_select_init(void);