klasse ara::fw::FwErrorDomain

De type-alias Errc is conform [AP_SWS_Fw_83007] gedefinieerd als alias voor de foutcode-enumeratie FwErrc (using Errc = FwErrc;). Het element is gedeclareerd binnen het bereik van de klasse ara::fw::FwErrorDomain en moet worden ingevoegd via het headerbestand ara/fw/fw_error_domain.h [AP_SWS_Fw_83007].

Wat het gebruik betreft, vertegenwoordigt Errc geen uitvoerbare functieaanroep en beschikt het daarom over parameters noch retourwaarden, noch over een synchrone of asynchrone semantiek [AP_SWS_Fw_83007]. Het stelt veeleer een uniforme identificator voor de opsomming van domeinspecifieke foutoorzaken ter beschikking. Interpretatie: De alias biedt ontwikkelaars vermoedelijk vereenvoudigde en consistente toegang tot de enumeratiewaarden van FwErrc binnen ara::fw::FwErrorDomain om fouttoestanden te typeren en op te vragen [AP_SWS_Fw_83007]. Vraag Q-bd8949830961e459 (open)

Aangezien het om een zuiver compileertijdconstruct gaat, bestaan er geen runtimebeperkingen met betrekking tot re-entrantie, thread-safety of aanroepvolgordes [AP_SWS_Fw_83007]. Specifieke foutwaarden of koppelingen met DET- of DEM-meldingen zijn in het specificatie-element niet voorgeschreven en richten zich naar de waarden van de onderliggende enumeratie [AP_SWS_Fw_83007].

De standaardconstructor FwErrorDomain() is als verwijderd gedeclareerd ([AP_SWS_Fw_83009]). Een directe instantiëring van objecten van de klasse ara::fw::FwErrorDomain via deze constructor is in applicatiecode daardoor uitgesloten. Interpretatie: De verwijdering dient er vermoedelijk voor te zorgen dat het foutdomein uitsluitend als singleton wordt beheerd. Vraag Q-54f7bc341f074e2c (open)

Voor het gebruik van het foutdomein staat de vrije functie GetFwErrorDomain() ter beschikking ([AP_SWS_Fw_83002]). Deze levert thread-safe een referentie naar het bestaande domeinobject van het type ara::core::ErrorDomain. Via deze referentie kunnen de interfaces van het domein worden gebruikt:

• Opvragen van de naam van het foutdomein via Name() ([AP_SWS_Fw_83010]).
• Vaststellen van beschrijvende teksten bij foutcodes met behulp van Message() ([AP_SWS_Fw_83011]).
• Genereren van excepties via ThrowAsException() ([AP_SWS_Fw_83012]), waarbij de alias Exception naar FwException verwijst ([AP_SWS_Fw_83008]).

De bijbehorende foutcodes worden gedefinieerd door de enumeratie FwErrc ([AP_SWS_Fw_83001]), die binnen de klasse ook via de alias Errc beschikbaar is ([AP_SWS_Fw_83007]). Geldige waarden zijn kServiceNotAvailable en kInvalidStateDependentFirewall. Ontwikkelaars moeten daarom geen eigen instanties aanmaken, maar altijd de globale referentie gebruiken.

Gebruik en semantiek

De lidfunctie Name van de klasse ara::fw::FwErrorDomain dient voor het ophalen van de identifier van het foutdomein [AP_SWS_Fw_83010]. De aanroep vindt synchroon plaats en vereist het insluiten van het headerbestand ara/fw/fw_error_domain.h [AP_SWS_Fw_83010]. De functie accepteert geen overdrachtsparameters en retourneert een pointer van het type const char *, die de naam van het domein vertegenwoordigt [AP_SWS_Fw_83010]. Vermoedelijk betreft de geretourneerde waarde een met nul afgesloten tekenreeks, waarvan de geldigheid gebonden is aan de levensduur van het foutdomein. Vraag Q-6bd465d82e79a682 (open)

Foutafhandeling

