service-interface StateMachineService

De service-interface StateMachineService wordt door State Management voor elke geconfigureerde toestandsmachine beschikbaar gesteld, zodat een SMControlApplication via de methode RequestTransition gericht toestandswisselingen kan aanvragen [SWS_SM_00600], [SWS_SM_91107]. De service wordt onmiddellijk na het succesvol doorlopen van de startstap van de toestandsmachine aangeboden en bevestigt verzoeken zonder fire-and-forget-semantiek. Verzoeken worden echter afgewezen met specifieke fouten als de overgedragen waarde ongeldig is, de overgang vanuit de huidige toestand niet is toegestaan of er gelijktijdig een update- of recovery-sessie actief is [SWS_SM_91107].

meer ›

Rol en systeemcontext van de service-interface

De service-interface StateMachineService wordt door het functionele cluster State Management (SM) beschikbaar gesteld via een gestandaardiseerde servicepoort [SWS_SM_91021]. Conform de formele interfacedefinitie [SWS_SM_91022] instantieert en biedt State Management deze op ara::com gebaseerde service aan voor elke afzonderlijk geconfigureerde instantie van een StateMachine [SWS_SM_00600].

Als primaire consumer van deze interface fungeert een SMControlApplication, die via de service direct met de toestandsmachine interacteert om toestandswisselingen aan te vragen SWS StateManagement §9.2.2 “StateMachine service”. Terwijl notificaties over ingetreden toestanden naar reguliere adaptieve applicaties primair verlopen via de afzonderlijke service-interface StateMachineNotification [SWS_SM_00665], vormt StateMachineService de actieve controle-interface voor het initiëren van transities.

Methoden en aanroepsemantiek

De interface definieert de methode RequestTransition, die moet worden aangeroepen door de SMControlApplication om een toestandsverandering in de gerefereerde StateMachine teweeg te brengen [SWS_SM_91107]. De methode verwacht de invoerparameter TransitionRequest van het type TransitionRequestType, die de vereiste overgangswaarde binnen de onderliggende TransitionRequestTable representeert [SWS_SM_91107], SWS StateManagement §7.x “TransitionRequestTable”.

Voor RequestTransition is de eigenschap Fire & Forget ingesteld op false [SWS_SM_91107]. De aanroepende applicatie ontvangt zodoende een bindende bevestiging van het verzoek. Interpretatie: binnen het ara::com-proxy-skeleton-patroon zal de terugkoppeling typisch worden geleverd via een ara::core::Future resp. een bijbehorend resultaatobject dat in geval van succes resolveert of in geval van een fout een specifieke foutstatus doorgeeft. Vraag Q-41fa67738672c735 (open)

Levenscyclus en toestandsafhankelijkheden

Elke voor een te starten StateMachine geconfigureerde ara::com-service – met inbegrip van StateMachineService – moet beschikbaar zijn en worden aangeboden (Offer) zodra het ActionListItem „StartStateMachine” met succes is verwerkt [SWS_SM_00618]. Dit stelt de SMControlApplication in staat om direct na de succesvolle creatie van de toestandsmachine een transitie aan te vragen, zelfs wanneer de toestandsmachine op dat moment nog de initiële ActionList verwerkt SWS StateManagement §7.x “StateMachine service interfaces - Offer”.

Het aanbieden van de service wordt beëindigd (StopOffer) zodra de verwerking voor het stoppen van de desbetreffende toestandsmachine plaatsvindt [SWS_SM_00619]. Oproepen zijn bovendien onderworpen aan functionele randvoorwaarden: als er in het systeem momenteel een updatesessie actief is, is het initiëren van toestandswisselingen principieel niet toegestaan [SWS_SM_91107].

Foutafhandeling en Application Errors

Bij de uitvoering van RequestTransition kunnen specifieke Application Errors optreden die door State Management aan de oproeper worden teruggemeld [SWS_SM_91107]:

• kInvalidValue: De doorgegeven waarde is in de TransitionRequestTable aan geen enkele transitie toegewezen [SWS_SM_91107].
• kTransitionNotAllowed: De aangevraagde toestandsovergang is, uitgaande van de huidige toestand van de StateMachine, niet toegestaan [SWS_SM_91107].
• kRecoveryTransitionOngoing: De aanvraag wordt verworpen omdat er momenteel een herstelprocedure (Recovery) wordt uitgevoerd [SWS_SM_91107].
• kTransitionFailed: Tijdens de uitvoering van de overgang naar de doeltoestand is een fout opgetreden [SWS_SM_91107].
• kOperationCanceled: Het verzoek is afgebroken omdat het is vervangen door een nieuwere aanvraag [SWS_SM_91107].
• kUpdateInProgress: De bewerking is verboden omdat er momenteel een updatesessie actief is [SWS_SM_91107].

Sequentiediagram: verloop van een transitieaanvraag via StateMachineService met beschikbaarstelling, succesbevestiging en foutafhandeling. Bronnen: [SWS_SM_91107], [SWS_SM_00618], SWS StateManagement §7.x “StateMachine service interfaces - Offer”.