classe ara::diag::ReleaseHandler

La classe ara::diag::ReleaseHandler gère un état partagé permettant de déterminer si un traitement de diagnostic en cours peut être interrompu et si une ressource partagée peut être libérée [SWS_DM_01340]. Les applications peuvent enregistrer une fonction de notification via SetNotifier et vérifier de manière synchrone au moyen de MayRelease si la ressource n'est plus utilisée [SWS_DM_01536]. La construction par défaut et les opérations de copie étant interdites, l'instance est transmise par sémantique de déplacement, les modifications et la destruction n'étant pas thread-safe.

plus ›

Contexte

La classe ara::diag::ReleaseHandler encapsule, au sein du module de diagnostic d'AUTOSAR Adaptive, un état partagé (Shared State) indiquant si un traitement en cours doit être annulé ou si une ressource partagée doit être libérée [SWS_DM_01340], AUTOSAR_AP_SWS_Diagnostics §8.23 « Header: ara/diag/release_handler.h ». Dans l'architecture de diagnostic, elle sert d'interface de synchronisation et de notification entre l'environnement d'exécution de diagnostic d'AUTOSAR et les gestionnaires de diagnostic spécifiques à l'application. Cela concerne en particulier les traitements de plus longue durée ou gourmands en ressources, tels qu'ils surviennent par exemple dans le cadre de sessions de transfert de fichiers et de données AUTOSAR_AP_SWS_Diagnostics §7.x « DataTransfer ».

Grâce au ReleaseHandler, l'application se voit offrir la possibilité d'être informée de la fin ou de l'annulation de cycles de traitement sans avoir à recourir à des mécanismes bloquants. La classe assume ainsi le rôle d'élément de découplage entre le déroulement interne du serveur de diagnostic et les routines de traitement sous-jacentes de l'application.

Cycle de vie

Le cycle de vie d'une instance de ReleaseHandler est soumis à des règles sémantiques strictes. La classe interdit explicitement une instanciation sans paramètre via le constructeur par défaut [SWS_DM_01530], AUTOSAR_AP_SWS_Diagnostics §8.23.1.2.1.1 « Default Constructor ». Aucun autre constructeur public n'étant spécifié, la création effective de l'objet devrait s'effectuer en interne par le serveur de diagnostic avant que l'instance ne soit transmise au gestionnaire de service respectif. Question Q-05a2e8b6b7deca40 (ouverte) En outre, ReleaseHandler est conçue comme une classe purement déplaçable (move-only) : le constructeur de copie [SWS_DM_01534] ainsi que l'opérateur d'affectation par copie [SWS_DM_01535] sont tous deux supprimés.

La propriété de l'instance peut être transférée exclusivement par des opérations de déplacement. Le constructeur de déplacement est défini comme sûr vis-à-vis des exceptions (noexcept) et explicitement comme thread-safe [SWS_DM_01532], AUTOSAR_AP_SWS_Diagnostics §8.23.1.2.1.2 « Move Constructor ». En revanche, l'opérateur d'affectation par déplacement operator= est certes également sûr vis-à-vis des exceptions, mais il n'est pas thread-safe [SWS_DM_01533]. La destruction s'effectue via le destructeur ~ReleaseHandler() [SWS_DM_01531], AUTOSAR_AP_SWS_Diagnostics §8.23.1.2.1.4 « Destructor », qui est sûr vis-à-vis des exceptions (noexcept), mais ne doit pas être appelé de manière thread-safe.

Parcours d'utilisation

Le schéma d'utilisation typique comprend l'enregistrement d'une fonction de notification ainsi que le contrôle synchrone ou asynchrone de l'état de libération. Une application enregistre un rappel via la méthode SetNotifier [SWS_DM_01537]. Un callable de type ReleaseHandlerSetNotifier, spécifié comme alias de type pour std::function<void(void)>, est transmis comme paramètre [SWS_DM_02079], AUTOSAR_AP_SWS_Diagnostics §8.23.1.1.1 « Type Alias: ReleaseHandlerSetNotifier ». Un appel répété de SetNotifier écrase alors complètement une fonction précédemment enregistrée [SWS_DM_01537].

Dès que la ressource partagée peut être libérée ou qu'une annulation a eu lieu, le notificateur enregistré est déclenché. Cet appel intervient vraisemblablement de façon asynchrone dans le contexte de thread du serveur de diagnostic. Question Q-d948326514d200a1 (ouverte) En parallèle ou dans le cadre de la boucle de contrôle standard, l'application peut vérifier via MayRelease() si la ressource partagée n'est plus utilisée [SWS_DM_01536]. La méthode renvoie true lorsque la ressource peut être libérée, et dans le cas contraire false [SWS_DM_01536].

Diagramme de séquence : déroulement de l'enregistrement de la notification et de la libération des ressources partagées. Sources : [SWS_DM_01536], [SWS_DM_01537], [SWS_DM_02079].

Scénarios d'erreur

Toutes les méthodes de ReleaseHandler sont annotées avec noexcept et spécifiées comme sûres vis-à-vis des exceptions ; aucune exception n'est donc levée et aucun code d'erreur n'est renvoyé ([SWS_DM_01531], [SWS_DM_01532], [SWS_DM_01533], [SWS_DM_01536], [SWS_DM_01537]). Les scénarios d'erreur résultent par conséquent principalement de violations de préconditions ou d'une synchronisation insuffisante.

Une précondition centrale lors de l'appel de SetNotifier est que l'objet transmis doit contenir une cible appelable (callable) et que son exécution ne doit lever aucune exception [SWS_DM_01537]. Un objet fonction vide ou non valide constitue une violation de précondition. En matière de concurrence, il convient de noter que SetNotifier, l'opérateur d'affectation par déplacement et le destructeur sont documentés comme non thread-safe ([SWS_DM_01531], [SWS_DM_01533], [SWS_DM_01537]). Seuls MayRelease() ainsi que le constructeur de déplacement sont explicitement thread-safe ([SWS_DM_01532], [SWS_DM_01536]). L'exécution concurrente d'enregistrements de notificateurs ou d'affectations sans synchronisation externe conduit à un comportement indéfini.