De methode is gedeclareerd met de specificatie noexcept [AP_SWS_Fw_83010]. Ze werpt bijgevolg geen excepties op en voorziet niet in specifieke foutcodes of foutretourwaarden [AP_SWS_Fw_83010].

Gelijktijdigheid en beperkingen

Volgens de specificatie is de functie geclassificeerd als thread-safe (thread-safe) [AP_SWS_Fw_83010]. Aangezien het om een constante lidfunctie (const) gaat, wijzigt de toegang de toestand van de instantie niet en kan deze veilig gelijktijdig vanuit verschillende uitvoeringscontexten worden aangeroepen [AP_SWS_Fw_83010]. Volgens de specificatie bestaan er geen bijzondere voorwaarden of volgorde-eisen [AP_SWS_Fw_83010].

Gebruik

De lidfunctie Message van de klasse ara::fw::FwErrorDomain wordt gedeclareerd via het headerbestand ara/fw/fw_error_domain.h en dient voor het synchroon ophalen van een foutmelding [AP_SWS_Fw_83011]. Bij de aanroep geeft de aanroeper een foutcode errorCode van het type CodeType mee. Als retourwaarde levert de functie een pointer van het type const char * naar de aan de foutcode toegewezen tekenreeks terug [AP_SWS_Fw_83011]. De functie overschrijft als override de overeenkomstige interface van de basisklasse [AP_SWS_Fw_83011].

Gelijktijdigheid en thread-safety

De specificatie definieert Message uitdrukkelijk als thread-safe [AP_SWS_Fw_83011]. Aanroepers kunnen de methode daarom zonder aanvullende synchronisatiemaatregelen parallel vanuit verschillende threads voor dezelfde instantie aanroepen. Door de kwalificatie als const-methode wordt de toestand van het foutdomein bij de aanroep niet gewijzigd [AP_SWS_Fw_83011].

Foutafhandeling en randvoorwaarden

Vanwege de declaratie als noexcept garandeert de methode dat er geen C++-excepties worden opgeworpen [AP_SWS_Fw_83011]. Specifieke foutcodes of foutwaarden voor niet-herleidbare codes zijn niet gedefinieerd in het element [AP_SWS_Fw_83011]. De geleverde pointer verwijst vermoedelijk naar een onveranderlijke, statisch gealloceerde tekenreeks, waardoor er voor de aanroeper geen verplichting tot geheugenbeheer bestaat. Vraag Q-2e98884ffd517367 (open)

De lidfunctie ThrowAsException van de klasse ara::fw::FwErrorDomain dient ertoe om vanuit een meegegeven foutcode errorCode een FwException te instantiëren en op te werpen [AP_SWS_Fw_83012]. De functie wordt ingesloten via het headerbestand ara/fw/fw_error_domain.h en accepteert een constante referentie naar ara::core::ErrorCode als enige parameter [AP_SWS_Fw_83012]. Ze heeft geen retourwaarde (void) en is gedeclareerd met const en override [AP_SWS_Fw_83012].

Door de specificatieclausule noexcept(false) is expliciet gedefinieerd dat er bij de methode-aanroep excepties mogen worden geworpen; de functie genereert en werpt deterministisch een FwException voor het desbetreffende foutgeval [AP_SWS_Fw_83012]. Wat betreft exceptieveiligheid is de methode ingeschaald als not exception safe [AP_SWS_Fw_83012]. Aanroepende code moet er daarom op voorbereid zijn dat de resulterende exceptie de reguliere control flow onderbreekt en passende voorzieningen voor exceptieafhandeling vereist.

Met betrekking tot gelijktijdigheid is de methode gespecificeerd als thread-safe, waardoor een gelijktijdige aanroep vanuit meerdere threads toelaatbaar is [AP_SWS_Fw_83012]. Door het trefwoord override overschrijft de methode vermoedelijk de gelijknamige interfacefunctie van een bovenliggend foutdomein [AP_SWS_Fw_83012]. Vraag Q-aae02c046243335c (open)