namespace ara::nm

With NetworkHandle, the namespace ara::nm provides interfaces for controlled access to the requested and effective network status of the AUTOSAR Adaptive Platform. Possible error situations during operation are mapped via the standardized error codes of the enumeration NmErrc, such as kServiceNotAvailable or kInvalidHandler [SWS_ANM_01111]. For structured error handling, MakeErrorCode creates error codes thread-safely for the error domain NmErrorDomain, which is referenced via GetNmDomain [SWS_ANM_01109]. Applications must consider the reachability of the Network Management service before calls in order to avoid failures during status queries.

more ›

Context

On the AUTOSAR Adaptive Platform, the namespace ara::nm provides the core interfaces for functional Network Management. The primary functional interface is formed by the class NetworkHandle, which encapsulates controlled access to both the requested and the effective network status. Via this abstraction mechanism, functional applications and platform services can monitor the current operating state of the underlying communication network and initiate status changes.

For consistent and robust error handling, ara::nm provides standardized types and utility functions that are integrated into the error architecture of AUTOSAR Adaptive. These include the error domain NmErrorDomain, the exception class NmException, and the domain-specific enumeration NmErrc [SWS_ANM_01111]. In addition, the thread-safe functions GetNmDomain [SWS_ANM_01109] and MakeErrorCode [SWS_ANM_01110] are available, which ensure instantiation-compliant and type-compliant handling of error states.

Context diagram: Interaction of application, NetworkHandle, and error architecture in ara::nm. Sources: [SWS_ANM_01109], [SWS_ANM_01110], [SWS_ANM_01111].

Usage Path

In a typical application scenario, an Adaptive Application interacts with the namespace ara::nm to control the state of the network and react to runtime events. The interaction sequence is divided into the following steps:

• Initiate status access: The application uses a NetworkHandle to query the requested or currently effective network status.
• Error detection: If the network request cannot be serviced properly, the interface signals a corresponding error event. Interpretation: In the event of outages of the underlying network services, NetworkHandle is likely to generate error codes internally based on NmErrc. Question Q-97b1567be5e28121 (open)
• Create error code: The utility function MakeErrorCode [SWS_ANM_01110] accepts a value from NmErrc [SWS_ANM_01111] as well as application-specific supplementary data (ara::core::ErrorDomain::SupportDataType) and generates a full ara::core::ErrorCode from it. The function is specified as constexpr and noexcept and guarantees complete thread safety [SWS_ANM_01110].
• Verify error domain: The calling component can retrieve a thread-safe reference to the global NmErrorDomain via GetNmDomain [SWS_ANM_01109] to check the error domain of the returned code and resolve domain-specific error descriptions.

Sequence diagram: Sequence of network status query and error resolution via ara::nm. Sources: [SWS_ANM_01109], [SWS_ANM_01110], [SWS_ANM_01111].

Error Scenarios

The module's standardized error codes are bundled in the enumeration NmErrc, which is based on ara::core::ErrorDomain::CodeType [SWS_ANM_01111]. The module distinguishes between the following error cases:

• NmErrc::kServiceNotAvailable (Code 1): This error indicates that the service required for network management is not reachable or operational at runtime [SWS_ANM_01111]. In this case, callers must react with retries or fallback strategies.
• NmErrc::kInvalidHandler (Code 2): Occurs when an invalid or unregistered handler was passed or referenced during an operation [SWS_ANM_01111]. This usually indicates a configuration or initialization error in the caller.

Preconditions for robust calls are an initialized service infrastructure as well as valid parameters when accessing NetworkHandle in order to avoid NmErrc::kServiceNotAvailable or NmErrc::kInvalidHandler [SWS_ANM_01111]. None of the core error handling functions such as MakeErrorCode [SWS_ANM_01110] and GetNmDomain [SWS_ANM_01109] throw exceptions themselves (noexcept). Interpretation: For applications that prefer an exception-based control structure, the exception class NmException is likely to act as a carrier to propagate error states in a structured manner through the call stack. Question Q-67a17c37021e8beb (open)