struct ara::diag::GenericDiagnosticSovdOperation::StartAsynchronousExecutionResponse

The structure ara::diag::GenericDiagnosticSovdOperation::StartAsynchronousExecutionResponse serves in the AUTOSAR Adaptive Platform as a response type when starting an asynchronously executing SOVD diagnostic operation [SWS_DM_02209]. It is instantiated by the application and returned to Diagnostic Management as a variant within a ara::core::Future when an operation is continued in the background AUTOSAR_AP_SWS_Diagnostics §8.62 “StartExecution”. Before the call, any required proximity challenge verification must have been successfully passed. Subsequently, Diagnostic Management generates the asynchronous response to the SOVD client based on this feedback.

more ›

Context

The data structure ara::diag::GenericDiagnosticSovdOperation::StartAsynchronousExecutionResponse serves in the functional cluster Diagnostic Management (DM) as a return type for the asynchronous start of an SOVD diagnostic operation [SWS_DM_02209]. For each configured operation of type DiagnosticSovdOperationStart, the instance of the Diagnostic Server provides the SOVD method for starting an operation according to ASAM SOVD [SWS_DM_01396]. As soon as a client requests the execution of an operation via the SOVD protocol, Diagnostic Management forwards this call to the interface ara::diag::GenericDiagnosticSovdOperation::StartExecution [SWS_DM_02174].

Within this flow, StartAsynchronousExecutionResponse acts as the response object of the application-specific diagnostic handler to Diagnostic Management. While synchronous operations are answered via StartSynchronousExecutionResponse [SWS_DM_02176], the return of StartAsynchronousExecutionResponse signals that the actual diagnostic processing is being continued as a background task and the immediate response to the SOVD client merely confirms successful initiation AUTOSAR_AP_SWS_Diagnostics §7.3.3.5.5.5 “Operations – Start execution of an operation”.

Lifecycle

The creation of StartAsynchronousExecutionResponse is performed by the concrete implementation of the service interface upon execution of StartExecution AUTOSAR_AP_SWS_Diagnostics §8.62 “StartExecution”. If the handler decides that the requested operation is to be processed asynchronously, it instantiates the struct and encapsulates it in a ara::core::Variant<StartSynchronousExecutionResponse, StartAsynchronousExecutionResponse>.

This variant is resolved via a ara::core::Promise and handed over to Diagnostic Management as ara::core::Future AUTOSAR_AP_SWS_Diagnostics §8.62 “StartExecution”. Upon resolving the future, ownership of the structure is transferred to Diagnostic Management. Interpretation: The instance of StartAsynchronousExecutionResponse is likely to be discarded after evaluation by Diagnostic Management once the SOVD response message to the external client has been generated and sent. Question Q-3977fae99e62957e (open) Further processing of the diagnostic task continues concurrently in the application context.

Usage Path

The regular flow begins with the arrival of an SOVD request at the Diagnostic Server to start an operation [SWS_DM_01396]. After successful pre-verification, Diagnostic Management calls the method StartExecution of the registered handler [SWS_DM_02174]. In this process, the operation name, the input data, meta information, and a ara::diag::CancellationHandler are passed AUTOSAR_AP_SWS_Diagnostics §8.62 “StartExecution”.

The handler starts the asynchronous background process, creates the structure StartAsynchronousExecutionResponse [SWS_DM_02209], and returns it in the ara::core::Future. Diagnostic Management retrieves the object and transforms the feedback into the standard-compliant asynchronous SOVD response to the client.

Sequence diagram: Asynchronous start of an SOVD operation via StartAsynchronousExecutionResponse. Sources: [SWS_DM_01396], [SWS_DM_02174], [SWS_DM_02209], AUTOSAR_AP_SWS_Diagnostics §8.62 “StartExecution”.

Error Scenarios

A central precondition for the method call is authorization: If required, a validation of the proximity challenge must have been successfully passed prior to calling StartExecution [SWS_DM_02174]. If this fails, the handler is not called and no StartAsynchronousExecutionResponse is created.

To handle cancellations during ongoing execution, the system provides a ara::diag::CancellationHandler AUTOSAR_AP_SWS_Diagnostics §8.62 “StartExecution”. If an error occurs in the handler before returning the future, the application can terminate the future with an error state, so that no valid response structure is processed further.