class ara::fw::FwErrorDomain

Der Typ-Alias Errc ist gemäß [AP_SWS_Fw_83007] als Alias für die Fehlercode-Enumeration FwErrc definiert (using Errc = FwErrc;). Das Element ist im Gültigkeitsbereich der Klasse ara::fw::FwErrorDomain deklariert und über die Header-Datei ara/fw/fw_error_domain.h einzubinden [AP_SWS_Fw_83007].

Hinsichtlich der Verwendung repräsentiert Errc keinen ausführbaren Funktionsaufruf und verfügt daher weder über Parameter, Rückgabewerte noch über eine synchrone oder asynchrone Semantik [AP_SWS_Fw_83007]. Er stellt vielmehr einen einheitlichen Bezeichner für die Aufzählung der domänenspezifischen Fehlerursachen bereit. Interpretation: Der Alias dürfte Entwicklern einen vereinfachten und konsistenten Zugriff auf die Enumerationswerte von FwErrc innerhalb von ara::fw::FwErrorDomain bieten, um Fehlerzustände zu typisieren und abzufragen [AP_SWS_Fw_83007]. Frage Q-bd8949830961e459 (offen)

Da es sich um ein reines Kompilierzeitkonstrukt handelt, existieren keine Laufzeitbeschränkungen bezüglich Reentranz, Thread-Sicherheit oder Aufrufreihenfolgen [AP_SWS_Fw_83007]. Spezifische Fehlerwerte oder Verknüpfungen mit DET- oder DEM-Meldungen sind im Spezifikationselement nicht vorgegeben und richten sich nach den Werten der zugrundeliegenden Enumeration [AP_SWS_Fw_83007].

Der Standardkonstruktor FwErrorDomain() ist als gelöscht deklariert ([AP_SWS_Fw_83009]). Eine direkte Instanziierung von Objekten der Klasse ara::fw::FwErrorDomain über diesen Konstruktor ist im Anwendungscode somit ausgeschlossen. Interpretation: Die Löschung dürfte sicherstellen, dass die Fehlerdomäne ausschließlich als Singleton verwaltet wird. Frage Q-54f7bc341f074e2c (offen)

Für die Verwendung der Fehlerdomäne steht die freie Funktion GetFwErrorDomain() zur Verfügung ([AP_SWS_Fw_83002]). Diese liefert thread-sicher eine Referenz auf das existierende Domänenobjekt vom Typ ara::core::ErrorDomain. Über diese Referenz können die Schnittstellen der Domäne genutzt werden:

• Abfrage des Namens der Fehlerdomäne über Name() ([AP_SWS_Fw_83010]).
• Ermittlung von beschreibenden Texten zu Fehlercodes mittels Message() ([AP_SWS_Fw_83011]).
• Auslösen von Ausnahmen über ThrowAsException() ([AP_SWS_Fw_83012]), wobei der Alias Exception auf FwException verweist ([AP_SWS_Fw_83008]).

Die zugehörigen Fehlercodes werden durch die Enumeration FwErrc definiert ([AP_SWS_Fw_83001]), die innerhalb der Klasse auch über den Alias Errc bereitsteht ([AP_SWS_Fw_83007]). Gültige Werte sind kServiceNotAvailable sowie kInvalidStateDependentFirewall. Entwickler sollten daher keine eigenen Instanzen erzeugen, sondern stets die globale Referenz nutzen.

Verwendung und Semantik

Die Elementfunktion Name der Klasse ara::fw::FwErrorDomain dient dem Abrufen des Bezeichners der Fehlerdomäne [AP_SWS_Fw_83010]. Der Aufruf erfolgt synchron und erfordert das Einbinden der Header-Datei ara/fw/fw_error_domain.h [AP_SWS_Fw_83010]. Die Funktion nimmt keine Übergabeparameter entgegen und liefert einen Zeiger vom Typ const char * zurück, der den Namen der Domäne repräsentiert [AP_SWS_Fw_83010]. Es dürfte sich bei der Rückgabe um eine nullterminierte Zeichenkette handeln, deren Gültigkeit an die Lebensdauer der Fehlerdomäne gebunden ist. Frage Q-6bd465d82e79a682 (offen)

Fehlerbehandlung

