xref: /freebsd/contrib/unbound/libunbound/remote.h (revision 7a789145f88a6aceacc59029a0cafe7de7aeefea)
1 /*
2  * libunbound/remote.h - prototypes for remote control methods.
3  *
4  * Copyright (c) 2026, NLnet Labs. All rights reserved.
5  *
6  * This software is open source.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * Neither the name of the NLNET LABS nor the names of its contributors may
20  * be used to endorse or promote products derived from this software without
21  * specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 /**
37  * \file
38  *
39  * This file declares the methods that must be implemented to use the
40  * remote control service.
41  */
42 
43 #ifndef LIBUNBOUND_REMOTE_H
44 #define LIBUNBOUND_REMOTE_H
45 
46 struct comm_reply;
47 struct comm_point;
48 
49 /** fast reload thread commands to remote service thread event callback */
50 void fast_reload_service_cb(int fd, short bits, void* arg);
51 
52 /** fast reload callback for the remote control client connection */
53 int fast_reload_client_callback(struct comm_point* c, void* arg, int err,
54 	struct comm_reply* rep);
55 
56 /** handle remote control accept callbacks */
57 int remote_accept_callback(struct comm_point*, void*, int, struct comm_reply*);
58 
59 /** handle remote control data callbacks */
60 int remote_control_callback(struct comm_point*, void*, int, struct comm_reply*);
61 
62 /** routine to printout option values over SSL */
63 void  remote_get_opt_ssl(char* line, void* arg);
64 
65 #endif /* LIBUNBOUND_REMOTE_H */
66