xref: /freebsd/contrib/unbound/dns64/dns64.h (revision 580744621f33383027108364dcadad718df46ffe)
1 /*
2  * dns64/dns64.h - DNS64 module
3  *
4  * Copyright (c) 2009, Viagénie. 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 LIMITED
25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 /**
37  * \file
38  *
39  * This file contains a module that performs DNS64 query processing.
40  */
41 
42 #ifndef DNS64_DNS64_H
43 #define DNS64_DNS64_H
44 #include "util/module.h"
45 
46 /**
47  * Get the dns64 function block.
48  * @return: function block with function pointers to dns64 methods.
49  */
50 struct module_func_block *dns64_get_funcblock(void);
51 
52 /** dns64 init */
53 int dns64_init(struct module_env* env, int id);
54 
55 /** dns64 deinit */
56 void dns64_deinit(struct module_env* env, int id);
57 
58 /** dns64 operate on a query */
59 void dns64_operate(struct module_qstate* qstate, enum module_ev event, int id,
60 		struct outbound_entry* outbound);
61 
62 void dns64_inform_super(struct module_qstate* qstate, int id,
63     struct module_qstate* super);
64 
65 /** dns64 cleanup query state */
66 void dns64_clear(struct module_qstate* qstate, int id);
67 
68 /** dns64 alloc size routine */
69 size_t dns64_get_mem(struct module_env* env, int id);
70 
71 #endif /* DNS64_DNS64_H */
72