class ara::diag::MultipleMonitor

use

The method ara::diag::MultipleMonitor::ConfigureMonitor initializes a diagnostic monitor for monitor-internal debouncing [SWS_DM_01696]. Via parameter monitorHandle, the monitor to be configured is addressed, while initMonitor registers a notifier callback for re-initializations and getFaultDetectionCounter registers a function to retrieve the current fault detection counter (FDC) [SWS_DM_01696]. Execution is synchronous and returns a ara::core::Result<void> AUTOSAR_AP_SWS_Diagnostics §8.44.2.1.3.4 “ConfigureMonitor”.

Error Handling and Concurrency

In case of error, the error result DiagErrc::kInvalidArgument is returned [SWS_DM_01696]. This is likely to occur in particular if invalid function pointers are passed or incompatible states exist in internal debouncing (interpretation). Question Q-3de0f2b0cc427ef3 (open) The operation is specified as noexcept as well as exception safe, but explicitly marked as not thread-safe [SWS_DM_01696]. Invocations on the same monitor instance must therefore be synchronized on the application side.

Sequence and Interaction

Each overload of ConfigureMonitor may only be called exactly once for a monitor; the monitor is ready for use only after this initialization step [SWS_DM_01696]. In monitor-internal debouncing, the diagnostic monitor application processes the debouncing logic autonomously and only transmits final results to the Diagnostic Management AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.5.3 “Monitor-internal debouncing”. For other debouncing mechanisms, alternative overloads are available for time-based [SWS_DM_01697], counter-based [SWS_DM_01702], or unbounced monitors [SWS_DM_01973].

use

The synchronous member function ara::diag::MultipleMonitor::ConfigureMonitor from header file ara/diag/multiple_monitor.h configures a diagnostic monitor with time-based debouncing ([SWS_DM_01697], SWS Diagnostics §8.44.2.1.3.2 “ConfigureMonitor(MonitorHandleType, InitMonitorNotifier, TimeBased)”). Upon invocation, handle monitorHandle for identifying the monitor, callback function initMonitor of type InitMonitorNotifier, and debouncing parameters defaultValues of type TimeBased are passed ([SWS_DM_01697]). The return value is ara::core::Result<void>, and the function signature is declared as noexcept ([SWS_DM_01697]).

Invocation conditions and concurrency

A monitor can only be used after completion of this initialization step ([SWS_DM_01697]). Each overloaded variant of ConfigureMonitor may only be called exactly once per monitor instance ([SWS_DM_01697]). Although the interface is exception safe (exception safe), it is not thread-safe (not thread-safe), so parallel calls on the same instance must be synchronized by the user ([SWS_DM_01697]).

Error handling

If configuration fails, the call returns an error object within ara::core::Result, in particular error code DiagErrc::kInvalidArgument ([SWS_DM_01697]).

Interaction

The method complements the alternative initialization functions for counter-based debouncing ([SWS_DM_01702]), monitor-internal debouncing ([SWS_DM_01696]), and monitors without debouncing ([SWS_DM_01973]). For time-based debounced events, the Diagnostic Manager also supports targeted freezing of the debouncing timer ([SWS_DM_00880]) and its subsequent resumption from the frozen state ([SWS_DM_00038]).

The synchronous method ConfigureMonitor of class ara::diag::MultipleMonitor serves to initialize a diagnostic monitor with counter-based debouncing ([SWS_DM_01702], AUTOSAR_AP_SWS_Diagnostics §8.44.2.1.3.1 “ConfigureMonitor”). The declaration is provided via header file ara/diag/multiple_monitor.h ([SWS_DM_01702]).

Usage and Parameters

The function accepts the following input parameters ([SWS_DM_01702]):

• monitorHandle (MonitorHandleType): Identifies the diagnostic monitor to be configured.
• initMonitor (InitMonitorNotifier): Registers a notification callback function for initializing the monitor.
• defaultValues (CounterBased): Passes default configuration values for counter-based debouncing.

As a return value, the operation provides a ara::core::Result<void> that provides information about success or failure ([SWS_DM_01702]).

Error handling

If configuration fails, an error is reported in the return value. In case of invalid arguments, error code DiagErrc::kInvalidArgument is returned ([SWS_DM_01702]). The function is declared as noexcept and guarantees exception safety (exception safe) ([SWS_DM_01702]).

Concurrency and Limitations

Each overload of ConfigureMonitor must strictly be called only exactly once for a monitor; the monitor is only usable after this initialization step ([SWS_DM_01702]). Because the operation is classified as not thread-safe (not thread-safe) ([SWS_DM_01702]), external synchronization is likely required if calls occur across thread boundaries (interpretation). Question Q-fcb809ccb021dd6d (open)

Interaction

The method is part of the configuration interface in MultipleMonitor. It complements related overloads for time-based debouncing with TimeBased ([SWS_DM_01697]), for monitor-internal debouncing with a readout function ([SWS_DM_01696]), and for monitors without any debouncing mechanism ([SWS_DM_01973]).

