klasse ara::shwa::ErrorHandler

De klasse dient voor de centrale ontvangst en doorzending van fouten binnen de module shwa. Instanties kunnen uitsluitend worden aangemaakt via de statische factory-methode, die het object beschikbaar stelt in een exclusieve pointer [AP_SWS_SHWA_00507]. Via de methode voor foutafhandeling worden specifieke foutcodes overgedragen en verwerkt [AP_SWS_SHWA_00508]. Omdat de foutafwikkeling noch thread-safe, noch uitzonderingsveilig is ontworpen, moet de aanroepende applicatie gelijktijdige toegangen extern coördineren.

meer ›

Context

De klasse ara::shwa::ErrorHandler stelt in de module shwa (Smart Hardware Actuator) een gespecialiseerde interface beschikbaar voor de ontvangst en gerichte doorzending van modulespecifieke fouttoestanden. Als onderdeel van het AUTOSAR Adaptive Platform ontkoppelt deze de eigenlijke hardware- en actuatorlogica van bovenliggende foutafhandelingsstrategieën. De klasse is gedeclareerd als final, waardoor afleiding is uitgesloten en een vast gedefinieerd gebruiksgedrag wordt afgedwongen.

Belangrijke interactiepartners van ara::shwa::ErrorHandler zijn:

• De gebruikende applicatie of het gebruikende platformcomponent, die de instantie beheert en in geval van een fout de afhandelingsmethode aanroept.
• De bij het aanmaken geregistreerde callback std::function<void(ara::core::ErrorCode)>, die de eigenlijke afhandelingsreactie op applicatieniveau uitvoert.
• Het modulespecifieke foutdomein, gerepresenteerd door het type ara::shwa::ShwaErrorCode.

Levenscyclus

De levenscyclus van een instantie van ara::shwa::ErrorHandler is onderworpen aan strikte beperkingen wat betreft het aanmaken, kopieerbaarheid en geheugeneigenaarschap. Een reguliere constructie via standaardconstructors is uitgesloten, aangezien de parameterloze constructor is verwijderd [AP_SWS_SHWA_00502]. Om een eenduidige identiteit en duidelijke verantwoordelijkheden te waarborgen, voorkomt de klassedefinitie elke vorm van kopiëren en verplaatsen:

• De copy constructor is verwijderd [AP_SWS_SHWA_00503].
• De copy assignment operator is verwijderd [AP_SWS_SHWA_00504].
• De move constructor is verwijderd [AP_SWS_SHWA_00505].
• De move assignment operator is verwijderd [AP_SWS_SHWA_00506].

De enige mogelijkheid tot instantiëring biedt de statische factory-methode Create [AP_SWS_SHWA_00507]. Deze neemt het functie-object std::function<void(ara::core::ErrorCode)> in ontvangst en levert het resultaat terug in de vorm van een ara::core::Result<std::unique_ptr<ErrorHandler>>. Door de std::unique_ptr wordt het exclusieve eigenaarschap van het object overgedragen aan de aanroeper. De levensduur van de instantie is daarmee direct gekoppeld aan de levensduur van de smart pointer; bij de vernietiging daarvan wordt ook de ErrorHandler vrijgegeven.

Met betrekking tot concurrency is de creatiemethode Create gespecificeerd als thread-safe (thread-safe) en uitzonderingsveilig (exception safe) [AP_SWS_SHWA_00507]. De methode voor de operationele foutafhandeling HandleError is daarentegen noch thread-safe noch uitzonderingsveilig gespecificeerd [AP_SWS_SHWA_00508]. Concurrerende toegangen tot dezelfde instantie moeten derhalve op applicatieniveau worden gecoördineerd.

Gebruikspad

Het typische verloop bij het gebruik van ara::shwa::ErrorHandler omvat de initialisatie via de factory en de daaropvolgende foutverwerking:

1. Callback-definitie: De applicatie definieert een afhandelingsroutine met de signatuur void(ara::core::ErrorCode).
2. Aanmaken: De applicatie roept de statische methode Create aan en geeft de callback-functie [AP_SWS_SHWA_00507] door. Na controle van de ara::core::Result neemt de applicatie de std::unique_ptr<ErrorHandler> over.
3. Foutsignalering: Treedt tijdens de werking een fout op, dan wordt op de instantie de methode HandleError met de bijbehorende ara::shwa::ShwaErrorCode aangeroepen [AP_SWS_SHWA_00508].
4. Doorzending: De instantie verwerkt de foutgebeurtenis; daarbij wordt de modulespecifieke foutcode intern vermoedelijk omgezet in een ara::core::ErrorCode en doorgegeven aan de geregistreerde callback-functie (interpretatie). Vraag Q-4101388d317e1f5b (open)

Sequentiediagram: typische aanroepvolgorde van instantiëring tot foutafhandeling. Bronnen: [AP_SWS_SHWA_00507], [AP_SWS_SHWA_00508]

Foutscenario's

Bij het gebruik van de klasse moeten belangrijke randvoorwaarden en randgevallen in acht worden genomen:

• Mislukken van het aanmaken van het object: De specificatie vermeldt voor de factory-methode Create geen gestandaardiseerde foutcodes [AP_SWS_SHWA_00507]. Desondanks levert de methode een ara::core::Result op, zodat eventuele foutcondities (zoals onvoldoende geheugen) via dit resultaatobject gerapporteerd zouden worden (interpretatie). Vraag Q-85c2140acfda8244 (open) Aanroepers moeten daarom de Result valideren alvorens de pointer te benaderen.
• Precondities voor de foutafhandeling: Een aanroep van HandleError vereist een intacte instantie en een geldige ara::shwa::ShwaErrorCode [AP_SWS_SHWA_00508]. Aangezien de methode geen retourwaarde heeft, kunnen fouten binnen de verwerking niet direct als statuscode aan de aanroeper worden gemeld.
• Ontbrekende uitzonderings- en thread-safety: Aangezien HandleError als not thread-safe en not exception safe is gedeclareerd [AP_SWS_SHWA_00508], moet de aanroepende omgeving waarborgen dat aanroepen sequentieel plaatsvinden en dat er binnen de foutafhandeling geen onafgehandelde excepties propageren.