interface de service StateMachineService

L'interface de service StateMachineService est mise à disposition par State Management pour chaque machine à états configurée, afin qu'une SMControlApplication puisse demander de manière ciblée des changements d'état via la méthode RequestTransition [SWS_SM_00600], [SWS_SM_91107]. Le service est proposé immédiatement après le traitement réussi de l'étape de démarrage de la machine à états et acquitte les demandes sans sémantique Fire-and-Forget. Les demandes sont toutefois rejetées avec des erreurs spécifiques si la valeur transmise n'est pas valide, si la transition depuis l'état actuel est inadmissible ou si une session de mise à jour ou de récupération est active simultanément [SWS_SM_91107].

plus ›

Rôle et contexte système de l'interface de service

L'interface de service StateMachineService est mise à disposition par le cluster fonctionnel State Management (SM) via un port de service standardisé [SWS_SM_91021]. Conformément à la définition formelle d'interface [SWS_SM_91022], State Management instancie et propose ce service basé sur ara::com pour chaque instance configurée individuelle d'une StateMachine [SWS_SM_00600].

Une SMControlApplication agit en tant que consommateur principal de cette interface et interagit directement avec la machine à états via le service afin de demander des changements d'état SWS StateManagement §9.2.2 « StateMachine service ». Alors que les notifications relatives aux états survenus vers les applications adaptatives régulières s'effectuent principalement via l'interface de service séparée StateMachineNotification [SWS_SM_00665], StateMachineService constitue l'interface de contrôle active pour l'initiation de transitions.

Méthodes et sémantique d'appel

L'interface définit la méthode RequestTransition, qui doit être appelée par la SMControlApplication afin de provoquer un changement d'état dans la StateMachine référencée [SWS_SM_91107]. La méthode attend le paramètre d'entrée TransitionRequest de type TransitionRequestType, qui représente la valeur de transition demandée au sein de la TransitionRequestTable sous-jacente [SWS_SM_91107], SWS StateManagement §7.x « TransitionRequestTable ».

Pour RequestTransition, la propriété Fire & Forget est définie sur false [SWS_SM_91107]. L'application appelante reçoit ainsi un acquittement contraignant de la requête. Interprétation : au sein du patron proxy-skeleton de ara::com, le retour d'information devrait typiquement être fourni via un ara::core::Future ou un objet de résultat correspondant, qui se résout en cas de succès ou transmet un statut d'erreur spécifique en cas d'erreur. Question Q-41fa67738672c735 (ouverte)

Cycle de vie et dépendances d'état

Chaque service ara::com configuré pour une StateMachine à démarrer – y compris StateMachineService – doit être disponible et proposé (Offer) dès que l'étape ActionListItem « StartStateMachine » a été traitée avec succès [SWS_SM_00618]. Cela autorise la SMControlApplication à demander une transition immédiatement après la création réussie de la machine à états, même si la machine à états traite encore à ce moment-là la ActionList initiale SWS StateManagement §7.x « StateMachine service interfaces - Offer ».

L'offre du service prend fin (StopOffer) dès que le traitement d'arrêt de la machine à états respective a lieu [SWS_SM_00619]. Les appels sont en outre soumis à des préconditions fonctionnelles : si une session de mise à jour est actuellement en cours d'exécution dans le système, le déclenchement de changements d'état est en principe inadmissible [SWS_SM_91107].

Gestion des erreurs et Application Errors

Lors de l'exécution de RequestTransition, des Application Errors spécifiques peuvent survenir et être renvoyés par State Management à l'appelant [SWS_SM_91107] :

• kInvalidValue : la valeur transmise n'est associée à aucune transition dans la TransitionRequestTable [SWS_SM_91107].
• kTransitionNotAllowed : la transition d'état demandée n'est pas autorisée à partir de l'état actuel de la StateMachine [SWS_SM_91107].
• kRecoveryTransitionOngoing : la demande est rejetée car une récupération (Recovery) est actuellement en cours d'exécution [SWS_SM_91107].
• kTransitionFailed : une erreur est survenue pendant l'exécution de la transition vers l'état cible [SWS_SM_91107].
• kOperationCanceled : la demande a été interrompue car elle a été remplacée par une demande plus récente [SWS_SM_91107].
• kUpdateInProgress : l'opération est interdite car une session de mise à jour est actuellement active [SWS_SM_91107].