The synchronous method ConfigureMonitor serves to initialize a diagnostic monitor without debouncing within ara::diag::MultipleMonitor ([SWS_DM_01973], AUTOSAR_AP_SWS_Diagnostics §8.44.2.1.3.3 “ConfigureMonitor(MonitorHandleType, InitMonitorNotifier)”). It accepts as input parameters the handle of the monitor (monitorHandle) and a callback function (initMonitor) for registering an InitMonitorNotifier notification ([SWS_DM_01973]). Only after this mandatory initialization step can the monitor in question be used actively ([SWS_DM_01973]).

Regarding the call context and concurrency, the following boundary conditions apply:

• Each overload of ConfigureMonitor may be called exactly once for each individual monitor ([SWS_DM_01973]).
• The method is specified as exception safe, but classified as not thread-safe ([SWS_DM_01973]). Concurrent access to the same monitor is therefore likely to require external synchronization by the application. Question Q-2272f26f380a5a11 (open)

The function returns a ara::core::Result<void> as a result ([SWS_DM_01973]). If configuration fails, an error is returned, for example DiagErrc::kInvalidArgument ([SWS_DM_01973]). If a debouncing method is required for the diagnostic monitor, the overloaded variants for monitor-internal debouncing ([SWS_DM_01696]), time-based debouncing ([SWS_DM_01697]), or counter-based debouncing ([SWS_DM_01702]) are available instead.

The function Offer enables the forwarding of incoming diagnostic requests by the Diagnostic Management daemon (DM) to the respective handler [SWS_DM_01699]. The synchronous call takes no parameters and is specified as noexcept with exception safety (exception safe) [SWS_DM_01699].

In the event of success, the function returns an empty ara::core::Result<void> [SWS_DM_01699]. If registration for the handler was already performed successfully beforehand, the call fails and returns the error code DiagOfferErrc::kAlreadyOffered with rollback semantics [SWS_DM_01699]; this error state is anchored in the diagnostic error domain [SWS_DM_00514].

Regarding concurrency, the method is declared as not thread-safe [SWS_DM_01699]. Interpretation: Calls on the same handler instance presumably must not be made unprotected from different threads in order to avoid inconsistencies in the registration state. Question Q-95f2e0895004c73b (open)

The pattern of the Offer method corresponds to the uniform offering mechanism for diagnostic handlers in AUTOSAR Adaptive, as used analogously for generic routines [SWS_DM_00557] or UDS services [SWS_DM_00619], for example. Although the naming is based on service offering in ara::com, it is an independent diagnosis-specific implementation AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”.

The function [SWS_DM_01698] in ara::diag::MultipleMonitor is used to report status information and debouncing commands for a specific diagnostic monitor to the Diagnostic Manager (DM). The target monitor is addressed via the parameter monitorHandle, while action passes the (un)qualified test result or commands for debouncing and pre-storing.

Regarding the error behavior, calls with an invalid monitorHandle are ignored by the DM [SWS_DM_01698]. If an action is passed that is not supported by the configured debouncing algorithm, the DM triggers a violation [SWS_DM_01988]. In addition, unmet enable conditions can cause reports to be discarded (AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.4 “EnableConditions”), which corresponds to internal error codes [SWS_DM_00514].

Regarding concurrency and execution:

• The method is declared as noexcept and is therefore exception-safe [SWS_DM_01698].
• Thread safety is conditional: whether calls must be thread-safe is determined via the ConcurrencyType passed to the constructor [SWS_DM_01698].
• In conjunction with counter-based debouncing, the report kPrefailed, for instance, leads to the incrementation of the internal counter [SWS_DM_00875]. Interpretation: The debouncing mechanisms and enable conditions defined for individual monitors presumably apply identically to the multi-instance controlled via handles. Question Q-ff29529143d35ca2 (open)

The method StopOffer of class ara::diag::MultipleMonitor serves to disable the forwarding of request messages from Diagnostic Management (DM) to the handler [SWS_DM_01700]. It forms the functional counterpart to offering the interface and enables the application to stop processing incoming diagnostic requests in a targeted manner.

Usage is subject to the following characteristics and boundary conditions:

• Signature and call context: The function is declared via header ara/diag/multiple_monitor.h and has the signature void StopOffer() noexcept; [SWS_DM_01700]. It takes no parameters and returns no value. The call is executed synchronously.
• Error handling: The method is specified as noexcept and exception-safe (exception safe) [SWS_DM_01700]. It throws no exceptions and provides no specific error codes or error messages.
• Concurrency: The element is explicitly classified as not thread-safe (not thread-safe) [SWS_DM_01700]. A concurrent call on the same instance would likely need to be synchronized externally by the application. Question Q-b73ead392f8b95b2 (open)

The semantics of StopOffer follow the uniform design pattern for diagnostic handlers in AUTOSAR Adaptive, where services are controlled via Offer and StopOffer AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”. The same principle of disabling request forwarding is found in related ports such as ara::diag::Monitor::StopOffer [SWS_DM_01089] as well as generic routines [SWS_DM_00558] and UDS services [SWS_DM_00620].