Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Enumerations | |
enum | OPEN_TRACEROUTE_ADDR_TYPE_t { OPEN_TRACEROUTE_ADDR_TYPE_IPV4 = 0, OPEN_TRACEROUTE_ADDR_TYPE_IPV6 = 1 } |
enum | OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t { OPEN_TRACEROUTE_SOURCE_INTF_SERVICE_PORT = 0, OPEN_TRACEROUTE_SOURCE_INTF_NETWORK_PORT = 1 } |
Functions | |
open_error_t | openapiTracerouteAddress (openapiClientHandle_t *client_handle, open_buffdesc *address, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address. More... | |
open_error_t | openapiTracerouteAddressExplicit (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteCount, uint32_t tracerouteInterval, uint32_t tracerouteInitTtl, uint32_t tracerouteMaxTtl, uint32_t tracerouteMaxFail, uint32_t tracerouteSize, uint32_t tracerouteUdpPort, OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t srcIntf, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with all parameters given at a time. More... | |
open_error_t | openapiTracerouteAddressWithCount (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteCount, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific count. More... | |
open_error_t | openapiTracerouteAddressWithInterval (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteInterval, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific interval. More... | |
open_error_t | openapiTracerouteAddressWithMaxFail (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteMaxFail, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific max fail. More... | |
open_error_t | openapiTracerouteAddressWithPDUSize (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteSize, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific PDU size. More... | |
open_error_t | openapiTracerouteAddressWithSourceInterface (openapiClientHandle_t *client_handle, open_buffdesc *address, OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t srcIntf, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific source interface. More... | |
open_error_t | openapiTracerouteAddressWithTtl (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteInitTtl, uint32_t tracerouteMaxTtl, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific init ttl and max ttl. More... | |
open_error_t | openapiTracerouteAddressWithUdpPort (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t tracerouteUdpPort, open_buffdesc *output) |
Traceroute host or IPv4/IPv6 Address with specific UDP port. More... | |
Enumerator | |
---|---|
OPEN_TRACEROUTE_ADDR_TYPE_IPV4 |
Traceroute IPv4 Address Type. |
OPEN_TRACEROUTE_ADDR_TYPE_IPV6 |
Traceroute Ipv6 Address Type. |
Definition at line 50 of file openapi_traceroute.h.
Definition at line 56 of file openapi_traceroute.h.
open_error_t openapiTracerouteAddress | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressExplicit | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteCount, | ||
uint32_t | tracerouteInterval, | ||
uint32_t | tracerouteInitTtl, | ||
uint32_t | tracerouteMaxTtl, | ||
uint32_t | tracerouteMaxFail, | ||
uint32_t | tracerouteSize, | ||
uint32_t | tracerouteUdpPort, | ||
OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t | srcIntf, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with all parameters given at a time.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | traceCount | number of probes per hop |
[in] | tracerouteInterval | time between probes in secs |
[in] | traceRouteInitTtl | initial TTL for session |
[in] | tracerouteMaxTtl | maximum TTL for the destination |
[in] | tracerouteMaxFail | maximum failures allowed in session |
[in] | tracerouteSize | PDU size of probe packets |
[in] | tracerouteUdpPort | UDP dest port in probe packets |
[in] | srcIntf | network port/service port |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OPEN_E_UNAVAIL | if service port/network port is not supported for source interface |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithCount | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteCount, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific count.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | traceCount | number of probes per hop |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithInterval | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteInterval, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific interval.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | tracerouteInterval | time between probes in seconds |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithMaxFail | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteMaxFail, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific max fail.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | tracerouteMaxFail | maximum failures allowed in session |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithPDUSize | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteSize, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific PDU size.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | tracerouteSize | PDU size of probe packets |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithSourceInterface | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t | srcIntf, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific source interface.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address with size (Size of probe packets) |
[in] | srcIntf | network port/service port |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OPEN_E_UNAVAIL | if service port/network port is not supported for source interface |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithTtl | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteInitTtl, | ||
uint32_t | tracerouteMaxTtl, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific init ttl and max ttl.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | traceRouteInitTtl | initial TTL for session |
[in] | tracerouteMaxTtl | maximum TTL for the destination |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiTracerouteAddressWithUdpPort | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | tracerouteUdpPort, | ||
open_buffdesc * | output | ||
) |
Traceroute host or IPv4/IPv6 Address with specific UDP port.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | tracerouteUdpport | UDP dest port in probe packets |
[out] | output | traceroute output |
OPEN_E_NONE | if traceroute of host or IPv4/ipv6 address is successful. |
OPEN_E_FAIL | if failed to traceroute the host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18