classe ara::fw::FwErrorDomain

L'alias de type Errc est défini selon [AP_SWS_Fw_83007] en tant qu'alias pour l'énumération de codes d'erreur FwErrc (using Errc = FwErrc;). L'élément est déclaré dans la portée de la classe ara::fw::FwErrorDomain et doit être inclus via le fichier d'en-tête ara/fw/fw_error_domain.h [AP_SWS_Fw_83007].

En ce qui concerne son utilisation, Errc ne représente aucun appel de fonction exécutable et ne possède donc ni paramètres, ni valeurs de retour, ni sémantique synchrone ou asynchrone [AP_SWS_Fw_83007]. Il fournit plutôt un identifiant uniforme pour l'énumération des causes d'erreur spécifiques au domaine. Interprétation : l'alias devrait offrir aux développeurs un accès simplifié et cohérent aux valeurs d'énumération de FwErrc au sein de ara::fw::FwErrorDomain afin de typer et d'interroger les états d'erreur [AP_SWS_Fw_83007]. Question Q-bd8949830961e459 (ouverte)

Puisqu'il s'agit d'une construction purement à la compilation, il n'existe aucune restriction d'exécution concernant la réentrance, la sécurité des threads ou l'ordre des appels [AP_SWS_Fw_83007]. Les valeurs d'erreur spécifiques ou les liaisons avec des messages DET ou DEM ne sont pas prescrites dans l'élément de spécification et dépendent des valeurs de l'énumération sous-jacente [AP_SWS_Fw_83007].

Le constructeur par défaut FwErrorDomain() est déclaré comme supprimé ([AP_SWS_Fw_83009]). Une instanciation directe d'objets de la classe ara::fw::FwErrorDomain via ce constructeur est donc exclue dans le code applicatif. Interprétation : la suppression devrait garantir que le domaine d'erreur est géré exclusivement en tant que singleton. Question Q-54f7bc341f074e2c (ouverte)

Pour l'utilisation du domaine d'erreur, la fonction libre GetFwErrorDomain() est disponible ([AP_SWS_Fw_83002]). Celle-ci fournit de manière thread-safe une référence vers l'objet de domaine existant de type ara::core::ErrorDomain. Les interfaces du domaine peuvent être utilisées via cette référence :

• Interrogation du nom du domaine d'erreur via Name() ([AP_SWS_Fw_83010]).
• Détermination de textes descriptifs associés aux codes d'erreur au moyen de Message() ([AP_SWS_Fw_83011]).
• Déclenchement d'exceptions via ThrowAsException() ([AP_SWS_Fw_83012]), l'alias Exception renvoyant à FwException ([AP_SWS_Fw_83008]).

Les codes d'erreur associés sont définis par l'énumération FwErrc ([AP_SWS_Fw_83001]), qui est également disponible au sein de la classe via l'alias Errc ([AP_SWS_Fw_83007]). Les valeurs valides sont kServiceNotAvailable ainsi que kInvalidStateDependentFirewall. Les développeurs ne doivent donc pas créer leurs propres instances, mais toujours utiliser la référence globale.

Utilisation et sémantique

La fonction membre Name de la classe ara::fw::FwErrorDomain sert à récupérer l'identifiant du domaine d'erreur [AP_SWS_Fw_83010]. L'appel s'effectue de manière synchrone et nécessite l'inclusion du fichier d'en-tête ara/fw/fw_error_domain.h [AP_SWS_Fw_83010]. La fonction ne prend aucun paramètre d'entrée et renvoie un pointeur de type const char * qui représente le nom du domaine [AP_SWS_Fw_83010]. Il devrait s'agir pour la valeur de retour d'une chaîne terminée par zéro dont la validité est liée à la durée de vie du domaine d'erreur. Question Q-6bd465d82e79a682 (ouverte)

Gestion des erreurs

La méthode est déclarée avec l'identifiant noexcept [AP_SWS_Fw_83010]. Par conséquent, elle ne déclenche aucune exception et ne prévoit aucun code d'erreur spécifique ni retour d'erreur [AP_SWS_Fw_83010].

Concurrence et restrictions

Selon la spécification, la fonction est classée comme thread-safe (thread-safe) [AP_SWS_Fw_83010]. Comme il s'agit d'une fonction membre constante (const), l'accès ne modifie pas l'état de l'instance et peut être appelé de manière concurrente en toute sécurité depuis différents contextes d'exécution [AP_SWS_Fw_83010]. Aucune précondition particulière ni exigence d'ordonnancement n'est imposée par la spécification [AP_SWS_Fw_83010].

Utilisation

La fonction membre Message de la classe ara::fw::FwErrorDomain est déclarée via le fichier d'en-tête ara/fw/fw_error_domain.h et sert à la récupération synchrone d'un message d'erreur [AP_SWS_Fw_83011]. Lors de l'appel, l'appelant transmet un code d'erreur errorCode du type CodeType. Comme valeur de retour, la fonction renvoie un pointeur de type const char * vers la chaîne de caractères associée au code d'erreur [AP_SWS_Fw_83011]. La fonction surcharge en tant que override l'interface correspondante de la classe de base [AP_SWS_Fw_83011].

Concurrence et sécurité des threads

La spécification définit expressément Message comme thread-safe [AP_SWS_Fw_83011]. Les appelants peuvent donc appeler la méthode en parallèle pour une même instance à partir de différents threads, sans mesures de synchronisation supplémentaires. En raison de sa qualification comme méthode const, l'état du domaine d'erreur n'est pas modifié lors de l'appel [AP_SWS_Fw_83011].

Gestion des erreurs et conditions limites

En raison de sa déclaration en tant que noexcept, la méthode garantit qu'aucune exception C++ ne sera levée [AP_SWS_Fw_83011]. Aucun code d'erreur spécifique ou valeur d'erreur pour les codes non résolubles n'est défini dans l'élément [AP_SWS_Fw_83011]. Le pointeur fourni devrait probablement pointer vers une chaîne de caractères immuable et allouée statiquement, ce qui dispense l'appelant de toute obligation de gestion de la mémoire. Question Q-2e98884ffd517367 (ouverte)

La fonction membre ThrowAsException de la classe ara::fw::FwErrorDomain sert à instancier et déclencher une FwException à partir d'un code d'erreur transmis errorCode [AP_SWS_Fw_83012]. La fonction est incluse via le fichier d'en-tête ara/fw/fw_error_domain.h et prend une référence constante vers ara::core::ErrorCode comme unique paramètre [AP_SWS_Fw_83012]. Elle ne possède pas de valeur de retour (void) et est déclarée avec const ainsi que override [AP_SWS_Fw_83012].

La clause de spécification noexcept(false) définit explicitement que des exceptions peuvent être levées lors de l'appel de la méthode ; la fonction crée et lève de manière déterministe une FwException pour le cas d'erreur correspondant [AP_SWS_Fw_83012]. Concernant la sécurité vis-à-vis des exceptions, la méthode est classée comme not exception safe [AP_SWS_Fw_83012]. Le code appelant doit donc être préparé à ce que l'exception résultante interrompe le flux de contrôle normal et requière des dispositions appropriées pour la gestion des exceptions.

En matière de concurrence, la méthode est spécifiée comme thread-safe, ce qui autorise un appel simultané depuis plusieurs threads [AP_SWS_Fw_83012]. Grâce au mot-clé override, la méthode surcharge probablement la fonction d'interface de même nom d'un domaine d'erreur supérieur [AP_SWS_Fw_83012]. Question Q-aae02c046243335c (ouverte)