class ara::crypto::CryptoErrorDomain

Usage and Call Context

The default constructor CryptoErrorDomain() initializes an instance of the error domain for cryptographic operations [SWS_CRYPT_19902]. It is specified as constexpr and noexcept, takes no arguments, and has no return value. Execution is synchronous and can take place at compile time. In application programs, manual instantiation is unlikely to be required, as the domain is regularly accessed via the global function GetCryptoErrorDomain() [SWS_CRYPT_19952]. Question Q-1e029d80fb7bf7d1 (open)

Error Handling and Concurrency

The creation of the object is defined as exception safe as well as thread-safe [SWS_CRYPT_19902]. Since the constructor is declared with noexcept, no errors or exceptions occur during invocation; error messages to DET or DEM do not exist for this constructor.

Interplay in the module

The created domain forms the context for cryptographic error descriptions:

• It encapsulates the error codes of the enumeration CryptoErrc [SWS_CRYPT_10099] via the type alias Errc [SWS_CRYPT_19903].
• Via the free function MakeErrorCode(), instances of ara::core::ErrorCode are created that firmly reference this domain [SWS_CRYPT_19951].
• The member functions of the domain allow querying the identifier via Name() [SWS_CRYPT_19950], text resolution via Message() [SWS_CRYPT_19953], and throwing system-specific errors via ThrowAsException() [SWS_CRYPT_19954] with the base type Exception [SWS_CRYPT_19904].

The method Message of class ara::crypto::CryptoErrorDomain translates an error code value into a readable plain text error message [SWS_CRYPT_19953]. It overrides the base method for error text resolution and is included via the header file ara/crypto/common/crypto_error_domain.h [SWS_CRYPT_19953]. In addition, the interface is functionally linked to the requirement RS_CRYPTO_02310 [SWS_CRYPT_19953].

Usage and Call Context

The call takes place synchronously as a const member function (const), whereby the method operates statelessly and the error domain object remains unchanged [SWS_CRYPT_19953]. The function expects the following input parameter [SWS_CRYPT_19953]:

• errorCode: A numeric error code identifier from the enumeration CryptoErrc, passed as type ara::core::ErrorDomain::CodeType [SWS_CRYPT_19953].

As its return value, the function returns a pointer to a constant character string (const char *) containing the descriptive message text for the respective error code [SWS_CRYPT_19953].

Concurrency and Exception Safety

Regarding execution safety and concurrency, the following constraints apply [SWS_CRYPT_19953]:

• Thread safety: The function is explicitly specified as thread-safe (thread-safe), which permits concurrent calls from different threads without external synchronization [SWS_CRYPT_19953].
• Exception safety: The method is classified as exception safe (exception safe) and is provided with the specifier noexcept, which guarantees that no C++ exceptions will be raised [SWS_CRYPT_19953].

The member function Name of class ara::crypto::CryptoErrorDomain returns the unique identifier of the error domain for cryptographic operations [SWS_CRYPT_19950]. The function is provided via the header file ara/crypto/common/crypto_error_domain.h and overrides the corresponding base interface for error domains [SWS_CRYPT_19950].

Usage and Semantics

The call takes place synchronously, without parameters, and without modifying side effects on the instance. A const char * representing the unique name of the domain is returned as the return value [SWS_CRYPT_19950]. Interpretation: The returned pointer is likely to point to a statically persisted string, since the interface does not provide for a dynamic lifecycle or transfer of memory ownership. Question Q-b7f2dab65f25b7e6 (open)

Error Handling and Concurrency

• Exception safety: The method is declared with noexcept and defined as exception safe (exception safe), so that callers do not need to catch C++ exceptions [SWS_CRYPT_19950].
• Error signaling: No specific error codes are specified for the function; name retrieval does not fail during regular operation [SWS_CRYPT_19950].
• Thread safety: The operation is specified as thread-safe and can be executed concurrently from multiple threads without external locking mechanisms [SWS_CRYPT_19950].

Interaction

Within the AUTOSAR Adaptive error handling model, the function serves to identify the error domain during the evaluation and logging of cryptographic error causes [SWS_CRYPT_19950].

The method ThrowAsException of class ara::crypto::CryptoErrorDomain serves to throw a C++ exception based on a passed error code [SWS_CRYPT_19954]. It overrides the corresponding base method and is declared with the attribute [[noreturn]], which is why calls have no return value and do not return regularly upon successful execution [SWS_CRYPT_19954].

Regarding usage and parameterization, the following specification details apply:

• Parameters: errorCode of type const ara::core::ErrorCode& is passed as an input parameter, encapsulating an error identifier from the enumeration CryptoErrc [SWS_CRYPT_19954].
• Header inclusion: The function is provided via the header file #include "ara/crypto/common/crypto_error_domain.h" [SWS_CRYPT_19954].
• Concurrency: Execution is specified as thread-safe and can thus be safely called from concurrent contexts [SWS_CRYPT_19954].

With respect to error handling and exception safety, the method is classified as not exception safe [SWS_CRYPT_19954]. A major compiler and toolchain constraint arises from [SWS_CORE_10304]: if C++ exceptions are disabled in the compiler toolchain, ThrowAsException does not participate in overload resolution and is thus not available to the caller [SWS_CRYPT_19954].