Geração de registros: pilha de linhas de execução

Este módulo inclui definições relacionadas à geração de registros do OpenThread.

Resumo

remotas

otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
Gera um despejo de memória no nível de registro crítico.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Gera um despejo de memória no nível de registro de depuração.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Gera um despejo de memória no nível do registro de informações.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Gera um despejo de memória no nível de registro da anotação.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Gera um despejo de memória no nível de registro de aviso.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
Emite uma mensagem de registro em um determinado nível de registro.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
Emite uma mensagem de registro no nível crítico.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
Emite uma mensagem de registro no nível de registro de depuração.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)
Gera a próxima linha de despejo hexadecimal.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
Emite uma mensagem de registro no nível de registro de informações.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
Emite uma mensagem de registro no nível de registro da nota.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
void
Emite uma mensagem de registro em um determinado nível usando um nome de módulo de plataforma.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
void void
Emite uma mensagem de registro em um determinado nível usando um nome de módulo de plataforma.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
Emite uma mensagem de registro no nível de registro de aviso.
otLoggingGetLevel(void)
Retorna o nível de registro atual.
otLoggingSetLevel(otLogLevel aLogLevel)
Define o nível de registro.

Estruturas

otLogHexDumpInfo

Representa informações usadas para gerar a saída de despejo hexadecimal.

remotas

otDumpCritPlat

void void void void void void otDumpCritPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Gera um despejo de memória no nível de registro crítico.

Se OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP não estiverem definidos ou o nível de registro atual estiver abaixo de crítico, essa função não vai emitir mensagens de registro.

Detalhes
Parâmetros
[in] aText
Uma string impressa antes dos bytes.
[in] aData
Um ponteiro para o buffer de dados.
[in] aDataLength
Número de bytes em aData.

otDumpDebgPlat

void otDumpDebgPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Gera um despejo de memória no nível de registro de depuração.

Se OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP não estiverem definidos ou o nível de registro atual estiver abaixo da depuração, essa função não vai emitir nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aText
Uma string impressa antes dos bytes.
[in] aData
Um ponteiro para o buffer de dados.
[in] aDataLength
Número de bytes em aData.

otDumpInfoPlat

void otDumpInfoPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Gera um despejo de memória no nível do registro de informações.

Se OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP não estiverem definidos ou o nível de registro atual estiver abaixo das informações, essa função não vai emitir nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aText
Uma string impressa antes dos bytes.
[in] aData
Um ponteiro para o buffer de dados.
[in] aDataLength
Número de bytes em aData.

otDumpNotePlat

void otDumpNotePlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Gera um despejo de memória no nível de registro da anotação.

Se OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP não estiverem definidos ou o nível de registro atual estiver abaixo, essa função não vai emitir mensagens de registro.

Detalhes
Parâmetros
[in] aText
Uma string impressa antes dos bytes.
[in] aData
Um ponteiro para o buffer de dados.
[in] aDataLength
Número de bytes em aData.

otDumpWarnPlat

void otDumpWarnPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

Gera um despejo de memória no nível de registro de aviso.

Se OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP não estiverem definidos ou o nível de registro atual estiver abaixo, avisando que a função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aText
Uma string impressa antes dos bytes.
[in] aData
Um ponteiro para o buffer de dados.
[in] aDataLength
Número de bytes em aData.

otLogCli

