Logging: Pila de subprocesos

En este módulo, se incluyen definiciones relacionadas con el registro de OpenThread.

Resumen

remotas

otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
Genera un volcado de memoria en el nivel de registro crítico.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un volcado de memoria en el nivel de registro de depuración.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un volcado de memoria a nivel de registro de información.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un volcado de memoria en el nivel de registro de notas.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un volcado de memoria en el nivel de registro de advertencia.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
Emite un mensaje de registro en un nivel de registro determinado.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
Emite un mensaje de registro a nivel de registro crítico.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
Emite un mensaje de registro en el nivel del registro de depuración.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)
Genera la siguiente línea de volcado hexadecimal.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
Emite un mensaje de registro a nivel de registro de información.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
Emite un mensaje de registro a nivel de registro de nota.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
void
Emite un mensaje de registro en un nivel de registro determinado con un nombre de módulo de plataforma.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
void void
Emite un mensaje de registro en un nivel de registro determinado con un nombre de módulo de plataforma.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
Emite un mensaje de registro a nivel de registro de advertencia.
otLoggingGetLevel(void)
Muestra el nivel de registro actual.
otLoggingSetLevel(otLogLevel aLogLevel)
Establece el nivel de registro.

Structs

otLogHexDumpInfo

Representa la información que se usa para generar un resultado de volcado hexadecimal.

remotas

otDumpCritPlat

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

Genera un volcado de memoria en el nivel de registro crítico.

Si OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP no están configurados, o si el nivel de registro actual es inferior a un nivel crítico, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aText
Una string que se imprime antes de los bytes.
[in] aData
Un puntero para el búfer de datos.
[in] aDataLength
Cantidad de bytes en aData.

otDumpDebgPlat

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

Genera un volcado de memoria en el nivel de registro de depuración.

Si OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP no están configurados, o el nivel de registro actual es inferior a la depuración, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aText
Una string que se imprime antes de los bytes.
[in] aData
Un puntero para el búfer de datos.
[in] aDataLength
Cantidad de bytes en aData.

otDumpInfoPlat

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

Genera un volcado de memoria a nivel de registro de información.

Si OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP no están configurados, o el nivel de registro actual es inferior a la información, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aText
Una string que se imprime antes de los bytes.
[in] aData
Un puntero para el búfer de datos.
[in] aDataLength
Cantidad de bytes en aData.

otDumpNotePlat

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

Genera un volcado de memoria en el nivel de registro de notas.

Si OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP no están configurados, o si el nivel de registro actual es inferior, ten en cuenta que esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aText
Una string que se imprime antes de los bytes.
[in] aData
Un puntero para el búfer de datos.
[in] aDataLength
Cantidad de bytes en aData.

otDumpWarnPlat

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

Genera un volcado de memoria en el nivel de registro de advertencia.

Si OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP no están configurados, o si el nivel de registro actual es inferior a una advertencia, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aText
Una string que se imprime antes de los bytes.
[in] aData
Un puntero para el búfer de datos.
[in] aDataLength
Cantidad de bytes en aData.

otLogCli

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

Emite un mensaje de registro en un nivel de registro determinado.

Está diseñada para que la use solo la CLI. Si OPENTHREAD_CONFIG_LOG_CLI no está configurado o el nivel de registro actual es inferior al nivel de registro determinado, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aLogLevel
El nivel de registro.
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLogCritPlat

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

Emite un mensaje de registro a nivel de registro crítico.

Se diseñó para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual es inferior a crítico, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLogDebgPlat

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

Emite un mensaje de registro en el nivel del registro de depuración.

Se diseñó para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual es inferior a la opción de depuración, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Genera la siguiente línea de volcado hexadecimal.

Puedes llamar a este método de forma consecutiva para generar el resultado de volcado hexadecimal línea por línea. En la primera llamada, el campo mIterator de aInfo DEBE establecerse en cero.

El siguiente es un ejemplo del resultado de volcado hexadecimal generado:

"==========================[{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.....-m. |" "| 10 3E 3C F5 D3 70 | | .><..p |" "------------------------------------------------------------------------"

Detalles
Parámetros
[in,out] aInfo
Un puntero para otLogHexDumpInfo que se usará a fin de generar el volcado hexadecimal.
Valores que se muestran
OT_ERROR_NONE
Se generó correctamente la línea siguiente; se actualizó el campo mLine en aInfo.
OT_ERROR_NOT_FOUND
Se alcanzó el final y no hay más líneas que generar.

otLogInfoPlat

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

Emite un mensaje de registro a nivel de registro de información.

Se diseñó para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual es inferior a la información, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLogNotePlat

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

Emite un mensaje de registro a nivel de registro de nota.

Se diseñó para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual se encuentra a continuación, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLogPlat

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

Emite un mensaje de registro en un nivel de registro determinado con un nombre de módulo de plataforma.

Está diseñado para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual es inferior a aLogLevel , esta función no emite ningún mensaje de registro.

El nombre aPlatModuleName se usa para determinar el nombre del módulo de registro en el mensaje de registro emitido, con el formato P-{PlatModuleName}---. Esto significa que se agrega la string de prefijo “P-” para indicar que este es un submódulo de plataforma, seguido de los siguientes 12 caracteres de la string PlatModuleName, con guiones con padding - al final para garantizar que el nombre de la región tenga 14 caracteres.

Detalles
Parámetros
[in] aLogLevel
El nivel de registro.
[in] aPlatModuleName
Es el nombre del submódulo de la plataforma.
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLogPlatArgs

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

Emite un mensaje de registro en un nivel de registro determinado con un nombre de módulo de plataforma.

Está diseñado para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual es inferior a aLogLevel , esta función no emite ningún mensaje de registro.

El nombre aPlatModuleName se usa para determinar el nombre del módulo de registro en el mensaje de registro emitido, con el formato P-{PlatModuleName}---. Esto significa que se agrega la string de prefijo “P-” para indicar que este es un submódulo de plataforma, seguido de los siguientes 12 caracteres de la string PlatModuleName, con guiones con padding - al final para garantizar que el nombre de la región tenga 14 caracteres.

Detalles
Parámetros
[in] aLogLevel
El nivel de registro.
[in] aPlatModuleName
Es el nombre del submódulo de la plataforma.
[in] aFormat
Es la cadena de formato.
[in] aArgs
Argumentos para la especificación del formato.

otLogWarnPlat

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

Emite un mensaje de registro a nivel de registro de advertencia.

Se diseñó para que lo use la plataforma. Si OPENTHREAD_CONFIG_LOG_PLATFORM no está configurado o el nivel de registro actual es inferior a la advertencia, esta función no emite ningún mensaje de registro.

Detalles
Parámetros
[in] aFormat
Es la cadena de formato.
[in] ...
Argumentos para la especificación del formato.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Muestra el nivel de registro actual.

Si la función de nivel de registro dinámico OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE está habilitada, esta función muestra el nivel de registro dinámico establecido actualmente. De lo contrario, esta función muestra el nivel de registro configurado por el tiempo de compilación.

Detalles
Qué muestra
El nivel de registro.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Establece el nivel de registro.

Detalles
Parámetros
[in] aLogLevel
El nivel de registro.
Valores que se muestran
OT_ERROR_NONE
Se actualizó correctamente el nivel de registro.
OT_ERROR_INVALID_ARGS
El valor a nivel de registro no es válido.

Macros

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Tamaño de la cadena de línea de volcado hexadecimal.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir a nuestra documentación, consulta Recursos.