Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
openapi_routing_rtrdisc.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2022-2023 Broadcom.
12 *
13 **********************************************************************
14 *
15 * Licensed under the Apache License, Version 2.0 (the "License");
16 * you may not use this file except in compliance with the License.
17 * You may obtain a copy of the License at
18 *
19 * http://www.apache.org/licenses/LICENSE-2.0
20 *
21 * Unless required by applicable law or agreed to in writing, software
22 * distributed under the License is distributed on an "AS IS" BASIS,
23 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24 * See the License for the specific language governing permissions and
25 * limitations under the License.
26 *
27 * Licensed under the Apache License, Version 2.0 (the "License");
28 * you may not use this file except in compliance with the License.
29 * You may obtain a copy of the License at
30 *
31 * http://www.apache.org/licenses/LICENSE-2.0
32 *
33 * Unless required by applicable law or agreed to in writing, software
34 * distributed under the License is distributed on an "AS IS" BASIS,
35 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36 * See the License for the specific language governing permissions and
37 * limitations under the License.
38 *
39 **********************************************************************
40 *
41 * @filename openapi_routing_rtrdisc.h
42 *
43 * @purpose Functions for reading routing Router Discovery configuration
44 *
45 * @component OPEN
46 *
47 * @create 09/11/2022
48 *
49 * @author Visakha Erina
50 *
51 * @end
52 *
53 **********************************************************************/
54 
55 #ifndef OPENAPI_ROUTING_RTRDISC_H_INCLUDED
56 #define OPENAPI_ROUTING_RTRDISC_H_INCLUDED
57 
58 #include "openapi_common.h"
59 
60 /*************************************************************************/
76  uint32_t intIfNum,
77  OPEN_BOOL_t *flag);
78 
79 /*************************************************************************/
95  uint32_t intIfNum,
96  OPEN_BOOL_t flag);
97 
98 /*************************************************************************/
115  uint32_t intIfNum,
116  open_inet_addr_t *ipAddr);
117 
118 /*************************************************************************/
135  uint32_t intIfNum,
136  open_inet_addr_t ipAddr);
137 
138 /*************************************************************************/
155  uint32_t intIfNum,
156  uint32_t *time);
157 
158 /*************************************************************************/
178  uint32_t intIfNum,
179  uint32_t time);
180 
181 /*************************************************************************/
198  uint32_t intIfNum,
199  uint32_t *time);
200 
201 /*************************************************************************/
221  uint32_t intIfNum,
222  uint32_t time);
223 
224 /*************************************************************************/
242  uint32_t intIfNum,
243  uint32_t *defMinAdvInt);
244 
245 /*************************************************************************/
262  uint32_t intIfNum);
263 
264 /*************************************************************************/
281  uint32_t intIfNum,
282  uint32_t *time);
283 
284 /*************************************************************************/
303  uint32_t intIfNum,
304  uint32_t time);
305 
306 /*************************************************************************/
323  uint32_t intIfNum,
324  uint32_t *defLifetime);
325 
326 /*************************************************************************/
343  uint32_t intIfNum);
344 
345 /*************************************************************************/
362  uint32_t intIfNum,
363  int32_t *integer);
364 
365 /*************************************************************************/
382  uint32_t intIfNum,
383  int32_t integer);
384 
385 #endif /* OPENAPI_ROUTING_RTRDISC_H_INCLUDED */
386 
open_error_t openapiRtrDiscAdvLifetimeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t time)
Sets the value of lifetime field of router advertisement sent from the interface. ...
open_error_t openapiRtrDiscAdvLifetimeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *time)
Gets the value of lifetime field of router advertisement sent from the interface. ...
open_error_t openapiRtrDiscMaxAdvIntervalGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *time)
Gets the maximum time allowed between sending router advertisements from the interface.
open_error_t openapiRtrDiscAdvLifetimeRevert(openapiClientHandle_t *client_handle, uint32_t intIfNum)
Revert AdvertisementLifetime to its default value.
open_error_t openapiRtrDiscAdvLifetimeDefaultGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *defLifetime)
Gets the default value of lifetime field of router advertisement sent from the interface.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiRtrDiscMinAdvIntervalSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t time)
Sets the minimum time allowed between sending router advertisements from the interface.
open_error_t openapiRtrDiscPreferenceLevelGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, int32_t *integer)
Gets the preferability of the address as a default router address, relative to other router addresses...
open_error_t openapiRtrDiscMinAdvIntervalGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *time)
Gets the minimum time allowed between sending router advertisements from the interface.
open_error_t openapiRtrDiscAdvertiseSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t flag)
Sets the router discovery mode on the interface.
open_error_t openapiRtrDiscPreferenceLevelSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, int32_t integer)
Sets the preferability of the address as a default router address, relative to other router addresses...
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
open_error_t openapiRtrDiscMinAdvIntervalDefaultGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *defMinAdvInt)
Gets the default minimum advertisement interval.
open_error_t openapiRtrDiscAdvertiseGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *flag)
Gets the router discovery mode on the interface.
open_error_t openapiRtrDiscAdvAddrSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, open_inet_addr_t ipAddr)
Sets the advertisement address that is used as the destination ip address in the advertisement packet...
open_error_t openapiRtrDiscMinAdvIntervalRevert(openapiClientHandle_t *client_handle, uint32_t intIfNum)
Revert MinAdvertisementInterval to its default value.
open_error_t openapiRtrDiscAdvAddrGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, open_inet_addr_t *ipAddr)
Gets the advertisement address that is used as the destination ip address in the advertisement packet...
open_error_t openapiRtrDiscMaxAdvIntervalSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t time)
Sets the maximum time allowed between sending router advertisements from the interface.