Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
APIs To Traceroute Host Or IPv4/IPv6 Address [OPENAPI_TRACEROUTE]

Macros

#define OPEN_TRACEROUTE_ADDRESS_MAX_LEN   256
 
#define OPEN_TRACEROUTE_DEFAULT_MAX_TTL   30
 
#define OPEN_TRACEROUTE_DEFAULT_PROBE_SIZE   0
 
#define OPEN_TRACEROUTE_OUTPUT_STRING_SIZE   4096
 
#define OPEN_TRACEROUTE_STRING_SIZE   1024
 

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...
 

Detailed Description

Enumeration Type Documentation

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.

Enumerator
OPEN_TRACEROUTE_SOURCE_INTF_SERVICE_PORT 

Traceroute IP Address/Hostname/IPv6 Address with source interface as service port.

OPEN_TRACEROUTE_SOURCE_INTF_NETWORK_PORT 

Traceroute IP Address/Hostname/IPv6 Address with source interface as network port.

Definition at line 56 of file openapi_traceroute.h.

Function Documentation

open_error_t openapiTracerouteAddress ( openapiClientHandle_t client_handle,
open_buffdesc address,
open_buffdesc output 
)

Traceroute host or IPv4/IPv6 Address.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]traceCountnumber of probes per hop
[in]tracerouteIntervaltime between probes in secs
[in]traceRouteInitTtlinitial TTL for session
[in]tracerouteMaxTtlmaximum TTL for the destination
[in]tracerouteMaxFailmaximum failures allowed in session
[in]tracerouteSizePDU size of probe packets
[in]tracerouteUdpPortUDP dest port in probe packets
[in]srcIntfnetwork port/service port
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
OPEN_E_UNAVAILif service port/network port is not supported for source interface
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteCount are OPEN_TRACEROUTE_MIN_PROBE_PER_HOP and OPEN_TRACEROUTE_MAX_PROBE_PER_HOP.
Min and Max values for tracerouteInterval are OPEN_TRACEROUTE_MIN_INTERVAL and OPEN_TRACEROUTE_MAX_INTERVAL.
Min and Max values for tracerouteInitTtl are OPEN_TRACEROUTE_MIN_INIT_TTL and OPEN_TRACEROUTE_MAX_INIT_TTL.
Min and Max values for tracerouteMaxTtl are OPEN_TRACEROUTE_MIN_TTL and OPEN_TRACEROUTE_MAX_TTL.
Min and Max values for tracerouteMaxFail are OPEN_TRACEROUTE_MIN_FAIL and OPEN_TRACEROUTE_MAX_FAIL.
Min and Max values for tracerouteSize are OPEN_TRACEROUTE_MIN_PROBE_SIZE and OPEN_TRACEROUTE_MAX_PROBE_SIZE.
Min and Max values for tracerouteUdpPort are OPEN_TRACEROUTE_MIN_PORT and OPEN_TRACEROUTE_MAX_PORT.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]traceCountnumber of probes per hop
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteCount are OPEN_TRACEROUTE_MIN_PROBE_PER_HOP and OPEN_TRACEROUTE_MAX_PROBE_PER_HOP.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]tracerouteIntervaltime between probes in seconds
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteInterval are OPEN_TRACEROUTE_MIN_INTERVAL and OPEN_TRACEROUTE_MAX_INTERVAL.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]tracerouteMaxFailmaximum failures allowed in session
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteMaxFail are OPEN_TRACEROUTE_MIN_FAIL and OPEN_TRACEROUTE_MAX_FAIL.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]tracerouteSizePDU size of probe packets
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteSize are OPEN_TRACEROUTE_MIN_PROBE_SIZE and OPEN_TRACEROUTE_MAX_PROBE_SIZE.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address with size (Size of probe packets)
[in]srcIntfnetwork port/service port
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
OPEN_E_UNAVAILif service port/network port is not supported for source interface
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]traceRouteInitTtlinitial TTL for session
[in]tracerouteMaxTtlmaximum TTL for the destination
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteInitTtl are OPEN_TRACEROUTE_MIN_INIT_TTL and OPEN_TRACEROUTE_MAX_INIT_TTL.
Min and Max values for tracerouteMaxTtl are OPEN_TRACEROUTE_MIN_TTL and OPEN_TRACEROUTE_MAX_TTL.

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.

Parameters
[in]client_handleClient handle from registration API
[in]addresshost or IPv4/IPv6 Address
[in]tracerouteUdpportUDP dest port in probe packets
[out]outputtraceroute output
Return values
OPEN_E_NONEif traceroute of host or IPv4/ipv6 address is successful.
OPEN_E_FAILif failed to traceroute the host or IPv4/IPv6 address.
OPEN_E_PARAMif invalid parameter is passed.
Note
Buffer size for address should be OPEN_TRACEROUTE_ADDRESS_MAX_LEN.
Buffer size for output should be OPEN_TRACEROUTE_STRING_SIZE.
Min and Max values for tracerouteUdpPort are OPEN_TRACEROUTE_MIN_PORT and OPEN_TRACEROUTE_MAX_PORT.

OpEN API Version: 1.18