class ara::tsync::TsyncErrorDomain

use

The method Message of class ara::tsync::TsyncErrorDomain serves to synchronously retrieve a textual error description for a passed error code [SWS_TS_00907]. It is provided via the header #include "ara/tsync/tsync_error_domain.h". As input parameter, the function takes errorCode of type CodeType and returns a constant string pointer (const char *) to the corresponding message [SWS_TS_00907].

Error Handling and Concurrency

The interface guarantees complete exception safety (exception safe) and is declared as noexcept, which is why the call is guaranteed to proceed without C++ exceptions [SWS_TS_00907]. Furthermore, the function is specified as thread-safe and can safely be called concurrently from multiple threads [SWS_TS_00907]. Interpretation: The returned const char * is likely to point to immutable, static memory, so that no manual memory deallocation arises for the caller. Question Q-933f88e4fde03016 (open)

Interaction

As an overridden method (override), the function fits into the unified error model of AUTOSAR Adaptive [SWS_TS_00907]. In a similar manner, apext::tsync::TsyncFvmErrorDomain from the header #include "apext/tsync/fvm_error_domain.h" also implements an identically named Message function for resolving domain-specific error messages under the same guarantees regarding thread safety and exception safety [SWS_TS_14210].

Usage and Call Context

The member function Name() of class ara::tsync::TsyncErrorDomain returns a pointer to a constant character string that identifies the error domain [SWS_TS_00906]. The function requires the header file ara/tsync/tsync_error_domain.h, is called synchronously, and takes no parameters [SWS_TS_00906]. The type const char * is passed as the return value [SWS_TS_00906]. Interpretation: Since the return value is defined as a string constant, the memory area is likely to have static lifetime and must neither be modified nor freed by the caller. Question Q-f9cb9d4986d49755 (open)

Error Handling and Concurrency

The method is declared as noexcept and specified as exception-safe (\"exception safe\"), which guarantees that no exceptions are thrown [SWS_TS_00906]. Specific error codes, DET, or DEM messages do not exist for this call. Regarding concurrency behavior, the function is classified as thread-safe (\"thread-safe\") [SWS_TS_00906]. Consequently, the call can take place in parallel from multiple execution contexts without external synchronization.

Interaction and related requirements

With the designation override, the function overrides the standardized interface for domain naming in the module ts [SWS_TS_00906]. The same design pattern is implemented by the related error domain apext::tsync::TsyncFvmErrorDomain, whose function Name() from apext/tsync/fvm_error_domain.h likewise returns the associated identifier synchronously, thread-safely, and exception-safely [SWS_TS_14209].

use

From the passed parameter errorCode, the member function ThrowAsException of class ara::tsync::TsyncErrorDomain synchronously creates a new instance of TsyncException and throws it as a C++ exception ([SWS_TS_00908]). The function has no return value (void) and is provided via the header ara/tsync/tsync_error_domain.h.

Error Handling and Exception Safety

The method is declared with noexcept(false) and specified as not exception safe ([SWS_TS_00908]). Interpretation: This classification is probably based on the fact that the function throws an exception by design and thus leaves the regular control flow. Question Q-cde17219378516c1 (open) Specific error codes are not returned, but rather transported via the thrown exception object.

Concurrency and Limitations

The function is classified as thread-safe ([SWS_TS_00908]) and can thus be called safely from concurrent threads. An essential restriction concerns the toolchain: According to [SWS_CORE_10304], ThrowAsException does not participate in overload resolution if C++ exceptions are disabled in the compiler toolchain.

Interaction

The behavior corresponds to the uniform pattern for error domains in AUTOSAR Adaptive. A direct counterpart is found in apext::tsync::TsyncFvmErrorDomain ([SWS_TS_14211]), where ThrowAsException throws a apext::tsync::TsyncFvmException and is likewise subject to the specifications from [SWS_CORE_10304].

use

The parameterless default constructor creates a new instance of the error domain ara::tsync::TsyncErrorDomain [SWS_TS_00905]. The declaration is provided via the header #include "ara/tsync/tsync_error_domain.h" [SWS_TS_00905]. Execution occurs synchronously, takes no input parameters, and throws no C++ exceptions (noexcept) [SWS_TS_00905].

Interaction and Error Handling

The created error domain serves to encapsulate and interpret synchronization-specific error states in the Time Synchronization module. Within the domain, the type aliases Errc for the error code enumeration TsyncErrc [SWS_TS_01266] and Exception for the exception base class TsyncException [SWS_TS_01267] are available. Instances of the class provide a constant name string of the domain via the method Name [SWS_TS_00906] and the textual error description for a specified error code via Message [SWS_TS_00907]. In addition, ThrowAsException allows creating and throwing a TsyncException based on a ara::core::ErrorCode, provided C++ exceptions are enabled in the compiler [SWS_TS_00908]. In typical application scenarios, custom instantiation via the constructor is likely to be rarely required, since a reference to the global instance object is already available via GetTsyncErrorDomain [SWS_TS_00909]. Question Q-8ebaff4e52125b78 (open)

Concurrency and Limitations

The call is specified as exception-safe (exception safe) and thread-safe (thread-safe) [SWS_TS_00905]. The instantiation can thus take place across threads without additional synchronization measures.