Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_API_ROUTE_NEXT_HOP_ADDR_BUF_MIN ((16 * 20) + 1) |
Minimum size of the buffer for the nex hop IP addresses list. | |
#define | OPEN_API_ROUTE_NEXT_HOP_INTF_BUF_MIN ((16 * 60) + 1) |
Minimum size of the buffer for the nex hop interfaces list. | |
#define | OPEN_API_ROUTE_PREF_MAX 255 |
Maximum value of the route preference. | |
#define | OPEN_API_ROUTE_PREF_MIN 0 |
Maximum value of the route preference. | |
Functions | |
open_error_t | openapiIpRouteAgeGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, uint32_t *routeAge) |
Gets the number of seconds since this route was last updated or otherwise determined to be correct. More... | |
open_error_t | openapiIpRouteEntryGetNext (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref) |
Gets the next route entry for the specified route destination. More... | |
open_error_t | openapiIpRouteHwFailureGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, OPEN_BOOL_t *hwFailure) |
Gets the hardware failure flag for this route. More... | |
open_error_t | openapiIpRouteMetricGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, uint32_t *metric) |
Gets the primary routing metric for this route. More... | |
open_error_t | openapiIpRouteNextHopAddrGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, open_buffdesc *nextHopAddr) |
Gets the comma separated list of the IP addresses of the next hop of this route. More... | |
open_error_t | openapiIpRouteNextHopIntfGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, open_buffdesc *nextHopIntf) |
Gets the comma separated list of the local interfaces through which the next hop of this route should be reached. More... | |
Definition at line 78 of file openapi_ip_route_table.h.
Definition at line 48 of file openapi_ip_route_table.h.
open_error_t openapiIpRouteAgeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routeDest, | ||
uint32_t * | routeMask, | ||
OPEN_RTO_PROTOCOL_INDICES_t * | routeProto, | ||
uint32_t * | routePref, | ||
uint32_t * | routeAge | ||
) |
Gets the number of seconds since this route was last updated or otherwise determined to be correct.
[in] | client_handle | client handle from registration API. |
[in] | routeDest | route destination for this aentry. |
[in] | routeMask | route mask for this entry. |
[in] | routeProto | route protocol for this entry. |
[in] | routePref | route preference for this entry. |
- | Minimum value OPEN_API_ROUTE_PREF_MIN | |
- | Maximum value OPEN_API_ROUTE_PREF_MAX | |
[out] | routeAge | route age for this entry in seconds. |
OPEN_E_NONE | If the routing age was retrived successfully. |
OPEN_E_FAIL | If failed to get the routing age. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.14
open_error_t openapiIpRouteEntryGetNext | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routeDest, | ||
uint32_t * | routeMask, | ||
OPEN_RTO_PROTOCOL_INDICES_t * | routeProto, | ||
uint32_t * | routePref | ||
) |
Gets the next route entry for the specified route destination.
[in] | client_handle | client handle from registration API. |
[in,out] | routeDest | route destination for this and next entry. |
[in,out] | routeMask | route mask for this and next entry. |
[in,out] | routeProto | route protocol for this and next entry. |
[in,out] | routePref | route preference for this and next entry |
- | Minimum value OPEN_API_ROUTE_PREF_MIN | |
- | Maximum value OPEN_API_ROUTE_PREF_MAX |
OPEN_E_NONE | If the corresponding entry exists. |
OPEN_E_FAIL | If the corresponding entry does not exist. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
To get first entry *routeDest, *routeMask, *routeProto and *routePref should be set with 0.
OpEN API Version: 1.14
open_error_t openapiIpRouteHwFailureGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routeDest, | ||
uint32_t * | routeMask, | ||
OPEN_RTO_PROTOCOL_INDICES_t * | routeProto, | ||
uint32_t * | routePref, | ||
OPEN_BOOL_t * | hwFailure | ||
) |
Gets the hardware failure flag for this route.
[in] | client_handle | client handle from registration API. |
[in] | routeDest | route destination for this aentry. |
[in] | routeMask | route mask for this entry. |
[in] | routeProto | route protocol for this entry. |
[in] | routePref | route preference for this entry. |
- | Minimum value OPEN_API_ROUTE_PREF_MIN | |
- | Maximum value OPEN_API_ROUTE_PREF_MAX | |
[out] | hwFailure | hardware failure flag for this entry. |
OPEN_E_NONE | If the hardware failure flag was retrived successfully. |
OPEN_E_FAIL | If failed to get the hardware failure flag. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.14
open_error_t openapiIpRouteMetricGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routeDest, | ||
uint32_t * | routeMask, | ||
OPEN_RTO_PROTOCOL_INDICES_t * | routeProto, | ||
uint32_t * | routePref, | ||
uint32_t * | metric | ||
) |
Gets the primary routing metric for this route.
[in] | client_handle | client handle from registration API. |
[in] | routeDest | route destination for this aentry. |
[in] | routeMask | route mask for this entry. |
[in] | routeProto | route protocol for this entry. |
[in] | routePref | route preference for this entry. |
- | Minimum value OPEN_API_ROUTE_PREF_MIN | |
- | Maximum value OPEN_API_ROUTE_PREF_MAX | |
[out] | metric | route metric for this entry. |
OPEN_E_NONE | If the primary routing metric was retrived successfully. |
OPEN_E_FAIL | If failed to get the primary routing metric. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.14
open_error_t openapiIpRouteNextHopAddrGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routeDest, | ||
uint32_t * | routeMask, | ||
OPEN_RTO_PROTOCOL_INDICES_t * | routeProto, | ||
uint32_t * | routePref, | ||
open_buffdesc * | nextHopAddr | ||
) |
Gets the comma separated list of the IP addresses of the next hop of this route.
[in] | client_handle | client handle from registration API. |
[in] | routeDest | route destination for this aentry. |
[in] | routeMask | route mask for this entry. |
[in] | routeProto | route protocol for this entry. |
[in] | routePref | route preference for this entry. |
- | Minimum value OPEN_API_ROUTE_PREF_MIN | |
- | Maximum value OPEN_API_ROUTE_PREF_MAX | |
[out] | nextHopAddr | comma separated list of the next hop IP addresses. |
- | Minimum buffer size OPEN_API_ROUTE_NEXT_HOP_ADDR_BUF_MIN |
OPEN_E_NONE | If the hardware failure flag was retrived successfully. |
OPEN_E_FAIL | If failed to get the hardware failure flag. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.14
open_error_t openapiIpRouteNextHopIntfGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routeDest, | ||
uint32_t * | routeMask, | ||
OPEN_RTO_PROTOCOL_INDICES_t * | routeProto, | ||
uint32_t * | routePref, | ||
open_buffdesc * | nextHopIntf | ||
) |
Gets the comma separated list of the local interfaces through which the next hop of this route should be reached.
[in] | client_handle | client handle from registration API. |
[in] | routeDest | route destination for this aentry. |
[in] | routeMask | route mask for this entry. |
[in] | routeProto | route protocol for this entry. |
[in] | routePref | route preference for this entry. |
- | Minimum value OPEN_API_ROUTE_PREF_MIN | |
- | Maximum value OPEN_API_ROUTE_PREF_MAX | |
[out] | nextHopIntf | comma separated list of the next hop interfaces. |
- | Minimum buffer size OPEN_API_ROUTE_NEXT_HOP_INTF_BUF_MIN |
OPEN_E_NONE | If the hardware failure flag was retrived successfully. |
OPEN_E_FAIL | If failed to get the hardware failure flag. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.14