Diagramme de séquence : déroulement d'une demande de transition via StateMachineService avec mise à disposition, acquittement de succès et traitement des erreurs. Sources : [SWS_SM_91107], [SWS_SM_00618], SWS StateManagement §7.x « StateMachine service interfaces - Offer ».

Cette interface de service ara::com permet à une application de contrôle de solliciter des transitions auprès d'une machine d'état gérée par le cluster State Management ([SWS_SM_91021]). Le client invoque la méthode RequestTransition en transmettant une valeur cible définie dans la table des requêtes de transition. Le service est mis à disposition dès le démarrage de la machine d'état et rejette l'opération si un recouvrement ou une mise à jour est en cours ([SWS_SM_91107]).

plus ›

Rôle et contexte système de l'interface de service

L'interface de service StateMachineService est fournie par le cluster fonctionnel State Management (SM) sur la plateforme adaptative pour chaque instance configurée d'une machine d'état ([SWS_SM_00600], [SWS_SM_91021]). Elle constitue le point d'entrée normalisé permettant à une application de commande dédiée (SMControlApplication) d'interagir directement avec une StateMachine afin d'exiger des transitions d'état au sein du système ([SWS_SM_91022], SWS StateManagement §9.2.2 „StateMachine service“). Contrairement à StateMachineNotification qui s'adresse principalement aux applications adaptatives pour diffuser les changements d'état, StateMachineService remplit un rôle de pilotage strict côté serveur de service ([SWS_SM_00665]).

Méthodes et sémantique d'appel

Le service expose une unique méthode centrale nommée RequestTransition ([SWS_SM_91107]). Cette méthode prend en paramètre d'entrée TransitionRequest de type TransitionRequestType, qui spécifie la valeur ciblée dans la table de requêtes de transition (TransitionRequestTable) configurée pour la machine d'état concernée ([SWS_SM_91107], SWS StateManagement §7 „TransitionRequestTable“).

La sémantique de communication de RequestTransition n'est pas en mode « Fire & Forget » (l'attribut Fire & Forget valant explicitement false) ; l'appel renvoie donc une notification d'achèvement, vraisemblablement sous la forme asynchrone d'un ara::core::Future conformément aux conventions de l'architecture ara::com ([SWS_SM_91107]). L'application cliente peut ainsi synchroniser ses actions ou capturer immédiatement tout échec survenu lors du traitement de la requête.

Diagramme de séquence : Déroulement d'une demande de transition d'état via StateMachineService et transmission des erreurs applicatives. Sources : [SWS_SM_91107], [SWS_SM_00618].

Cycle de vie, disponibilité et dépendances d'état

La mise à disposition (offer) de l'interface StateMachineService est régie par l'exécution interne du cluster State Management : chaque instance configurée du service doit être rendue disponible via ara::com dès lors que l'élément d'action ActionListItem nommé StartStateMachine a été traité avec succès ([SWS_SM_00618]). Cette disponibilité immédiate offre à la SMControlApplication la possibilité de solliciter une nouvelle transition d'état dès la création de la machine d'état, y compris lorsque celle-ci est encore occupée à traiter sa liste d'actions initiale (SWS StateManagement §7 „StateMachine service interfaces - Offer“).

À l'inverse, le service cesse d'être offert (stop offer) dès lors que la machine d'état est arrêtée ou que son cycle d'exécution prend fin dans le cluster ([SWS_SM_00619]).

Gestion des erreurs et erreurs applicatives

L'exécution de la méthode RequestTransition peut échouer pour des raisons fonctionnelles ou contextuelles strictes, formalisées par des erreurs applicatives (Application Errors) bien définies ([SWS_SM_91107]) :

• kInvalidValue : la valeur transmise en paramètre ne correspond à aucune entrée valide de la table de transition ([SWS_SM_91107]).
• kTransitionNotAllowed : la transition demandée n'est pas autorisée depuis l'état courant de la machine d'état ([SWS_SM_91107]).
• kRecoveryTransitionOngoing : la demande est rejetée car une procédure de recouvrement d'erreur (recovery) est actuellement en cours ([SWS_SM_91107]).
• kTransitionFailed : une erreur interne est survenue pendant l'exécution de la transition vers l'état demandé ([SWS_SM_91107]).
• kOperationCanceled : la requête en cours a été écrasée et annulée par l'arrivée d'une demande plus récente ([SWS_SM_91107]).
• kUpdateInProgress : l'opération est refusée car une session de mise à jour du système est en cours de traitement ([SWS_SM_91107]).