klasse <RoutineInterface-Namespace>::<RoutineInterface>

De constructorfunctie [SWS_DM_00589] dient voor de instantiëring van een routine-interface (DiagnosticRoutine) via een instantie-identifier. De declaratie is gespecificeerd als noexcept en geldt als uitzonderingsveilig (exception safe) en thread-safe (thread-safe) SWS Diagnostics §8.30.2.2.1.8 “{<routine-interface-name-1>}”.

Parameters en aanroep

• instanceSpec (ara::core::InstanceSpecifier): Identifier van de specifieke service-instantie die aan een passende modelpoort is gebonden.
• concurrencyType (ara::diag::ConcurrencyType): Bepaalt of de interface concurrent respectievelijk thread-safe wordt uitgevoerd (kConcurrent) of niet thread-safe is (kNotConcurrent).

Runtime- en modelcontroles

Tijdens de constructie controleert het framework de model- en procesconfiguratie. Bij foutieve toewijzingen of meervoudig gebruik worden specifieke schendingen (Violations) gegenereerd [SWS_DM_00589]:

• InstanceSpecifierMappingIntegrityViolation: De InstanceSpecifier kan in de context van de executable niet worden omgezet of verwijst niet naar een PortPrototype.
• PortInterfaceMappingViolation: Een door DiagnosticRoutineInterface getypeerde PortPrototype wordt niet gerefereerd door een DiagnosticServiceGenericMapping.
• ProcessMappingViolation: Voor de aanwezige instantiereferentie bestaat tijdens runtime geen passend gemodelleerd proces.
• InstanceSpecifierAlreadyInUseViolation: De opgegeven InstanceSpecifier wordt binnen het huidige proces al gebruikt door een bestaande instantie.

Gebruik en semantiek

De methode Offer schakelt het Diagnostic Management (DM) vrij om inkomende diagnoseverzoeken door te sturen naar de bijbehorende routinehandler [SWS_DM_00594]. De aanroep vindt synchroon en parameterloos plaats via de getypeerde interface van de routine en werpt geen excepties (noexcept) [SWS_DM_00594]. Als retourtype dient ara::core::Result<void>, waarmee ofwel de succesvolle afronding wordt gesignaleerd ofwel in geval van een fout een foutcode wordt geretourneerd [SWS_DM_00594].

Foutafhandeling

Wordt Offer aangeroepen voor een routine-instantie die al actief beschikbaar is gesteld aan het DM, dan mislukt de registratie. In dat geval retourneert de methode de foutcode DiagOfferErrc::kAlreadyOffered met rollback-semantiek [SWS_DM_00594] (gedefinieerd met de waarde 101 in de algemene context van het diagnose-foutdomein [SWS_DM_00514]).

Gelijktijdigheid en beperkingen

De functie is weliswaar gespecificeerd als uitzonderingsveilig (exception safe), maar uitdrukkelijk gedeclareerd als niet thread-veilig (not thread-safe) [SWS_DM_00594]. Meerdere aanroepen op dezelfde instantie mogen niet onbeschermd gelijktijdig worden uitgevoerd. Aangezien de specificatie niet voorziet in gelijktijdig gebruik, vindt de registratie typisch synchroon plaats tijdens de initialisatiefase van de verwerkende applicatie. Vraag Q-6a0f15497f03ac09 (open)

Samenspel in de diagnosemodule

Het aanbiedingspatroon via Offer is in het AUTOSAR-diagnosebeheer over verschillende interfacetypen heen geüniformeerd, bijvoorbeeld bij generieke routines [SWS_DM_00557], gegevenselementen [SWS_DM_00597], DataIdentifier-elementen [SWS_DM_00599] en generieke UDS-diensten [SWS_DM_00619]. Hoewel de nomenclatuur is ontleend aan ara::com, betreft het een diagnosespecifieke functionaliteit die niet mag worden verward met de algemene servicemakelaardij AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”.

