Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Functions | |
open_error_t | openapiInetAton (openapiClientHandle_t *client_handle, open_buffdesc *ipAddr, uint32_t *value) |
Convert internet address string to a 32 bit integer. More... | |
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. More... | |
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. More... | |
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 the (logical) interface associated with the IP address of this entry. More... | |
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. More... | |
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 fragmented datagrams received on this interface. More... | |
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. More... | |
open_error_t openapiInetAton | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | ipAddr, | ||
uint32_t * | value | ||
) |
Convert internet address string to a 32 bit integer.
[in] | client_handle | client handle from registration API. |
[in] | ipAddr | pointer to dotted string reprensentation. |
[out] | value | pointer to 32 bit integer reprensentation. |
OPEN_E_NONE | IP address string converted successfully. |
OPEN_E_FAIL | IP address string converted failure. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API |
[in] | ipAddr | the ip address to which this entry's addressing information pertains. |
[in] | intIfNum | internal interface number for entry. |
OPEN_E_NONE | If the specified address entry exists. |
OPEN_E_FAIL | If the specified address entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API. |
[in,out] | ipAddr | ip address. |
[in,out] | intIfNum | internal interface number. |
OPEN_E_NONE | If the next route entry exists. |
OPEN_E_FAIL | If the next route entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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 the (logical) interface associated with the IP address of this entry.
[in] | client_handle | client handle from registration API. |
[in] | ipAddr | ip address of this entry. |
[out] | bcastAddr | least significant bit of the ip broadcast address. |
OPEN_E_NONE | If the subnet mask entry exists. |
OPEN_E_FAIL | If the subnet mask entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API. |
[in] | ipAddr | ip address of this entry. |
[out] | netmask | the subnet mask associated with the ip address of this entry. |
OPEN_E_NONE | If the subnet mask entry exists. |
OPEN_E_FAIL | If the subnet mask entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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 fragmented datagrams received on this interface.
[in] | client_handle | client handle from registration API. |
[in] | ipAddr | ip address of this entry. |
[out] | maxSize | size of largest re-assembled datagram. |
OPEN_E_NONE | If the max size entry exists. |
OPEN_E_FAIL | If the max size entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API. |
[in] | ipAddr | ip address of this entry. |
[out] | ifIndex | the interface index. |
OPEN_E_NONE | If the interface index entry exists. |
OPEN_E_FAIL | If the interface index entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7