class ara::diag::SovdSwUpdate

The pure virtual function DeleteUpdatePackage of class ara::diag::SovdSwUpdate is called according to [SWS_DM_01803] by the instance of the Diagnostic Server when the SOVD method "Delete Update Package from an SOVD Server" is to be executed ([SWS_DM_01922]). It initiates the server-side removal of an update package.

The call takes place asynchronously and returns a ara::core::Future<void>, which indicates successful completion or provides an error object [SWS_DM_01922]. The signature requires the following input parameters:

• updatePackageId: Designates as ara::core::String the unique ID of the update package to be deleted.
• metaInfo: Passes additional context information of the request as MetaInfo const&.
• cancellationHandler: Transmits an object of type CancellationHandler that informs whether the current conversation was cancelled.

If an error occurs during processing, the Future is populated with a corresponding SOVD error. The specification prescribes the use of appropriate error codes from ASAM SOVD 1.1 or ISO 17978-3 for this purpose [SWS_DM_01922].

Regarding concurrency, the method is defined as conditionally thread-safe: Whether the implementation must be executed thread-safe or non-thread-safe is determined via the ConcurrencyType passed in the constructor [SWS_DM_01922]. In addition, the function is declared as noexcept and exception-safe, which is why no exceptions may escape.

use

The pure virtual method ExecuteUpdatePackage of interface ara::diag::SovdSwUpdate serves to execute the SOVD method "Execute Installation of an Update" [SWS_DM_01920]. The declaration is found in header ara/diag/sovd_sw_update.h AUTOSAR_AP_SWS_Diagnostics §8.58.2.1.3.2 “ExecuteUpdatePackage”. Passed as input parameters are the identifier of the update package (updatePackageId) and request data (metaInfo) [SWS_DM_01920]. In addition, object cancellationHandler informs if the running conversation was cancelled [SWS_DM_01920]. The call takes place asynchronously and returns a ara::core::Future<void>, which provides a positive result or reports an SOVD error [SWS_DM_01920].

Error handling

The interface is specified as noexcept and exception-safe ("exception safe") [SWS_DM_01920]. Consequently, errors during execution must not be thrown via C++ exceptions, but are to be returned asynchronously via the ara::core::Future with applicable error codes from ASAM SOVD 1.1 or ISO 17978-3 [SWS_DM_01920].

Concurrency and Constraints

Regarding thread safety, there is a conditional requirement ("conditional"): Whether the function must be implemented thread-safe or non-thread-safe is determined via the parameter ConcurrencyType that was passed to the constructor [SWS_DM_01920]. The implementation would likely need to evaluate the cancellationHandler in order to terminate package installation in an orderly manner upon a cancellation of the conversation [SWS_DM_01920]. Question Q-8fe6950e8f5a168c (open)

The member function ara::diag::SovdSwUpdate::Offer registers the handler for SOVD software updates with Diagnostic Management (DM) to enable it to forward incoming request messages to the handler [SWS_DM_01924]. The call takes place synchronously and without parameters via header ara/diag/sovd_sw_update.h and, according to noexcept, throws no C++ exceptions [SWS_DM_01924].

The result of the operation is returned as ara::core::Result<void> [SWS_DM_01924]. If offering fails, the function returns an error with rollback semantics [SWS_DM_01924]:

• DiagOfferErrc::kAlreadyOffered: The service was already successfully offered for this handler beforehand [SWS_DM_01924].
• DiagOfferErrc::kConfigurationMismatch: The monitor configuration does not match the DEXT configuration [SWS_DM_01924].

Regarding concurrency, the method is specified as exception safe, but explicitly as not thread-safe (not thread-safe) [SWS_DM_01924]. Interpretation: For accesses from multiple threads, external application-side synchronization is therefore likely required. Question Q-4636ad27701d59df (open) The offering principle via Offer corresponds to the general scheme for diagnostic handlers such as [SWS_DM_00557] or [SWS_DM_00735], in which the DM can only forward requests once the corresponding interface is actively offered [SWS_DM_01525].

The pure virtual method PrepareUpdatePackage of interface ara::diag::SovdSwUpdate serves to prepare the installation of a software update package within the scope of the SOVD method "Prepare Installation of an Update" in accordance with [SWS_DM_01919] (AUTOSAR_AP_SWS_Diagnostics §8.58.2.1.3.7 “PrepareUpdatePackage”).

Call and Parameters

The function is provided via header ara/diag/sovd_sw_update.h and accepts the following parameters:

• updatePackageId: Identifier (ara::core::String) of the update package to be prepared.
• metaInfo: Metadata (MetaInfo const&) for the incoming SOVD request.
• cancellationHandler: Monitoring object (CancellationHandler) that informs about the cancellation of the current conversation.

The call is specified as noexcept and behaves in an exception-safe manner. The asynchronous result is provided via a ara::core::Future<void>, which either signals successful completion or provides an error [SWS_DM_01919].

