class ara::diag::SovdBulkData

use

The virtual function DeleteAllBulkData of class ara::diag::SovdBulkData is called to execute the SOVD method "Delete All Bulk Data Defined by Category" [SWS_DM_01855]. The interface definition is stored in header ara/diag/sovd_bulk_data.h AUTOSAR_AP_SWS_Diagnostics §8.53.1.1.3.1 “DeleteAllBulkData”.

The method accepts the following input parameters:

• bulkDataCategory (ara::core::String): Identifies the bulk data category from which all instances are to be deleted [SWS_DM_01855].
• metaInfo (MetaInfo const &): Passes context-related meta-information of the current request [SWS_DM_01855].
• cancellationHandler (CancellationHandler): Informs about the premature cancellation of the running conversation [SWS_DM_01855].

The result is provided asynchronously via a ara::core::Future<DeleteByCategoryResult> [SWS_DM_01855]. Interpretation: Since cleaning up entire bulk data categories can be time-consuming, the application would likely check the passed cancellationHandler cyclically in order to react immediately to any cancellations. Question Q-59d2847dbe42f240 (open)

Error Handling and Exception Safety

The method is declared as noexcept and exception-safe (exception safe) [SWS_DM_01855]. If deletion fails, an appropriate SOVD error code in accordance with ISO 17978-3 or ASAM SOVD 1.1 must be transmitted in ara::core::Future [SWS_DM_01855].

Concurrency

Thread safety is conditional (conditional): Whether the implementation must be designed to be thread-safe or non-thread-safe is determined via the ConcurrencyType passed to the constructor [SWS_DM_01855].

The method DeleteSpecificBulkData of interface ara::diag::SovdBulkData is called to delete a specific bulk data resource within the scope of the SOVD method "Delete Specific Bulk Data Resource" ([SWS_DM_01856], AUTOSAR_AP_SWS_Diagnostics §8.53.1.1.3.2 “DeleteSpecificBulkData”). The declaration is made via the header file #include "ara/diag/sovd_bulk_data.h".

Upon the call, the following parameters are passed to the service implementation:

• bulkDataCategory: Identifies the category of the bulk data instance to be deleted.
• bulkDataId: Unique identifier of the specific bulk data resource to be removed.
• metaInfo: Passes additional meta-information of the incoming SOVD request.
• cancellationHandler: Monitors the status of the operation and informs if the running conversation is cancelled.

The operation works asynchronously and returns a ara::core::Future<void> ([SWS_DM_01856]). In the event of successful deletion, the future is resolved without a value. If an error occurs during processing, the future must be completed with an applicable SOVD error code according to ISO 17978-3 or ASAM SOVD 1.1 ([SWS_DM_01856]).

Regarding concurrency, the method is declared as noexcept and must be implemented exception safe. The required thread safety is conditional: Whether the function must be executed thread-safely is determined by the ConcurrencyType passed in the constructor ([SWS_DM_01856]). The implementation would likely need to ensure that any cleanup work is carried out reliably even upon early notification by the cancellationHandler. Question Q-2336b99585d8bf3c (open)

The method ara::diag::SovdBulkData::Offer serves to enable the forwarding of diagnostic requests: By calling it, Diagnostic Management (DM) is authorized and enabled to transmit incoming request messages for bulk data to the corresponding handler ([SWS_DM_01857]).

Usage and semantics: The function has the signature ara::core::Result<void> Offer() noexcept, takes no parameters, and, being exception-safe (exception safe), guarantees that no C++ exceptions are thrown ([SWS_DM_01857]). Interpretation: Since the result is returned directly as ara::core::Result<void> and not via an asynchronous future object, the registration process is likely executed synchronously. Question Q-9933248363829009 (open)

Error handling: If registration fails, the function returns a ara::core::Result with an appropriate error code from the error domain ([SWS_DM_01857]):

• DiagOfferErrc::kAlreadyOffered: The service was already offered for this handler beforehand ([SWS_DM_01857]; see also [SWS_DM_00514] and [SWS_DM_00560]).
• DiagOfferErrc::kConfigurationMismatch: The configuration does not match the diagnostic specification data (DEXT) ([SWS_DM_01857]).

Both errors have rollback semantics, so that no incomplete registration remains in the event of an error ([SWS_DM_01857]).

Concurrency and interaction: The method is explicitly specified as not thread-safe (not thread-safe) ([SWS_DM_01857]). Parallel calls on the same instance must therefore be prevented on the application side. The activation pattern is shared by SovdBulkData with other DM services such as GenericRoutine ([SWS_DM_00557]), GenericUDSService ([SWS_DM_00619]), or CommunicationControl ([SWS_DM_00809]), which are likewise only enabled for request processing by Offer.

