class ara::idsm::IdsmException

Class ara::idsm::IdsmException serves as a standardized C++ exception class for representing errors of the IdsM application programming interfaces [SWS_AIDSM_10704]. It derives from ara::core::Exception and encapsulates a specific error code for root cause analysis. Instantiation takes place via an explicit constructor with a ara::core::ErrorCode, which is guaranteed to be thread-safe and noexcept [SWS_AIDSM_10705]. The class thus enables deterministic and safe exception handling in failed IdsM sequences.

more ›

Context

Class ara::idsm::IdsmException acts as a dedicated exception class for signaling and handling errors of the application programming interfaces of the Intrusion Detection System Manager (IdsM) [SWS_AIDSM_10704]. It is defined in header ara/idsm/idsm_error_domain.h and publicly derives from base class ara::core::Exception [SWS_AIDSM_10704]. Within the AUTOSAR Adaptive Platform, the class primarily interacts with using functional clusters as well as the interfaces of the IdsM module. It provides developers with a standardized C++ exception mechanism to catch error states in a structured manner instead of propagating error messages exclusively via return values.

Lifecycle

Instantiation of ara::idsm::IdsmException is performed via an explicit constructor that requires passing a ara::core::ErrorCode [SWS_AIDSM_10705]. This constructor is declared with specifier noexcept, which guarantees that no further exceptions are raised during construction of the exception object [SWS_AIDSM_10705]. With regard to concurrency, construction is explicitly specified as thread-safe [SWS_AIDSM_10705], so that exception objects can also be safely instantiated in multithreaded execution contexts without additional synchronization.

As an exception object, IdsmException is subject to typical C++ value semantics. Creation takes place immediately upon detecting an error condition or upon unpacking an erroneous operation result. Lifetime is tied to evaluation in the associated catch block; after it terminates, the exception object is automatically destroyed by the runtime system.

Usage Path

Typical use of the class occurs in the context of synchronous IdsM service calls. An application calls a function of module idsm. If the IdsM runtime environment detects an invalid operation or an internal error, it creates a corresponding ara::core::ErrorCode and instantiates an ara::idsm::IdsmException with it [SWS_AIDSM_10705]. This exception is thrown and interrupts the regular control flow [SWS_AIDSM_10704].

The calling application catches the object specifically as ara::idsm::IdsmException or generally as ara::core::Exception. In the exception handler, the encapsulated error code can be extracted and evaluated for diagnostic logging, fallback strategies, or deterministic restarts.

Sequence diagram: Typical sequence of error handling with IdsmException during an API call. Sources: [SWS_AIDSM_10704], [SWS_AIDSM_10705]

Error Scenarios

Class ara::idsm::IdsmException serves to represent IdsM API errors and is used when function calls fail and this state is reported via the exception path [SWS_AIDSM_10704]. An essential precondition for creation is the presence of a valid ara::core::ErrorCode object that precisely describes the cause of the error [SWS_AIDSM_10705].

A secondary error state during object creation is excluded by the noexcept guarantee of the constructor [SWS_AIDSM_10705]. This avoids provoking an unexpected program abort via std::terminate in already critical error-handling paths. A postcondition of the constructor call is an initialized exception object that retains the error code unchanged for further diagnosis.