Error Handling and Concurrency

If an error occurs during preparation, an appropriate error code according to ASAM SOVD 1.1 or ISO 17978-3 must be returned in Future [SWS_DM_01919]. Regarding thread safety, a conditional requirement applies (conditional): Whether the function must be implemented thread-safely is determined via the ConcurrencyType specified in the constructor during instantiation [SWS_DM_01919]. Via the object cancellationHandler, the application would likely be able to abort lengthy preparation steps if the request is terminated prematurely. Question Q-be4c53d9a0427ed5 (open)

use

The pure virtual method PutUpdatePackageAutomated is called in the context of the SOVD method "Automated Installation of an Update" [SWS_DM_01918]. It is declared in header ara/diag/sovd_sw_update.h within class ara::diag::SovdSwUpdate AUTOSAR_AP_SWS_Diagnostics §8.58.2.1.3.8 “PutUpdatePackageAutomated”. The function serves to automatically install an update package specified by its identifier.

The interface expects the following input parameters:

• updatePackageId (ara::core::String): Identifier of the update package that is to be submitted to automated installation [SWS_DM_01918].
• metaInfo (MetaInfo const &): Meta-information of the incoming service request [SWS_DM_01918].
• cancellationHandler (CancellationHandler): Informs the operation whether the running conversation was cancelled [SWS_DM_01918].

The call has asynchronous semantics. A ara::core::Future<void> serves as the return value, which after completion either indicates successful execution or contains an error state [SWS_DM_01918].

Error Handling and Concurrency

In the event of an error, an applicable error code from ASAM SOVD 1.1 or ISO 17978-3 must be returned via the future [SWS_DM_01918]. The method is specified as exception-safe (exception safe) and, as a noexcept function, throws no C++ exceptions AUTOSAR_AP_SWS_Diagnostics §8.58.2.1.3.8 “PutUpdatePackageAutomated”.

The thread safety of the method is conditional (conditional): Whether the implementation must be executed thread-safe or non-thread-safe is determined via the ConcurrencyType passed during constructor invocation [SWS_DM_01918].

The pure virtual function RequestUpdatePackageRegistration of class ara::diag::SovdSwUpdate serves the SOVD method "Register an Update at the SOVD Server" [SWS_DM_01923]. It initiates the registration of an update package on the server and initiates the associated transfer session AUTOSAR_AP_SWS_Diagnostics §8.58.2.1.3.9 “RequestUpdatePackageRegistration”.

The call takes place asynchronously and returns a ara::core::Future, which in the event of success contains a tuple consisting of a DataTransferWriteSession and a ara::core::String with the update package ID [SWS_DM_01923]. Upon the call, the following parameters are passed:

• metaInfo: Meta-information of the incoming request.
• expectedSize: Optional expected total size of the package (ara::core::Optional<uint64_t>), provided it is declared in the request.
• cancellationHandler: Signals if the current conversation is cancelled.

The method is defined as noexcept and exception-safe [SWS_DM_01923]. Errors are consequently not reported via C++ exceptions, but provided asynchronously via the future; the corresponding error codes from ASAM SOVD 1.1 or ISO 17978-3 must be used for this purpose [SWS_DM_01923].

Thread safety is conditional ("conditional"): Whether the method must be implemented thread-safely is determined via the ConcurrencyType specified in the constructor [SWS_DM_01923]. The concrete implementation might therefore require its own synchronization mechanisms depending on instantiation. Question Q-7e80e557bdd7627a (open)

use

The method ara::diag::SovdSwUpdate::StopOffer terminates the offering of the service and disables the forwarding of incoming request messages from Diagnostic Management (DM) to the software update component [SWS_DM_01925]. The call takes place via the interface from ara/diag/sovd_sw_update.h, takes no parameters, and returns no value [SWS_DM_01925]. Terminating the service offering occurs synchronously and corresponds to the conceptual disabling of diagnostic functionalities in AUTOSAR Adaptive AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”.

Error Handling and Concurrency

The function has the specification noexcept and is therefore exception-safe; error states via exceptions or error codes are not provided [SWS_DM_01925]. For the call context, the function is defined as not thread-safe ("not thread-safe") [SWS_DM_01925]. Parallel calls on the same instance must be synchronized on the application side. Interpretation: A repeated call of StopOffer in the already inactive state would likely remain without error effect, as no error handling exists. Question Q-efaccde5507eb444 (open)

Interaction

In the overall system, the function fits into the uniform scheme of the DM service lifecycle. It forms the functional counterpart to offering the service and behaves analogously to the disabling operations of other diagnostic services such as ara::diag::DownloadService [SWS_DM_00793], ara::diag::GenericUDSService [SWS_DM_00620], and ara::diag::EcuResetRequest [SWS_DM_01017].