Cette page a été traduite par l'API Cloud Translation.

Journalisation – Pile de threads

Ce module inclut les définitions liées à la journalisation OpenThread.

Résumé

distantes
`otDumpCritPlat(const char aText, const void aData, uint16_t aDataLength)`	`void void void void void void` Génère un vidage de mémoire au niveau de journalisation critique.
`otDumpDebgPlat(const char aText, const void aData, uint16_t aDataLength)`	`void` Génère un vidage de mémoire au niveau du journal de débogage.
`otDumpInfoPlat(const char aText, const void aData, uint16_t aDataLength)`	`void` Génère un vidage de mémoire au niveau du journal des informations.
`otDumpNotePlat(const char aText, const void aData, uint16_t aDataLength)`	`void` Génère un vidage de mémoire au niveau de journalisation des notes.
`otDumpWarnPlat(const char aText, const void aData, uint16_t aDataLength)`	`void` Génère un vidage de mémoire au niveau du journal d'avertissement.
`otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2`	`void` Émet un message de journal à un niveau de journalisation donné.
`otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void` Émet un message de journal au niveau de journalisation critique.
`otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void void void void` Émet un message de journal au niveau du journal de débogage.
`otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)`	`otError` Génère la ligne de vidage hexadécimal suivante.
`otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void void void` Émet un message de journal au niveau du journal d'informations.
`otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void void` Émet un message de journal au niveau de la note.
`otLogPlat(otLogLevel aLogLevel, const char aPlatModuleName, const char aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3`	`void` Émet un message de journal à un niveau de journalisation donné en utilisant un nom de module de plate-forme.
`otLogPlatArgs(otLogLevel aLogLevel, const char aPlatModuleName, const char aFormat, va_list aArgs)`	`void void` Émet un message de journal à un niveau de journalisation donné en utilisant un nom de module de plate-forme.
`otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1`	`void void` Émet un message de journal au niveau de journalisation d'avertissement.
`otLoggingGetLevel(void)`	`otLogLevel` Renvoie le niveau de journalisation actuel.
`otLoggingSetLevel(otLogLevel aLogLevel)`	`otError` Définit le niveau de journalisation.

Structs
otLogHexDumpInfo	Représente les informations utilisées pour générer une sortie de vidage hexadécimal.

distantes

otDumpCritPlat

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

Génère un vidage de mémoire au niveau de journalisation critique.

Si OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP n'est pas défini, ou si le niveau de journalisation actuel est inférieur au niveau critique, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aText`	Chaîne affichée avant les octets.
`[in] aData`	Pointeur vers le tampon de données.
`[in] aDataLength`	Nombre d'octets dans `aData`.

otDumpDebgPlat

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

Génère un vidage de mémoire au niveau du journal de débogage.

Si OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP n'est pas défini, ou si le niveau de journalisation actuel est inférieur au débogage, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aText`	Chaîne affichée avant les octets.
`[in] aData`	Pointeur vers le tampon de données.
`[in] aDataLength`	Nombre d'octets dans `aData`.

otDumpInfoPlat

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

Génère un vidage de mémoire au niveau du journal des informations.

Si OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP n'est pas défini, ou si le niveau de journalisation actuel est inférieur aux informations, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aText`	Chaîne affichée avant les octets.
`[in] aData`	Pointeur vers le tampon de données.
`[in] aDataLength`	Nombre d'octets dans `aData`.

otDumpNotePlat

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

Génère un vidage de mémoire au niveau de journalisation des notes.

Si OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP n'est pas défini, ou si le niveau de journalisation actuel est inférieur, notez que cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aText`	Chaîne affichée avant les octets.
`[in] aData`	Pointeur vers le tampon de données.
`[in] aDataLength`	Nombre d'octets dans `aData`.

otDumpWarnPlat

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

Génère un vidage de mémoire au niveau du journal d'avertissement.

