classe ara::phm::PhmErrorDomain

A função-membro Message da classe ara::phm::PhmErrorDomain retorna, para um número de erro fornecido errorCode do tipo CodeType, uma descrição textual da mensagem de erro correspondente como const char * [SWS_PHM_01249]. A função é fornecida por meio do arquivo de cabeçalho ara/phm/phm_error_domain.h e, como método virtual (override), substitui o comportamento padrão da interface para resolução de erros [SWS_PHM_01249].

Para o contexto de chamada e a semântica de execução, aplicam-se as seguintes determinações:

• Execução síncrona e tratamento de exceções: A chamada ocorre de forma síncrona e está declarada como noexcept; além disso, o método é especificado como exception safe, de modo que nenhuma exceção seja lançada durante a execução [SWS_PHM_01249].
• Concorrência: A função está explicitamente declarada como thread-safe e pode ser chamada com segurança a partir de threads concorrentes, sem sincronização externa adicional [SWS_PHM_01249].
• Gerenciamento de memória: Interpretação: O ponteiro de caracteres retornado provavelmente deve referenciar um literal de caracteres estático, de modo que nenhuma liberação de memória precisa ser realizada pelo chamador. Pergunta Q-dcdc593e3f9ded45 (aberta)

No Platform Health Management (PHM), o método serve para traduzir códigos de erro numéricos da PhmErrorDomain em cadeias de caracteres legíveis por humanos para fins de registro em log ou de diagnóstico [SWS_PHM_01249].

A função-membro Name da classe ara::phm::PhmErrorDomain retorna o nome do domínio de erro como cadeia de caracteres ([SWS_PHM_01248]). A declaração está incluída no módulo phm por meio do arquivo de cabeçalho #include "ara/phm/phm_error_domain.h" ([SWS_PHM_01248]).

Para o uso prático e o comportamento em tempo de execução, aplicam-se as seguintes diretrizes:

• Uso e assinatura: O método possui a assinatura const char * Name () const noexcept override; ([SWS_PHM_01248]). Ele é executado de forma síncrona e não espera parâmetros de passagem. O ponteiro retornado do tipo const char * corresponde às especificações para ara::phm::PhmErrorDomain de [SWS_CORE_90023].
• Tratamento de erros: A função está declarada como noexcept e apresenta o nível de segurança contra exceções exception safe ([SWS_PHM_01248]). Ela não lança exceções em tempo de execução e não gera mensagens de erro.
• Concorrência: O método está especificado como seguro para threads (thread-safe) ([SWS_PHM_01248]). Chamadas paralelas através da mesma instância ou de instâncias diferentes podem ser realizadas sem mecanismos adicionais de sincronização.

Na interação arquitetural, a operação substitui a consulta virtual de nome da interface superior do domínio de erro e fornece o nome específico para ara::phm::PhmErrorDomain de acordo com [SWS_CORE_90023] ([SWS_PHM_01248]).

O construtor padrão PhmErrorDomain() serve para a criação de uma instância do domínio de erro ara::phm::PhmErrorDomain [SWS_PHM_01247]. A chamada ocorre de forma síncrona e sem parâmetros de passagem através do cabeçalho ara/phm/phm_error_domain.h [SWS_PHM_01247].

Em relação à segurança de execução, a construção está especificada como exception safe e declarada com noexcept, de modo que nenhuma exceção seja lançada [SWS_PHM_01247]. Além disso, a instanciação é thread-safe [SWS_PHM_01247].

O domínio criado forma o contexto para erros do PHM e disponibiliza funções-membro como Name() [SWS_PHM_01248], Message() [SWS_PHM_01249] bem como ThrowAsException() [SWS_PHM_01250], definindo os aliases de tipo Errc [SWS_PHM_01245] e Exception [SWS_PHM_01246]. Para o acesso regular ao domínio de erro, está disponível a função livre GetPhmDomain(), que retorna uma referência para o objeto global [SWS_PHM_01251]. Uma instanciação manual separada por meio do construtor provavelmente não deve, portanto, ser tipicamente necessária no código da aplicação. Pergunta Q-63be3bb534ef1fa9 (aberta)

usar

A função-membro ThrowAsException é um método da classe de domínio de erro ara::phm::PhmErrorDomain e é disponibilizada através do arquivo de cabeçalho ara/phm/phm_error_domain.h ([SWS_PHM_01250]). Seu propósito consiste em disparar sincronamente a exceção C++ que está associada ao código de erro passado ([SWS_PHM_01250]). Para isso, a função recebe como parâmetro de entrada uma referência ao objeto de erro errorCode do tipo const ara::core::ErrorCode & ([SWS_PHM_01250]). Como o fluxo de controle é continuado através da exceção em caso de execução com erro, o método não possui valor de retorno (void) ([SWS_PHM_01250]).

Simultaneidade e segurança de execução

No que diz respeito ao comportamento em chamadas paralelas, ThrowAsException é declarado como thread-safe ([SWS_PHM_01250]). Ele pode, portanto, ser chamado de forma segura e concorrente a partir de múltiplas threads. Quanto à segurança contra exceções, a interface na especificação é, por outro lado, expressamente classificada como “not exception safe” ([SWS_PHM_01250]).

Restrições de compilador e resolução de sobrecarga

Uma condição de contorno essencial para o uso define [SWS_CORE_10304]: se as exceções C++ estiverem desativadas na toolchain do compilador utilizada, ThrowAsException não participa da resolução de sobrecarga ([SWS_PHM_01250]). Em builds de software para plataformas ou configurações sem suporte a exceções, a função não está, portanto, disponível para o compilador na resolução de sobrecarga ([SWS_PHM_01250]).