classe ara::tsync::TsyncErrorDomain

Utilisation

La méthode Message de la classe ara::tsync::TsyncErrorDomain sert à la récupération synchrone d'une description textuelle d'erreur pour un code d'erreur transmis [SWS_TS_00907]. Elle est mise à disposition via l'en-tête #include "ara/tsync/tsync_error_domain.h". Comme paramètre d'entrée, la fonction accepte errorCode de type CodeType et renvoie un pointeur sur chaîne constante (const char *) vers le message correspondant [SWS_TS_00907].

Gestion des erreurs et concurrence

L'interface garantit une sécurité totale vis-à-vis des exceptions (exception safe) et est déclarée comme noexcept, raison pour laquelle l'appel se déroule de manière garantie sans exceptions C++ [SWS_TS_00907]. De plus, la fonction est spécifiée comme thread-safe et peut être appelée sans hésitation de manière concurrente depuis plusieurs threads [SWS_TS_00907]. Interprétation : le const char * retourné devrait pointer vers une mémoire statique et immuable, de sorte qu'aucune libération manuelle de mémoire n'incombe à l'appelant. Question Q-933f88e4fde03016 (ouverte)

Interaction

En tant que méthode surchargée (override), la fonction s'intègre dans le modèle d'erreur unifié d'AUTOSAR Adaptive [SWS_TS_00907]. De manière similaire, apext::tsync::TsyncFvmErrorDomain issu de l'en-tête #include "apext/tsync/fvm_error_domain.h" implémente également une fonction Message homonyme pour résoudre les textes d'erreur spécifiques au domaine avec les mêmes garanties de sûreté vis-à-vis des threads et des exceptions [SWS_TS_14210].

Utilisation et contexte d'appel

La fonction membre Name() de la classe ara::tsync::TsyncErrorDomain renvoie un pointeur vers une chaîne de caractères constante qui identifie le domaine d'erreur [SWS_TS_00906]. La fonction requiert le fichier d'en-tête ara/tsync/tsync_error_domain.h, est appelée de manière synchrone et ne prend aucun paramètre [SWS_TS_00906]. Le type const char * est transmis comme valeur de retour [SWS_TS_00906]. Interprétation : la valeur de retour étant définie comme une constante de chaîne de caractères, la zone mémoire devrait avoir une durée de vie statique et ne doit être ni modifiée ni libérée par l'appelant. Question Q-f9cb9d4986d49755 (ouverte)

Gestion des erreurs et concurrence

La méthode est déclarée comme noexcept et spécifiée comme sûre vis-à-vis des exceptions (« exception safe »), garantissant ainsi qu'aucune exception n'est levée [SWS_TS_00906]. Il n'existe pas de codes d'erreur spécifiques, ni de messages DET ou DEM pour cet appel. En ce qui concerne le comportement face à la concurrence, la fonction est classée comme thread-safe (« thread-safe ») [SWS_TS_00906]. L'appel peut par conséquent être effectué en parallèle depuis plusieurs contextes d'exécution sans synchronisation externe.

Interaction et exigences associées

Avec le qualificatif override, la fonction surcharge l'interface standardisée de désignation de domaine dans le module ts [SWS_TS_00906]. Le domaine d'erreur associé apext::tsync::TsyncFvmErrorDomain implémente le même patron de conception ; sa fonction Name() issue de apext/tsync/fvm_error_domain.h fournit également son identifiant de manière synchrone, thread-safe et sans exception [SWS_TS_14209].

Utilisation

La fonction membre ThrowAsException de la classe ara::tsync::TsyncErrorDomain crée de manière synchrone, à partir du paramètre errorCode transmis, une nouvelle instance de TsyncException et la lève en tant qu'exception C++ ([SWS_TS_00908]). La fonction ne possède pas de valeur de retour (void) et est mise à disposition via l'en-tête ara/tsync/tsync_error_domain.h.

Gestion des erreurs et sécurité vis-à-vis des exceptions

La méthode est déclarée avec noexcept(false) et spécifiée comme not exception safe ([SWS_TS_00908]). Interprétation : cette classification s'expliquerait par le fait que la fonction déclenche conformément à sa conception une exception et quitte ainsi le flux de contrôle régulier. Question Q-cde17219378516c1 (ouverte) Des codes d'erreur spécifiques ne sont pas renvoyés, mais transportés via l'objet d'exception levé.

Concurrence et restrictions

La fonction est classée comme thread-safe ([SWS_TS_00908]) et peut ainsi être appelée en toute sécurité depuis des threads concurrents. Une restriction essentielle concerne la chaîne d'outils : conformément à [SWS_CORE_10304], ThrowAsException ne participe pas à la résolution de surcharge (overload resolution) si les exceptions C++ sont désactivées dans la toolchain du compilateur.

Interaction

Le comportement correspond au modèle uniforme des domaines d'erreur dans AUTOSAR Adaptive. Un pendant direct se trouve dans apext::tsync::TsyncFvmErrorDomain ([SWS_TS_14211]), où ThrowAsException lève une apext::tsync::TsyncFvmException et est également soumise aux prescriptions de [SWS_CORE_10304].

Utilisation

Le constructeur par défaut sans paramètre crée une nouvelle instance du domaine d'erreur ara::tsync::TsyncErrorDomain [SWS_TS_00905]. La déclaration est fournie via le fichier d'en-tête #include "ara/tsync/tsync_error_domain.h" [SWS_TS_00905]. L'exécution est synchrone, ne prend aucun paramètre d'entrée et ne lève aucune exception C++ (noexcept) [SWS_TS_00905].

Interaction et gestion des erreurs

Le domaine d'erreur créé sert à encapsuler et interpréter les états d'erreur spécifiques à la synchronisation dans le module Time Synchronization. Au sein du domaine, les alias de type Errc pour l'énumération des codes d'erreur TsyncErrc [SWS_TS_01266] ainsi que Exception pour la classe de base d'exception TsyncException [SWS_TS_01267] sont mis à disposition. Les instances de la classe fournissent via la méthode Name une chaîne de caractères de nom constante du domaine [SWS_TS_00906] et via Message la description textuelle de l'erreur associée à un code d'erreur spécifié [SWS_TS_00907]. De plus, ThrowAsException permet de créer et de lever une TsyncException sur la base d'un ara::core::ErrorCode, pour autant que les exceptions C++ soient activées dans le compilateur [SWS_TS_00908]. Dans les scénarios d'application typiques, une instanciation propre via le constructeur devrait être rarement requise, car une référence vers l'objet d'instance global est déjà fournie via GetTsyncErrorDomain [SWS_TS_00909]. Question Q-8ebaff4e52125b78 (ouverte)

Concurrence et restrictions

L'appel est spécifié comme sûr vis-à-vis des exceptions (exception safe) et thread-safe (thread-safe) [SWS_TS_00905]. L'instanciation peut donc être effectuée entre plusieurs threads sans mesures de synchronisation supplémentaires.