TR-069 Object (Device.IP.Diagnostics.TraceRoute.RouteHops.{i}) Public APIs

Description

Describe the details about TR-069 Device IP Interface APIs specifications.

Functions
int	get_Device_IP_Diagnostics_TraceRoute_RouteHops_Host (const char *name, ParameterType type, ParameterValue *value)
	This function provides the result parameter indicating the Host Name, if DNS is able to resolve it, or the IP Address of a hop along the discovered route. More...
int	get_Device_IP_Diagnostics_TraceRoute_RouteHops_HostAddress (const char *name, ParameterType type, ParameterValue *value)
	This function provides the last IP address of the host returned for this hop. More...
int	get_Device_IP_Diagnostics_TraceRoute_RouteHops_ErrorCode (const char *name, ParameterType type, ParameterValue *value)
	This function provides the error code returned for this hop. This code is directly from the ICMP CODE field. More...
int	get_Device_IP_Diagnostics_TraceRoute_RouteHops_RTTimes (const char *name, ParameterType type, ParameterValue *value)
	This function provides a comma-separated list (maximum length 16) of unsigned integers. Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop. More...

Function Documentation

get_Device_IP_Diagnostics_TraceRoute_RouteHops_Host()

int get_Device_IP_Diagnostics_TraceRoute_RouteHops_Host	(	const char *	name,
		ParameterType	type,
		ParameterValue *	value
	)

This function provides the result parameter indicating the Host Name, if DNS is able to resolve it, or the IP Address of a hop along the discovered route.

Parameters

[in]	name	Source IP address.
[in]	type	Type of the valid interface.
[in]	value	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully get the address of a hop.
-1	If Not able to get the address of a hop.
-2	If Not handle getting the address of a hop.

get_Device_IP_Diagnostics_TraceRoute_RouteHops_HostAddress()

int get_Device_IP_Diagnostics_TraceRoute_RouteHops_HostAddress	(	const char *	name,
		ParameterType	type,
		ParameterValue *	value
	)

This function provides the last IP address of the host returned for this hop.

Note

This may be an empty string. If this parameter is not an empty string, the "Host" will contain the Host Name returned from the reverse DNS query.

Parameters

[in]	name	Source IP address.
[in]	type	Type of the valid interface.
[in]	value	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully get the address of the host returned for a hop.
-1	If Not able to get the address of the host returned for a hop.
-2	If Not handle getting the address of the host returned for a hop.

get_Device_IP_Diagnostics_TraceRoute_RouteHops_ErrorCode()

int get_Device_IP_Diagnostics_TraceRoute_RouteHops_ErrorCode	(	const char *	name,
		ParameterType	type,
		ParameterValue *	value
	)

This function provides the error code returned for this hop. This code is directly from the ICMP CODE field.

Parameters

[in]	name	Source IP address.
[in]	type	Type of the valid interface.
[in]	value	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully get the error code returned for this hop.
-1	If Not able to get the error code returned for this hop.
-2	If Not handle getting the error code returned for this hop.

get_Device_IP_Diagnostics_TraceRoute_RouteHops_RTTimes()

int get_Device_IP_Diagnostics_TraceRoute_RouteHops_RTTimes	(	const char *	name,
		ParameterType	type,
		ParameterValue *	value
	)

This function provides a comma-separated list (maximum length 16) of unsigned integers. Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop.

Parameters

[in]	name	Source IP address.
[in]	type	Type of the valid interface.
[in]	value	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully get the round trip times for a hop.
-1	If Not able to get the round trip times for a hop.
-2	If Not handle getting the round trip times for a hop.