struct ara::diag::GenericDiagnosticSovdOperation::StartSynchronousExecutionResponse

The data structure ara::diag::GenericDiagnosticSovdOperation::StartSynchronousExecutionResponse serves as a return container for the result data of a synchronously executed SOVD diagnostic operation [SWS_DM_02208]. After successful pre-verification of an optional proximity_challenge, Diagnostic Management calls the application method StartExecution [SWS_DM_02174]. From the data contained in the response structure, Diagnostic Management derives the parameters attribute of the SOVD response body according to ASAM SOVD [SWS_DM_02176]. The mechanism strictly requires that the diagnostic operation is designed for synchronous execution.

more ›

Context

The structure ara::diag::GenericDiagnosticSovdOperation::StartSynchronousExecutionResponse is part of the diagnostic interface (module diag) in the AUTOSAR Adaptive Platform and is formally defined in [SWS_DM_02208] as well as in AUTOSAR_AP_SWS_Diagnostics §8.62.4 “Struct: StartSynchronousExecutionResponse”. Its primary task is the transportation of response data during the synchronous execution of a diagnostic operation via the standardized SOVD protocol (Service-Oriented Vehicle Diagnostics).

In this context, three main system partners interact: An external client requests the start of an SOVD operation via a diagnostic server instance [SWS_DM_01396]. Diagnostic Management (DM) processes the request and calls the application-specific interface ara::diag::GenericDiagnosticSovdOperation::StartExecution [SWS_DM_02174]. If the execution is synchronous, the DM accepts the instance of StartSynchronousExecutionResponse and generates from it the SOVD-compliant response body for the client [SWS_DM_02176], as specified in AUTOSAR_AP_SWS_Diagnostics §7.3.3.5.5.5 “Operations – Start execution of an operation”.

Lifecycle

As a data structure, StartSynchronousExecutionResponse has the character of a pure value and transfer object without an independent state machine. The structure is instantiated by the individual application logic during the call of StartExecution. Interpretation: Creation is likely to take place typically as a return value directly in the local stack context of the synchronous processing method of the application. Question (open)

After completion of the operation logic, the object is passed to the calling context of the DM. The latter extracts the contained payload (DiagnosticSovdContentData) in order to populate the required SOVD attributes [SWS_DM_02176]. After completing the transformation and sending the response message, the lifetime of the response object ends. The lifecycle is thus strictly bound to the synchronous call duration of the operation; persistent management or concurrent synchronization is omitted.

Usage Path

The regular flow takes place in the following steps:

1. A client calls the SOVD method for starting an operation provided by the diagnostic server instance [SWS_DM_01396].
2. The DM checks the request and, if necessary, performs a validation of the proximity check (proximity_challenge) [SWS_DM_02174].
3. After successful verification, the DM delegates the call to the application via ara::diag::GenericDiagnosticSovdOperation::StartExecution [SWS_DM_02174].
4. The application handles the operation synchronously and creates the instance StartSynchronousExecutionResponse into which the result data is placed [SWS_DM_02208].
5. The DM derives the attribute parameters from the DiagnosticSovdContentData contained in the response and returns the complete SOVD response body according to ASAM SOVD [SWS_DM_02176].

Sequence diagram: Sequence during the synchronous start of an SOVD operation and further processing of StartSynchronousExecutionResponse. Sources: [SWS_DM_01396], [SWS_DM_02174], [SWS_DM_02176], AUTOSAR_AP_SWS_Diagnostics §7.3.3.5.5.5 “Operations – Start execution of an operation”

Error Scenarios

The execution and evaluation of the response are subject to defined conditions:

• Failed precondition: If a validation of proximity_challenge is required and fails, the DM does not invoke StartExecution in the first place [SWS_DM_02174]. In this case, no instance of StartSynchronousExecutionResponse is instantiated.
• Non-synchronous execution: If the operation was not configured or started as a synchronous SOVD operation, handling via StartSynchronousExecutionResponse does not apply [SWS_DM_02176].
• Application error: Interpretation: If an error occurs during internal processing in the application, an error path is likely to take effect instead of a regular StartSynchronousExecutionResponse, whereby no valid DiagnosticSovdContentData are provided to derive the attribute parameters. Question Q-5faaee7b9b008dde (open)