Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_dns.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_dns.h
28 *
29 * @purpose DNS Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 01/30/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_DNS_H_INCLUDED
39 #define OPENAPI_DNS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /*****************************************************************/
68 open_error_t openapiDNSDefaultDomainNameSet(openapiClientHandle_t *client_handle,
69  open_buffdesc *defaultDomainName);
70 
71 /*****************************************************************/
89 open_error_t openapiDNSDefaultDomainNameGet(openapiClientHandle_t *client_handle,
90  open_buffdesc *defaultDomainName);
91 
92 /*****************************************************************/
107 open_error_t openapiDNSDomainNameMaxSizeGet(openapiClientHandle_t *client_handle,
108  uint32_t *domainNameMaxSize);
109 
110 /*****************************************************************/
126 open_error_t openapiDNSDefaultDomainNameDelete(openapiClientHandle_t *client_handle);
127 
128 /*****************************************************************/
150 open_error_t openapiDNSIpNameServerAdd(openapiClientHandle_t *client_handle,
151  open_inet_addr_t *ipAddr);
152 
153 /*****************************************************************/
173 open_error_t openapiDNSIpNameServerDelete(openapiClientHandle_t *client_handle,
174  open_inet_addr_t *ipAddr);
175 
176 /*****************************************************************/
192 open_error_t openapiDNSIpNameServersNextGet(openapiClientHandle_t *client_handle,
193  open_inet_addr_t *ipAddr);
194 
195 /*****************************************************************/
211 open_error_t openapiDNSIpNameServersMaxSupportedGet(openapiClientHandle_t *client_handle,
212  uint32_t *maxNameServers);
213 
214 /*****************************************************************/
246 open_error_t openapiDNSStaticHostAddressMappingSet(openapiClientHandle_t *client_handle,
247  open_buffdesc *hostname,
248  open_inet_addr_t *ipAddr);
249 
250 /*****************************************************************/
276 open_error_t openapiDNSStaticHostAddressMappingRemove(openapiClientHandle_t *client_handle,
277  open_buffdesc *hostname);
278 
279 /*****************************************************************/
298 open_error_t openapiDNSStaticHostNextGet(openapiClientHandle_t *client_handle,
299  open_buffdesc *hostname);
300 
301 /*****************************************************************/
322 open_error_t openapiDNSStaticHostIpAddrGet(openapiClientHandle_t *client_handle,
323  open_buffdesc *hostname,
324  open_inet_addr_t *ipAddr);
325 
326 /*****************************************************************/
341 open_error_t openapiInetAddrMaxSizeGet(openapiClientHandle_t *client_handle,
342  uint32_t *inetAddrMaxSize);
343 
344 /*****************************************************************/
359 open_error_t openapiDNSDomainLabelMaximumSizeGet(openapiClientHandle_t *client_handle,
360  uint32_t *domainLabelMaxSize);
361 
362 /*****************************************************************/
382 open_error_t openapiDNSClientInetNameLookup(openapiClientHandle_t *client_handle,
383  open_buffdesc *hostname,
384  open_buffdesc *ipAddr);
385 
386 /*****************************************************************/
401 open_error_t openapiDNSAdminModeGet(openapiClientHandle_t * client_handle,
402  OPEN_CONTROL_t * adminMode);
403 
404 /*****************************************************************/
419 open_error_t openapiDNSAdminModeSet(openapiClientHandle_t * client_handle,
420  OPEN_CONTROL_t adminMode);
421 
422 #endif
423