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