void otLogCli(
  otLogLevel aLogLevel,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2

Emite uma mensagem de registro em um determinado nível de registro.

Destina-se ao uso apenas pela CLI. Se OPENTHREAD_CONFIG_LOG_CLI não estiver definido ou o nível de registro atual estiver abaixo do fornecido, essa função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aLogLevel
O nível de registro.
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLogCritPlat

void otLogCritPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Emite uma mensagem de registro no nível crítico.

Destina-se ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não for definido ou o nível de registro atual estiver abaixo de crítico, essa função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLogDebgPlat

void void void void void otLogDebgPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Emite uma mensagem de registro no nível de registro de depuração.

Destina-se ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não estiver definido ou o nível de registro atual estiver abaixo da depuração, essa função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Gera a próxima linha de despejo hexadecimal.

É possível chamar esse método de maneira inversa para gerar a saída de despejo hexadecimal linha por linha. Na primeira chamada, o campo mIterator em aInfo PRECISA ser definido como zero.

Confira um exemplo da saída de despejo hexadecimal gerada:

"==========================[{mTitle} len=070]============================" "| 41 D8 87 34 12 FF FF 25 | 4C 57 DA F2 FB 2F 62 7F | A..4...%LW.../b. |" "| 3B 01 F0 4D 4C 4D 4C 54 | 4F 00 15 15 00 00 00 00 | ;..MLMLTO....... |" "| 00 00 00 01 80 DB 60 82 | 7E 33 72 3B CC B3 A1 84 | ......`.~3r;.... |" "| 3B E6 AD B2 0B 45 E7 45 | C5 B9 00 1A CB 2D 6D 1C | ;....E.E.....-m. |" "| 10 3E 3C F5 D3 70 | | .><..p |" "------------------------------------------------------------------------"

Detalhes
Parâmetros
[in,out] aInfo
Um ponteiro para otLogHexDumpInfo a ser usado para gerar despejo hexadecimal.
Valores de retorno
OT_ERROR_NONE
A próxima linha foi gerada, e o campo mLine em aInfo foi atualizado.
OT_ERROR_NOT_FOUND
Você chegou ao fim e não há mais linha para gerar.

otLogInfoPlat

void void void void otLogInfoPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Emite uma mensagem de registro no nível de registro de informações.

Destina-se ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não estiver definido ou o nível de registro atual estiver abaixo da informação, essa função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLogNotePlat

void void void otLogNotePlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Emite uma mensagem de registro no nível de registro da nota.

Destina-se ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não estiver definido ou o nível de registro atual estiver abaixo da nota, essa função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLogPlat

void otLogPlat(
  otLogLevel aLogLevel,
  const char *aPlatModuleName,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3

Emite uma mensagem de registro em um determinado nível usando um nome de módulo de plataforma.

Ele é destinado ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não estiver definido ou o nível de registro atual estiver abaixo de aLogLevel , essa função não emitirá nenhuma mensagem de registro.

O nome aPlatModuleName é usado para determinar o nome do módulo de registro na mensagem de registro emitida, seguindo o formato P-{PlatModuleName}---. Isso significa que a string de prefixo "P-" é adicionada para indicar que esse é um submódulo de plataforma, seguido pelos próximos 12 caracteres da string PlatModuleName, com hífens - preenchidos no final para garantir que o nome da região tenha 14 caracteres.

Detalhes
Parâmetros
[in] aLogLevel
O nível de registro.
[in] aPlatModuleName
O nome do submódulo da plataforma.
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLogPlatArgs

void void otLogPlatArgs(
  otLogLevel aLogLevel,
  const char *aPlatModuleName,
  const char *aFormat,
  va_list aArgs
)

Emite uma mensagem de registro em um determinado nível usando um nome de módulo de plataforma.

Ele é destinado ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não estiver definido ou o nível de registro atual estiver abaixo de aLogLevel , essa função não emitirá nenhuma mensagem de registro.

O nome aPlatModuleName é usado para determinar o nome do módulo de registro na mensagem de registro emitida, seguindo o formato P-{PlatModuleName}---. Isso significa que a string de prefixo "P-" é adicionada para indicar que esse é um submódulo de plataforma, seguido pelos próximos 12 caracteres da string PlatModuleName, com hífens - preenchidos no final para garantir que o nome da região tenha 14 caracteres.

Detalhes
Parâmetros
[in] aLogLevel
O nível de registro.
[in] aPlatModuleName
O nome do submódulo da plataforma.
[in] aFormat
A string de formatação.
[in] aArgs
Argumentos para a especificação de formato.

otLogWarnPlat

void void otLogWarnPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

Emite uma mensagem de registro no nível de registro de aviso.

Destina-se ao uso pela plataforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM não estiver definido ou o nível de registro atual estiver abaixo de aviso, essa função não emitirá nenhuma mensagem de registro.

Detalhes
Parâmetros
[in] aFormat
A string de formatação.
[in] ...
Argumentos para a especificação de formato.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Retorna o nível de registro atual.

Se o recurso de nível de registro dinâmico OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE estiver ativado, essa função retornará o nível de registro dinâmico definido no momento. Caso contrário, essa função retorna o nível de registro configurado pelo tempo de build.

Detalhes
Retorna
O nível de registro.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Define o nível de registro.

Detalhes
Parâmetros
[in] aLogLevel
O nível de registro.
Valores de retorno
OT_ERROR_NONE
O nível de registro foi atualizado.
OT_ERROR_INVALID_ARGS
O valor no nível de registro é inválido.

Macros

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Tamanho da string de linha de despejo hexadecimal.

Recursos

Os tópicos de Referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.