TR-069 Object (Device.IP.Diagnostics.UDPEChoConfig) Public APIs

Description

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

Functions
int	set_Device_IP_Diagnostics_UDPEchoConfig_Enable (const char *, ParameterType, ParameterValue *)
	Set the enable flag for UDP Echo. More...
int	set_Device_IP_Diagnostics_UDPEchoConfig_Interface (const char *, ParameterType, ParameterValue *)
	This function sets the the path name of IP-layer interface over which the CPE MUST listen for and receive UDP echo requests. More...
int	set_Device_IP_Diagnostics_UDPEchoConfig_UDPPort (const char *, ParameterType, ParameterValue *)
	This function sets the UDP port on which the UDP server MUST listen and respond to UDP echo requests. More...

Function Documentation

set_Device_IP_Diagnostics_UDPEchoConfig_Enable()

int set_Device_IP_Diagnostics_UDPEchoConfig_Enable	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

Set the enable flag for UDP Echo.

This function sets the enable flag for UDP Echo.

Note

MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared.

Parameters

[in]	const	char Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully set the source IP address of the interface.
-1	If Not able to set the source IP address of the interface.
-2	If Not handle setting the source IP address of the interface.

set_Device_IP_Diagnostics_UDPEchoConfig_Interface()

int set_Device_IP_Diagnostics_UDPEchoConfig_Interface	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

This function sets the the path name of IP-layer interface over which the CPE MUST listen for and receive UDP echo requests.

Note

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets.

Parameters

[in]	const	char Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully set the path over which the test is to be performed.
-1	If Not able to set the path over which the test is to be performed.
-2	If Not handle setting the path over which the test is to be performed.

set_Device_IP_Diagnostics_UDPEchoConfig_UDPPort()

int set_Device_IP_Diagnostics_UDPEchoConfig_UDPPort	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

This function sets the UDP port on which the UDP server MUST listen and respond to UDP echo requests.

Parameters

[in]	const	char Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully set the UDP Echo port.
-1	If Not able to set the UDP Echo port.
-2	If Not handle setting the UDP Echo port.