Gebruik

De interfacemethode RequestResult dient voor het beschikbaar stellen van de RoutineControl-functionaliteit voor het opvragen van routineresultaten binnen een getypeerde diagnose-interface [SWS_DM_00593]. Bij aanroep voor de verwerking van de UDS-subfunctie requestRoutineResults (Service 0x31, zie [SWS_DM_00575]) worden de geordende invoerargumenten van de bijbehorende ArgumentDataPrototype, metainformatie via metaInfo en een cancellationHandler doorgegeven AUTOSAR_AP_SWS_Diagnostics §8.30.2.2.1.2 “RequestResult”.

Via het object cancellationHandler kan de implementatie via IsCanceled actief controleren of de lopende diagnoseconversatie is geannuleerd, of via SetNotifier een notificatiefunctie registreren die bij een annulering wordt aangeroepen [SWS_DM_00593]. De uitvoering verloopt asynchroon en retourneert een ara::core::Future, die bij succes het resultaatobject conform [SWS_DM_00583] bevat [SWS_DM_00593].

Foutafhandeling

Als er bij de verwerking een fout optreedt, wordt de ara::core::Future met een bijbehorende fout opgelost. Dit omvat negatieve responscodes (NRC's conform ISO 14229-1) via ara::diag::DiagUdsNrcErrc of toepassingsspecifieke fouten via Ap ApplicationError [SWS_DM_00593].

Gelijktijdigheid en beperkingen

De methode is gedeclareerd als noexcept en geldt als exception-safe (exception safe), maar is uitdrukkelijk niet thread-safe (not thread-safe) AUTOSAR_AP_SWS_Diagnostics §8.30.2.2.1.2 “RequestResult”. Vanwege deze classificatie is de aanroepende component vermoedelijk verantwoordelijk voor passende synchronisatie bij parallelle aanroepen op dezelfde instantie. Vraag Q-aa5788303ddff2bc (open)

De zuiver virtuele functie Start in het klassenbereik <RoutineInterface-Namespace>::<RoutineInterface> dient voor het aanbieden van een RoutineControl-bewerking in de rol Start voor modelspecifieke diagnoseroutines ([SWS_DM_00591]). Deze wordt gedeclareerd via de header <RoutineInterfaceDirectoryPath>/<RoutineInterfaceShortname>.h ([SWS_DM_00591]). De aanroep geeft de geordende invoerargumenten van de betreffende routine door, diagnosecontextinformatie via metaInfo en het object cancellationHandler voor de besturing van conversatie-afbrekingen ([SWS_DM_00591]).

Via de parameter cancellationHandler kan de implementatie met cancellationHandler.IsCanceled controleren of de bijbehorende conversatie is afgebroken, waarbij in het geval van afbreken TRUE en anders FALSE wordt teruggegeven ([SWS_DM_00591]). Aanvullend kan met cancellationHandler.SetNotifier een notificatiefunctie worden geregistreerd die bij afbreken wordt geactiveerd ([SWS_DM_00591]). De asynchrone teruggave geschiedt via een ara::core::Future, die bij succes het gegenereerde resultaatobject StartOutput conform [SWS_DM_00581] beschikbaar stelt ([SWS_DM_00591]).

In geval van een fout moet de ara::core::Future worden voorzien van een passende Negative Response Code (NRC) uit ara::diag::DiagUdsNrcErrc conform ISO 14229-1 of een toepassingsspecifieke ApplicationError ([SWS_DM_00591]). De methode is gespecificeerd als noexcept en exception safe, maar geldt als not thread-safe ([SWS_DM_00591]). Interpretatie: uit de classificatie als not thread-safe volgt vermoedelijk dat gelijktijdige aanroepen van dezelfde instantie extern moeten worden gesynchroniseerd. Vraag Q-124d8076818ac2e1 (open) Terwijl deze interface modelspecifiek gegenereerde routines bedient, biedt GenericRoutine::Start de functionele tegenhanger voor generiek behandelde diagnoseroutines ([SWS_DM_00554]).

De methode Stop dient voor het beschikbaar stellen van de RoutineControl-functionaliteit voor het stoppen van een diagnoseroutine binnen een getypeerde routine-interface ([SWS_DM_00592]). Een aanroep zal typisch door de Diagnostic Management Daemon worden getriggerd bij ontvangst van een overeenkomstig UDS-diagnoseverzoek (subfunctie 0x02), analoog aan de generieke tegenhanger [SWS_DM_00555]. Vraag Q-cd626f527c6dfe92 (open)

De aanroep vindt asynchroon plaats en levert een ara::core::Future op ([SWS_DM_00592]):

• Parameters: Naast de modelspecifieke ingangsargumenten {<routine-interface-stop-in-arg-symbol-0toN>} worden meta-informatie van het verzoek (metaInfo) en een cancellationHandler overgedragen ([SWS_DM_00592]). Via de cancellationHandler kan de implementatie met IsCanceled actief een annulering opvragen of met SetNotifier een notificatie registreren voor het geval de diagnoseconversatie wordt geannuleerd.
• Retourwaarde: Bij succesvol stoppen stelt de Future een getypeerd StopOutput-object beschikbaar ([SWS_DM_00582]).

Foutafhandeling: Mislukt het stoppen, dan bevat de geretourneerde Future een toepasselijke Negative Response Code (NRC) conform ISO 14229-1 via ara::diag::DiagUdsNrcErrc of een modelspecifieke Ap ApplicationError ([SWS_DM_00592]).

Concurrency en beperkingen: De functie is gespecificeerd als exception safe, maar expliciet als not thread-safe ([SWS_DM_00592]). Meervoudige of concurrente aanroepen op dezelfde interface-instantie moeten door de aanroeper worden gecoördineerd, en de routine moet eventuele resources vrijgeven respectievelijk reageren op annuleringsverzoeken van de handler.

De methode StopOffer in de scope van <RoutineInterface> dient ertoe het doorsturen van diagnoseverzoekberichten vanuit Diagnostic Management (DM) naar de routine-implementatie te deactiveren [SWS_DM_00595]. De functie heeft geen overdrachtsparameters en geeft geen waarde terug [SWS_DM_00595].

• Gebruik en aanroepcontext: De aanroep geschiedt synchroon om de registratie van de routine-interface bij DM ongedaan te maken. De declaratie vindt plaats in het headerbestand <RoutineInterfaceDirectoryPath>/<RoutineInterfaceShortname>.h [SWS_DM_00595]. Hoewel de naamgeving is ontleend aan de service-methoden van ara::com, betreft het een diagnosespecifieke API van DM die niet mag worden verward met communicatiebeheer (AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”).
• Foutafhandeling: De bewerking is gedeclareerd als noexcept en geclassificeerd als uitzonderingsveilig (exception safe) [SWS_DM_00595]. Specifieke foutcodes of foutmeldingen zijn voor deze methode niet gedefinieerd.
• Gelijktijdigheid en beperkingen: De functie is gespecificeerd als niet-thread-safe (not thread-safe) [SWS_DM_00595]; aanroepen op dezelfde instantie vereisen daarom externe synchronisatie. Interpretatie: aanroepers moeten vermoedelijk lopende routine-uitvoeringen vóór de aanroep ordentelijk beëindigen, aangezien de standaard uitsluitend het deactiveren van het doorstuurmechanisme beschrijft. Vraag Q-b0f524c0f2d7af52 (open)
• Interactie: Het patroon voor beschikbaarstelling en afmelding komt overeen met de gestandaardiseerde aanpak in Diagnostic Management, zoals analoog voorgeschreven voor generieke routines [SWS_DM_00558], generieke UDS-diensten [SWS_DM_00620] en data-identifiers [SWS_DM_00600].