Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_routing_arptable.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 * Licensed under the Apache License, Version 2.0 (the "License");
26 * you may not use this file except in compliance with the License.
27 * You may obtain a copy of the License at
28 *
29 * http://www.apache.org/licenses/LICENSE-2.0
30 *
31 * Unless required by applicable law or agreed to in writing, software
32 * distributed under the License is distributed on an "AS IS" BASIS,
33 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34 * See the License for the specific language governing permissions and
35 * limitations under the License.
36 *
37 **********************************************************************
38 *
39 * @filename openapi_routing_arptable.h
40 *
41 * @purpose Routing ARP table configuration and status.
42 *
43 * @component OPEN
44 *
45 * @create 12/02/2016
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_ROUTING_ARPTABLE_H_INCLUDED
51 #define OPENAPI_ROUTING_ARPTABLE_H_INCLUDED
52 
53 #include <stdio.h>
54 #include <stddef.h>
55 #include <sys/un.h>
56 
57 #include "openapi_common.h"
58 #include "openapi_routing_config.h"
59 
60 typedef enum
61 {
62  OPEN_ARP_LOCAL = 0x01,
63  OPEN_ARP_GATEWAY = 0x02,
64  OPEN_ARP_RESOLVED = 0x04,
65  OPEN_ARP_NET_DIR_BCAST = 0x08,
66  OPEN_ARP_DISCARD_WHEN_SOURCE = 0x10,
67  OPEN_ARP_STATIC = 0x20,
68  OPEN_ARP_UNNUMBERED = 0x40,
69  OPEN_ARP_KERNEL = 0x80
70 } OPEN_ARP_TYPE_t;
71 
72 typedef struct
73 {
74  OPEN_ARP_TYPE_t type;
75  uint32_t age;
76  open_inet_addr_t ipAddr;
77  uint16_t vrfId;
78  unsigned char macAddr[OPEN_MAC_ADDR_LEN];
79  uint16_t vlanId;
80  uint32_t intIfNum;
81  uint32_t hits;
82 } OPEN_ARP_ENTRY_t;
83 
84 /*****************************************************************/
97 open_error_t openapiArpAgeTimeGet(openapiClientHandle_t *client_handle,
98  uint32_t *val);
99 
100 /*****************************************************************/
113 open_error_t openapiArpResponseTimeGet(openapiClientHandle_t *client_handle,
114  uint32_t *val);
115 
116 /*****************************************************************/
129 open_error_t openapiArpNumRetriesGet(openapiClientHandle_t *client_handle,
130  uint32_t *val);
131 
132 /*****************************************************************/
145 open_error_t openapiArpCacheSizeGet(openapiClientHandle_t *client_handle,
146  uint32_t *val);
147 
148 /*****************************************************************/
161 open_error_t openapiArpDynamicRenewModeGet(openapiClientHandle_t *client_handle,
162  OPEN_CONTROL_t *val);
163 
164 /*****************************************************************/
178 open_error_t openapiArpTotalEntryCountInfoGet(openapiClientHandle_t *client_handle,
179  uint32_t *current,
180  uint32_t *peak);
181 
182 /*****************************************************************/
197 open_error_t openapiArpStaticEntryCountInfoGet(openapiClientHandle_t *client_handle,
198  uint32_t *configured,
199  uint32_t *active,
200  uint32_t *max);
201 
202 /*****************************************************************/
224 open_error_t openapiArpEntryVrfNextGet(openapiClientHandle_t *client_handle,
225  open_buffdesc *vrfName,
226  uint32_t *intf,
227  open_inet_addr_t *ipAddr);
228 
229 /*****************************************************************/
246 open_error_t openapiArpEntryInfoGet(openapiClientHandle_t *client_handle,
247  open_buffdesc *vrfName,
248  uint32_t intf,
249  open_inet_addr_t ipAddr,
250  OPEN_ARP_ENTRY_t *entry);
251 
252 #endif /* OPENAPI_ROUTING_ARPTABLE_H_INCLUDED */
253