Si OPENTHREAD_CONFIG_LOG_PLATFORM ou OPENTHREAD_CONFIG_LOG_PKT_DUMP n'est pas défini, ou si le niveau de journalisation actuel est inférieur à l'avertissement, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aText`	Chaîne affichée avant les octets.
`[in] aData`	Pointeur vers le tampon de données.
`[in] aDataLength`	Nombre d'octets dans `aData`.

otLogCli

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

Émet un message de journal à un niveau de journalisation donné.

est destiné à être utilisé uniquement via la CLI ; Si OPENTHREAD_CONFIG_LOG_CLI n'est pas défini ou si le niveau de journalisation actuel est inférieur au niveau donné, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aLogLevel`	Niveau de journalisation.
`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLogCritPlat

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

Émet un message de journal au niveau de journalisation critique.

destiné à être utilisé par plate-forme ; Si OPENTHREAD_CONFIG_LOG_PLATFORM n'est pas défini ou si le niveau de journalisation actuel est inférieur au niveau critique, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLogDebgPlat

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

Émet un message de journal au niveau du journal de débogage.

destiné à être utilisé par plate-forme ; Si OPENTHREAD_CONFIG_LOG_PLATFORM n'est pas défini ou si le niveau de journalisation actuel est inférieur au niveau de débogage, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Génère la ligne de vidage hexadécimal suivante.

Vous pouvez appeler cette méthode dos-à-dos pour générer le résultat du vidage hexadécimal ligne par ligne. Lors du premier appel, le champ mIterator de aInfo DOIT être défini sur zéro.

Voici un exemple de sortie du vidage hexadécimal généré:

"==========================[{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 | ;..MLTO....... |" "| 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 |" "------------------------------------------------------------------------"

Détails

Paramètres

[in,out] aInfo

Pointeur vers otLogHexDumpInfo à utiliser pour générer une copie hexadécimale.

Valeurs de retour

`OT_ERROR_NONE`	La ligne suivante a bien été générée. Le champ `mLine` de `aInfo` a été mis à jour.
`OT_ERROR_NOT_FOUND`	Fin de la ligne atteinte. Il n'y a plus de ligne à générer.

otLogInfoPlat

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

Émet un message de journal au niveau du journal d'informations.

destiné à être utilisé par plate-forme ; Si OPENTHREAD_CONFIG_LOG_PLATFORM n'est pas défini ou si le niveau de journalisation actuel est inférieur aux informations, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLogNotePlat

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

Émet un message de journal au niveau de la note.

destiné à être utilisé par plate-forme ; Si OPENTHREAD_CONFIG_LOG_PLATFORM n'est pas défini ou si le niveau de journalisation actuel est inférieur à la note, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLogPlat

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

Émet un message de journal à un niveau de journalisation donné en utilisant un nom de module de plate-forme.

Elle est destinée à être utilisée par la plate-forme. Si OPENTHREAD_CONFIG_LOG_PLATFORM n'est pas défini ou si le niveau de journalisation actuel est inférieur à aLogLevel , cette fonction n'émet aucun message de journal.

Le nom aPlatModuleName permet de déterminer le nom du module de journal dans le message de journal émis, en respectant le format P-{PlatModuleName}---. Cela signifie que la chaîne de préfixe "P-" est ajoutée pour indiquer qu'il s'agit d'un sous-module de plate-forme, suivi des 12 caractères suivants de la chaîne PlatModuleName, avec des traits d'union - à la fin pour indiquer que le nom de la région comporte 14 caractères.

Détails

Paramètres

`[in] aLogLevel`	Niveau de journalisation.
`[in] aPlatModuleName`	Nom du sous-module de la plate-forme.
`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLogPlatArgs

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

Émet un message de journal à un niveau de journalisation donné en utilisant un nom de module de plate-forme.

Détails

Paramètres

`[in] aLogLevel`	Niveau de journalisation.
`[in] aPlatModuleName`	Nom du sous-module de la plate-forme.
`[in] aFormat`	Chaîne de format.
`[in] aArgs`	Arguments permettant de spécifier le format.

otLogWarnPlat

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

Émet un message de journal au niveau de journalisation d'avertissement.

destiné à être utilisé par plate-forme ; Si OPENTHREAD_CONFIG_LOG_PLATFORM n'est pas défini ou si le niveau de journalisation actuel est inférieur à l'avertissement, cette fonction n'émet aucun message de journal.

Détails

Paramètres

`[in] aFormat`	Chaîne de format.
`[in] ...`	Arguments permettant de spécifier le format.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Renvoie le niveau de journalisation actuel.

Si la fonctionnalité de niveau de journalisation dynamique OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE est activée, elle renvoie le niveau de journalisation dynamique actuellement défini. Sinon, cette fonction renvoie le niveau de journalisation configuré au moment de la compilation.

Détails
Renvoie	Niveau de journalisation.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Définit le niveau de journalisation.

Remarque:Cette fonction nécessite OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1.

Détails

Paramètres

[in] aLogLevel

Niveau de journalisation.

Valeurs de retour

`OT_ERROR_NONE`	Le niveau de journalisation a bien été mis à jour.
`OT_ERROR_INVALID_ARGS`	La valeur du niveau de journalisation n'est pas valide.

Macros

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Taille de la chaîne de ligne de vidage hexadécimal.

Ressources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la section Ressources.

Journalisation – Pile de threads

Résumé

distantes

Structs

distantes

otDumpCritPlat

otDumpDebgPlat

otDumpInfoPlat

otDumpNotePlat

otDumpWarnPlat

otLogCli

otLogCritPlat

otLogDebgPlat

otLogGenerateNextHexDumpLine

otLogInfoPlat

otLogNotePlat

otLogPlat

otLogPlatArgs

otLogWarnPlat

otLoggingGetLevel

otLoggingSetLevel

Macros

OT_LOG_HEX_DUMP_LINE_SIZE

Ressources