Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_ip.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_ip.h
28 *
29 * @purpose IP support
30 *
31 * @component OpEN
32 *
33 * @create 23/02/2015
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_IP_H_INCLUDED
39 #define OPENAPI_IP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /*****************************************************************/
63  uint32_t ipAddr, uint32_t intIfNum);
64 
65 /*****************************************************************/
84  uint32_t *ipAddr, uint32_t *intIfNum);
85 
86 /*****************************************************************/
107  uint32_t ipAddr, uint32_t *ifIndex);
108 
109 /*****************************************************************/
130  uint32_t ipAddr, uint32_t *netmask);
131 
132 /*****************************************************************/
155  uint32_t ipAddr, uint32_t *bcastAddr);
156 
157 /*****************************************************************/
178  uint32_t ipAddr, uint32_t *maxSize);
179 
180 /*****************************************************************/
198  open_buffdesc *ipAddr, uint32_t *value);
199 
200 #endif /* OPENAPI_IP_H_INCLUDED */
201 
open_error_t openapiInetAton(openapiClientHandle_t *client_handle, open_buffdesc *ipAddr, uint32_t *value)
Convert internet address string to a 32 bit integer.
open_error_t openapiIpEntIfIndexGet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t *ifIndex)
Gets the index value which uniquely identifies the interface to which this entry is applicable...
open_error_t openapiIpAdEntBCastGet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t *bcastAddr)
Gets the value of the least-significant bit in the IP broadcast address used for sending datagrams on...
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiIpAdEntAddrGet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t intIfNum)
Determines if the Ip address entry corresponding to this ip address exists.
open_error_t openapiIpAdEntReasmMaxSizeGet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t *maxSize)
Gets the size of the largest IP datagram which this entity can re-assemble from incoming IP fragmente...
open_error_t openapiIpAdEntAddrGetNext(openapiClientHandle_t *client_handle, uint32_t *ipAddr, uint32_t *intIfNum)
Get the Ip Address entry which is next to the entry corresponding to this ip address entry...
open_error_t openapiIpAdEntNetMaskGet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t *netmask)
Gets the subnet mask associated with the IP address of this entry.