The virtual method RequestBulkDataDownload of class ara::diag::SovdBulkData is called for the SOVD operation "Download Bulk Data" to request the download of bulk data [SWS_DM_01873]. The declaration is made via the header file ara/diag/sovd_bulk_data.h AUTOSAR_AP_SWS_Diagnostics §8.53.1.1.3.5 “RequestBulkDataDownload”.

As input parameters, the method takes the category of the bulk data (bulkDataCategory), its identifier (bulkDataId), a list of accepted HTTP headers (acceptHeader), request meta-information (metaInfo), and a cancellationHandler that informs about a cancellation of the current conversation [SWS_DM_01873]. Processing takes place asynchronously via a ara::core::Future. This returns a ara::core::Variant, which encapsulates either a read session as a tuple of DataTransferReadSession and BulkDataMetaDataDescriptor or an HTTP redirect (HttpRedirect) [SWS_DM_01873].

In the event of an error, an appropriate SOVD error code according to ISO 17978-3 or ASAM SOVD 1.1 is transmitted via the future by means of DiagSovdErrc [SWS_DM_01873]. The function is declared as noexcept and is considered exception-safe (exception safe) [SWS_DM_01873].

Regarding concurrency, thread safety is conditional ("conditional"): Whether the method must be implemented thread-safely is determined by the ConcurrencyType passed in the constructor [SWS_DM_01873]. Interpretation: If a cancellation is signaled via the cancellationHandler, the implementation would likely terminate ongoing preparations for the data transfer prematurely. Question Q-1c74be85e810ac8e (open)

Usage and Call Context

The pure virtual method RequestBulkDataUpload of class ara::diag::SovdBulkData is called by the diagnostic server instance as soon as a client requests the SOVD method "Upload Bulk Data" [SWS_DM_01793]. It serves to prepare a bulk data upload for a specific data category AUTOSAR AP SWS Diagnostics §8.53.1.1.3.6 “RequestBulkDataUpload”.

Upon call, the following parameters are passed to the function [SWS_DM_01854]:

• bulkDataCategory: Designates the bulk data category for which a new instance is to be uploaded.
• bulkDataMetaData: Descriptor of type BulkDataMetaDataDescriptor prefilled with the available information of the HTTP headers of the SOVD POST request.
• metaInfo: Additional meta-information of the request.
• cancellationHandler: Signals if the current conversation is cancelled.

The return is asynchronous via a ara::core::Future, which provides a tuple consisting of a write session DataTransferWriteSession and the associated BulkDataMetaDataDescriptor upon successful execution [SWS_DM_01854].

Error Handling and Concurrency

If an error occurs during preparation or execution, an applicable SOVD error code in accordance with ISO 17978-3 or ASAM SOVD 1.1 is returned via the Future [SWS_DM_01854]. The function is declared with noexcept and must be exception-safe (exception safe) [SWS_DM_01854].

Thread safety is conditional: whether the method must be implemented thread-safely depends on the ConcurrencyType passed to the constructor of the instance [SWS_DM_01854]. Interpretation: It is likely within the responsibility of the application implementation to monitor the passed cancellationHandler during the write process in order to promptly release allocated resources of the write session in case of connection terminations. Question Q-cc88a00d48a35d61 (open)

The method ara::diag::SovdBulkData::StopOffer from header ara/diag/sovd_bulk_data.h disables the forwarding of incoming request messages from Diagnostic Management (DM) to the respective object [SWS_DM_01858]. It takes no parameters and has no return value [SWS_DM_01858].

Regarding execution and safety, the following conditions apply:

• Error handling: The function is declared as noexcept and classified as exception-safe (exception safe) [SWS_DM_01858]. Neither exceptions are thrown nor error codes returned [SWS_DM_01858].
• Concurrency: The operation is specified as not thread-safe (not thread-safe) [SWS_DM_01858]. Calls must not be executed unprotected during parallel use of the same instance.
• Interaction and lifecycle: The call serves for deregistration or terminating service readiness. After the call, incoming requests from the DM should presumably no longer be passed on to the application. This principle corresponds to the standardized offering pattern for diagnostic handlers in Adaptive AUTOSAR, as defined analogously for functional classes such as [SWS_DM_00558] (GenericRoutine), [SWS_DM_00793] (DownloadService), or [SWS_DM_01017] (EcuResetRequest) (cf. also AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”). Question Q-23639406c07ca7c1 (open)