Description

TR-069 Device.IP.Diagnostics.DownloadDiagnostics object Setter API

This is the setter group of API for the Device.IP.Diagnostics.DownloadDiagnostics object.

The interface for all functions is identical and is described here.

Parameters

[in]	*name	This is the complete path name of the parameter extracted from soap message, e.g. set_Device_IP_Diagnostics_DownloadDiagnostics_DiagnosticsState. In this case, the path is "Device.IP.Diagnostics.DownloadDiagnostics.DiagnosticsState".
[in]	*type	Data type of parameter defined for TR-069. This is same as the data type used in the Xi3 data-model.xml file. (see parameter.h)
[in]	*value	This is the value to which the parameter requested by the ACS must be set. (see paramaccess.h)

Returns: The status of the operation.

Return values

OK	If parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERROR	If parameter requested was successfully fetched. (Same as OK).
DIAG_ERROR	Diagnostic error.
ERR_???	Appropriate error value otherwise (see dimark_globals.h).

Functions
int	set_Device_IP_Diagnostics_DownloadDiagnostics_DiagnosticsState (const char , ParameterType, ParameterValue )
	This function sets the DiagnosticsState parameter which indicates the availability of diagnostic data. This is an enumeration of: More...

Function Documentation

◆ set_Device_IP_Diagnostics_DownloadDiagnostics_DiagnosticsState()

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

This function sets the DiagnosticsState parameter which indicates the availability of diagnostic data. This is an enumeration of:



None 

Requested 

Completed 

Error_InitConnectionFailed 

Error_NoResponse 

Error_TransferFailed 

Error_PasswordRequestFailed 

Error_LoginFailed 

Error_NoTransferMode 

Error_NoPASV 

Error_IncorrectSize 

Error_Timeout

Note

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error_xxx values listed above.
If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate.
When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.
After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.
Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.
While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.
While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

Description

TR-069 Device.IP.Diagnostics.DownloadDiagnostics object Setter API

Functions

Function Documentation

◆ set_Device_IP_Diagnostics_DownloadDiagnostics_DiagnosticsState()