xref: /netbsd-src/external/bsd/ntp/dist/sntp/libevent/defer-internal.h (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /*	$NetBSD: defer-internal.h,v 1.1.1.1 2013/12/27 23:31:17 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 2009-2012 Niels Provos and Nick Mathewson
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef DEFER_INTERNAL_H_INCLUDED_
29 #define DEFER_INTERNAL_H_INCLUDED_
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 #include "event2/event-config.h"
36 #include "evconfig-private.h"
37 
38 #include <sys/queue.h>
39 
40 struct event_callback;
41 typedef void (*deferred_cb_fn)(struct event_callback *, void *);
42 
43 /**
44    Initialize an empty, non-pending event_callback.
45 
46    @param deferred The struct event_callback structure to initialize.
47    @param priority The priority that the callback should run at.
48    @param cb The function to run when the struct event_callback executes.
49    @param arg The function's second argument.
50  */
51 void event_deferred_cb_init_(struct event_callback *, ev_uint8_t, deferred_cb_fn, void *);
52 /**
53    Change the priority of a non-pending event_callback.
54  */
55 void event_deferred_cb_set_priority_(struct event_callback *, ev_uint8_t);
56 /**
57    Cancel a struct event_callback if it is currently scheduled in an event_base.
58  */
59 void event_deferred_cb_cancel_(struct event_base *, struct event_callback *);
60 /**
61    Activate a struct event_callback if it is not currently scheduled in an event_base.
62 
63    Return true iff it was not previously scheduled.
64  */
65 int event_deferred_cb_schedule_(struct event_base *, struct event_callback *);
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif /* EVENT_INTERNAL_H_INCLUDED_ */
72 
73