class ara::diag::SovdConfiguration

use

The method Offer of class ara::diag::SovdConfiguration serves to enable the forwarding of diagnostic requests by Diagnostic Management (DM) to the configured handler [SWS_DM_01872]. The call takes place synchronously, takes no parameters, and reports back the result via ara::core::Result<void> [SWS_DM_01872]. As long as a handler has not been offered via Offer, the DM does not forward incoming requests, which corresponds to the basic offering pattern of diagnostic interfaces (cf. [SWS_DM_01525], [SWS_DM_00809]).

Error handling

In the event of an error, a ara::core::Result with an error code of the enumeration DiagOfferErrc is returned, whereby rollback semantics apply [SWS_DM_01872]:

• DiagOfferErrc::kAlreadyOffered: Is reported if the service was already offered beforehand [SWS_DM_01872].
• DiagOfferErrc::kConfigurationMismatch: Occurs if the configuration does not match the DEXT description data [SWS_DM_01872].

Concurrency and Limitations

The operation is declared as noexcept and exception-safe (exception safe), but is specified as not thread-safe (not thread-safe) [SWS_DM_01872]. Simultaneous calls to the same instance from multiple threads must be prevented by the calling application. A repeated call after an offering has already taken place would presumably be acknowledged with an error without a state change. Question Q-f9b1a995dbb002ef (open)

use

The pure virtual method RequestGetConfiguration of class ara::diag::SovdConfiguration is called by the Diagnostic Server Instance when the SOVD method "Read Configuration" is executed for an explicitly modeled SOVD configuration ([SWS_DM_01787], AUTOSAR_AP_SWS_Diagnostics §7.3.3.5.2.1 “Configuration – Explicit Configurations”). Passed as parameters are the configuration ID of the instance to be read (configurationId), the meta-information of the request (metaInfo), and a cancellationHandler that informs about a possible cancellation of the running conversation ([SWS_DM_01870]).

The function works asynchronously and returns a ara::core::Future that provides a tuple consisting of a file read session (DataTransferReadSession) and associated configuration meta-information (SovdConfigurationMetaInfo) ([SWS_DM_01870]). The interface is declared as noexcept and specified as exception-safe ([SWS_DM_01870]).

Error Handling and Concurrency

If an error occurs during processing, no C++ error is thrown, but an applicable SOVD error code in accordance with ISO 17978-3 or ASAM SOVD 1.1 is returned via the Future ([SWS_DM_01870]).

Regarding thread safety, the "conditional" requirement applies: Whether the concrete implementation of the function must be designed to be thread-safe or non-thread-safe is decided by the ConcurrencyType passed to the constructor ([SWS_DM_01870]).

The API method ara::diag::SovdConfiguration::RequestPutConfiguration is called by the Diagnostic Server when the method "Write Configuration" is to be executed via the SOVD interface for an explicitly modeled configuration [SWS_DM_01788], [SWS_DM_01871].

Call and Parameters

The declaration is located in header ara/diag/sovd_configuration.h. The call passes the following input parameters [SWS_DM_01871]:

• configurationId: ID of the configuration instance to be written as ara::core::String.
• metaInfo: Meta-information on the incoming request (MetaInfo const &).
• cancellationHandler: Monitors the current operation and signals if communication was cancelled.

The method has asynchronous semantics and returns a ara::core::Future, which in the event of success provides a tuple consisting of a write session (DataTransferWriteSession) and associated metadata (SovdConfigurationMetaInfo) [SWS_DM_01871].

Error Handling and Concurrency

In the event of an error, the Future is resolved with an appropriate SOVD error code according to ISO 17978-3 or ASAM SOVD 1.1 [SWS_DM_01871]. The function is declared as noexcept and exception-safe (exception safe). Thread safety is conditional (conditional): Whether the concrete implementation must be designed to be thread-safe is determined by the ConcurrencyType specified in the constructor [SWS_DM_01871].

Interaction

The function forms the writing counterpart to RequestGetConfiguration, which is used for the SOVD method "Read Configuration" [SWS_DM_01787] (AUTOSAR_AP_SWS_Diagnostics §7.3.3.5.2.1 “Configuration – Explicit Configurations”).

The method StopOffer() of class ara::diag::SovdConfiguration serves to deactivate the forwarding of request messages by the Diagnostic Management Daemon (DM) to the service instance [SWS_DM_01930]. It constitutes the counterpart to offering the service and follows the uniform lifecycle pattern of diagnostic interfaces in AUTOSAR Adaptive AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”.

Usage and signature: The invocation is parameterless and synchronous via the header ara/diag/sovd_configuration.h [SWS_DM_01930]. Because the method does not return a value (void) and is declared as noexcept, it is considered exception-safe [SWS_DM_01930]. Neither error codes nor exceptions are transmitted to the caller.

Concurrency and constraints: The function is explicitly specified as not thread-safe [SWS_DM_01930]. If instances of ara::diag::SovdConfiguration are used in multithreaded environments, concurrent accesses or changes of the offer state must be synchronized by the Adaptive Application.

Interplay: The behavior corresponds to the deactivation semantics of other DM services such as ara::diag::CommunicationControl [SWS_DM_00810] or ara::diag::GenericRoutine [SWS_DM_00558]. Interpretation: After the call to StopOffer(), diagnostic requests received by the DM are likely to be discarded or answered negatively until the configuration is activated again via a corresponding offer method. Question Q-4c6212980015c119 (open)