FD.io VPP  v18.07-34-g55fbdb9
Vector Packet Processing
dns.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 option version = "1.0.0";
17 
18 /** \brief enable/disable name resolution
19 
20  @param client_index - opaque cookie to identify the sender
21  @param context - sender context, to match reply w/ request
22  @param is_enable - 1 = enable, 0 = disable
23 */
24 autoreply define dns_enable_disable {
28 };
29 
30 /** \brief add or delete an upstream name server
31 
32  @param client_index - opaque cookie to identify the sender
33  @param context - sender context, to match reply w/ request
34  @param is_ip6 - an ip6 name server
35  @param is_add - add = 1, delete = 0
36  @param server_address - server ip address
37 */
38 autoreply define dns_name_server_add_del {
43  u8 server_address[16];
44 };
45 
46 /** \brief DNS name resolution request
47 
48  @param client_index - opaque cookie to identify the sender
49  @param context - sender context, to match reply w/ request
50  @param name - the name to resolve
51 */
52 define dns_resolve_name {
55  u8 name[256];
56  };
57 
58 /** \brief DNS name resolution reply
59 
60  @param client_index - opaque cookie to identify the sender
61  @param context - sender context, to match reply w/ request
62  @param retval - return value, 0 => success
63  @param ip4_set - indicates that the ip4 address is valid
64  @param ip6_set - indicates that the ip6 address is valid
65  @param ip4_address - the ip4 name resolution reply
66  @param ip6_address - the ip6 name resolution reply
67 */
68 define dns_resolve_name_reply {
75 };
76 
77 /** \brief DNS IP -> name resolution request
78 
79  @param client_index - opaque cookie to identify the sender
80  @param context - sender context, to match reply w/ request
81  @param is_ip6 - set if the reverse-DNS request is an ip6 address
82  @param address - the address to map to a name
83 */
84 define dns_resolve_ip {
88  u8 address[16];
89  };
90 
91 /** \brief DNS ip->name resolution reply
92 
93  @param client_index - opaque cookie to identify the sender
94  @param context - sender context, to match reply w/ request
95  @param retval - return value, 0 => success
96  @param name - canonical name for the indicated IP address
97 */
98 define dns_resolve_ip_reply {
101  u8 name[256];
102 };
103 
typedef address
Definition: ip_types.api:35
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
typedef ip6_address
Definition: ip_types.api:21
signed int i32
Definition: types.h:81
typedef ip4_address
Definition: ip_types.api:17
option version
Definition: dns.api:16
static int dns_enable_disable(dns_main_t *dm, int is_enable)
Definition: dns.c:71