klasse ara::phm::PhmErrorDomain

De elementfunctie Message van de klasse ara::phm::PhmErrorDomain levert bij een doorgegeven foutnummer errorCode van het type CodeType een tekstuele beschrijving van de bijbehorende foutmelding als const char * op [SWS_PHM_01249]. De functie wordt beschikbaar gesteld via het headerbestand ara/phm/phm_error_domain.h en overschrijft als virtuele methode (override) het standaard interfacegedrag voor foutresolutie [SWS_PHM_01249].

Voor de aanroepcontext en de uitvoeringssemantiek gelden de volgende bepalingen:

• Synchrone uitvoering en afhandeling van uitzonderingen: De aanroep geschiedt synchroon en is gedeclareerd als noexcept; bovendien is de methode gespecificeerd als exception safe, zodat er tijdens de uitvoering geen uitzonderingen worden geworpen [SWS_PHM_01249].
• Concurrente uitvoering: De functie is expliciet gedeclareerd als thread-safe en kan zonder aanvullende externe synchronisatie veilig vanuit concurrente threads worden aangeroepen [SWS_PHM_01249].
• Geheugenbeheer: Interpretatie: De geretourneerde tekenreeks-pointer zal vermoedelijk verwijzen naar een statische stringliteral, waardoor de aanroeper het geheugen niet hoeft vrij te geven. Vraag Q-dcdc593e3f9ded45 (open)

De methode dient in Platform Health Management (PHM) om numerieke foutcodes van de PhmErrorDomain voor logging- of diagnosedoeleinden te vertalen naar menselijk leesbare tekenreeksen [SWS_PHM_01249].

De elementfunctie Name van de klasse ara::phm::PhmErrorDomain levert de naam van het foutdomein als tekenreeks op ([SWS_PHM_01248]). De declaratie is opgenomen in de module phm via het headerbestand #include "ara/phm/phm_error_domain.h" ([SWS_PHM_01248]).

Voor het praktische gebruik en het runtimegedrag gelden de volgende richtlijnen:

• Gebruik en signatuur: De methode heeft de signatuur const char * Name () const noexcept override; ([SWS_PHM_01248]). Ze wordt synchroon uitgevoerd en verwacht geen invoerparameters. De geretourneerde pointer van het type const char * voldoet aan de specificaties voor ara::phm::PhmErrorDomain uit [SWS_CORE_90023].
• Foutafhandeling: De functie is gedeclareerd als noexcept en heeft het uitzonderingsveiligheidsniveau exception safe ([SWS_PHM_01248]). Ze genereert tijdens runtime geen uitzonderingen en produceert geen foutmeldingen.
• Concurrente uitvoering: De methode is gespecificeerd als thread-safe (thread-safe) ([SWS_PHM_01248]). Parallelle aanroepen via dezelfde of verschillende instanties kunnen zonder aanvullende synchronisatiemechanismen worden uitgevoerd.

In de architecturale interactie overschrijft de operatie het virtueel opvragen van de naam van de bovenliggende foutdomeininterface en levert de specifieke naam voor ara::phm::PhmErrorDomain conform [SWS_CORE_90023] ([SWS_PHM_01248]).

De standaardconstructor PhmErrorDomain() dient voor het creëren van een instantie van het foutdomein ara::phm::PhmErrorDomain [SWS_PHM_01247]. De aanroep geschiedt synchroon en zonder invoerparameters via de header ara/phm/phm_error_domain.h [SWS_PHM_01247].

Wat betreft de uitvoeringsveiligheid is de constructie gespecificeerd als exception safe en gedeclareerd met noexcept, zodat er geen uitzonderingen worden gegenereerd [SWS_PHM_01247]. Bovendien is de instantiëring thread-safe [SWS_PHM_01247].

Het gecreëerde domein vormt de context voor PHM-fouten, stelt elementfuncties zoals Name() [SWS_PHM_01248], Message() [SWS_PHM_01249] en ThrowAsException() [SWS_PHM_01250] beschikbaar en bevat de type-aliassen Errc [SWS_PHM_01245] en Exception [SWS_PHM_01246]. Voor reguliere toegang tot het foutdomein is de vrije functie GetPhmDomain() beschikbaar, die een referentie naar het globale object retourneert [SWS_PHM_01251]. Een afzonderlijke handmatige instantiëring via de constructor zal daarom in applicatiecode doorgaans niet vereist zijn. Vraag Q-63be3bb534ef1fa9 (open)

Gebruik

De lidfunctie ThrowAsException is een methode van de foutdomeinklasse ara::phm::PhmErrorDomain en wordt beschikbaar gesteld via het headerbestand ara/phm/phm_error_domain.h ([SWS_PHM_01250]). Het doel ervan is om synchroon de C++-uitzondering te triggeren die is gekoppeld aan de overgedragen foutcode ([SWS_PHM_01250]). De functie accepteert hiervoor als invoerparameter een referentie naar het foutobject errorCode van het type const ara::core::ErrorCode & ([SWS_PHM_01250]). Omdat de controlestroom bij foutieve uitvoering wordt voortgezet via de uitzondering, heeft de methode geen retourwaarde (void) ([SWS_PHM_01250]).

Gelijktijdigheid en uitvoeringsveiligheid

Wat betreft het gedrag bij parallelle aanroepen is ThrowAsException gedeclareerd als thread-safe ([SWS_PHM_01250]). Ze kan zodoende veilig en gelijktijdig vanuit meerdere threads worden aangeroepen. Wat betreft de uitzonderingsveiligheid is de interface in de specificatie daarentegen uitdrukkelijk geclassificeerd als „not exception safe” ([SWS_PHM_01250]).

Compilerbeperkingen en overload resolution

Een essentiële randvoorwaarde voor het gebruik wordt gedefinieerd door [SWS_CORE_10304]: als C++-exceptions in de gebruikte compiler-toolchain zijn gedeactiveerd, neemt ThrowAsException niet deel aan de overload resolution ([SWS_PHM_01250]). Bij software-builds voor platforms of configuraties zonder ondersteuning voor uitzonderingen staat de functie de compiler dus niet ter beschikking voor overload resolution ([SWS_PHM_01250]).