Die Methode ist mit dem Bezeichner noexcept deklariert [AP_SWS_Fw_83010]. Sie löst folglich keine Exceptions aus und sieht keine spezifischen Fehlercodes oder Fehlerrückgaben vor [AP_SWS_Fw_83010].

Nebenläufigkeit und Einschränkungen

Gemäß Spezifikation ist die Funktion als threadsicher (thread-safe) klassifiziert [AP_SWS_Fw_83010]. Da es sich um eine konstante Elementfunktion (const) handelt, verändert der Zugriff den Zustand der Instanz nicht und kann sicher nebenläufig aus verschiedenen Ausführungskontexten heraus aufgerufen werden [AP_SWS_Fw_83010]. Besondere Vorbedingungen oder Reihenfolgeanforderungen bestehen laut Spezifikation nicht [AP_SWS_Fw_83010].

Verwendung

Die Elementfunktion Message der Klasse ara::fw::FwErrorDomain wird über die Header-Datei ara/fw/fw_error_domain.h deklariert und dient dem synchronen Abruf einer Fehlermeldung [AP_SWS_Fw_83011]. Beim Aufruf übergibt der Aufrufer einen Fehlercode errorCode des Typs CodeType. Als Rückgabewert liefert die Funktion einen Zeiger vom Typ const char * auf die dem Fehlercode zugeordnete Zeichenkette zurück [AP_SWS_Fw_83011]. Die Funktion überschreibt als override die entsprechende Schnittstelle der Basisklasse [AP_SWS_Fw_83011].

Nebenläufigkeit und Thread-Sicherheit

Die Spezifikation definiert Message ausdrücklich als thread-safe [AP_SWS_Fw_83011]. Aufrufer können die Methode daher ohne zusätzliche Synchronisationsmaßnahmen parallel aus unterschiedlichen Threads heraus für dieselbe Instanz aufrufen. Durch die Qualifizierung als const-Methode wird der Zustand der Fehlerdomäne beim Aufruf nicht verändert [AP_SWS_Fw_83011].

Fehlerbehandlung und Randbedingungen

Aufgrund der Deklaration als noexcept garantiert die Methode, dass keine C++-Ausnahmen ausgelöst werden [AP_SWS_Fw_83011]. Spezifische Fehlercodes oder Fehlerwerte für nicht auflösbare Codes sind im Element nicht definiert [AP_SWS_Fw_83011]. Der gelieferte Zeiger dürfte vermutlich auf eine unveränderliche, statisch allozierte Zeichenkette verweisen, womit für den Aufrufer keine Pflicht zur Speicherverwaltung besteht. Frage Q-2e98884ffd517367 (offen)

Die Elementfunktion ThrowAsException der Klasse ara::fw::FwErrorDomain dient dazu, aus einem übergebenen Fehlercode errorCode eine FwException zu instanziieren und auszulösen [AP_SWS_Fw_83012]. Die Funktion wird über die Header-Datei ara/fw/fw_error_domain.h eingebunden und nimmt einen konstanten Verweis auf ara::core::ErrorCode als einzigen Parameter entgegen [AP_SWS_Fw_83012]. Sie besitzt keinen Rückgabewert (void) und ist mit const sowie override deklariert [AP_SWS_Fw_83012].

Durch die Spezifikationsklausel noexcept(false) ist explizit definiert, dass beim Methodenaufruf Ausnahmen geworfen werden dürfen; die Funktion erzeugt und wirft deterministisch eine FwException für den entsprechenden Fehlerfall [AP_SWS_Fw_83012]. Hinsichtlich der Exception-Sicherheit ist die Methode als not exception safe eingestuft [AP_SWS_Fw_83012]. Aufrufender Code muss daher darauf vorbereitet sein, dass die resultierende Ausnahme den regulären Kontrollfluss unterbricht und entsprechende Vorkehrungen zur Ausnahmebehandlung erfordert.

In Bezug auf Nebenläufigkeit ist die Methode als thread-safe spezifiziert, wodurch ein gleichzeitiger Aufruf aus mehreren Threads zulässig ist [AP_SWS_Fw_83012]. Durch das Schlüsselwort override überschreibt die Methode vermutlich die gleichnamige Schnittstellenfunktion einer übergeordneten Fehlerdomäne [AP_SWS_Fw_83012]. Frage Q-aae02c046243335c (offen)