Logging – Thread-Stack

Dieses Modul enthält Definitionen für das OpenThread-Logging.

Zusammenfassung

Funktionen
otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
Erzeugt einen Speicherdump auf kritischer Logebene.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Erzeugt einen Speicherdump auf Debug-Logebene.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Erzeugt einen Speicherdump auf Informationslogebene.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Erzeugt einen Speicherdump auf Hinweislogebene.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Erzeugt einen Speicherdump auf Warn-Logebene.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
Gibt eine Lognachricht auf einer bestimmten Logebene aus.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
Gibt eine Lognachricht auf kritischer Logebene aus.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
Gibt eine Lognachricht auf Debug-Logebene aus.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)
Generiert die nächste Hex-Dump-Zeile.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
Gibt eine Lognachricht auf Informationslogebene aus.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
Gibt eine Lognachricht auf Notiz-Logebene aus.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
void
Gibt eine Lognachricht auf der angegebenen Logebene unter Verwendung eines Plattformmodulnamens aus.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
void void
Gibt eine Lognachricht auf der angegebenen Logebene unter Verwendung eines Plattformmodulnamens aus.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
Gibt eine Lognachricht auf Logebene mit Warnungen aus.
otLoggingGetLevel(void)
Gibt die aktuelle Logebene zurück.
otLoggingSetLevel(otLogLevel aLogLevel)
Legt die Logebene fest.

Strukturen
otLogHexDumpInfo

Stellt Informationen zum Generieren der Hex-Dump-Ausgabe dar.

Funktionen

otDumpCritPlat

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

Erzeugt einen Speicherdump auf kritischer Logebene.

Wenn OPENTHREAD_CONFIG_LOG_PLATFORM oder OPENTHREAD_CONFIG_LOG_PKT_DUMP nicht festgelegt ist oder die aktuelle Logebene unter kritisch liegt, gibt diese Funktion keine Logmeldungen aus.

Details
Parameter
[in] aText
Ein String, der vor den Byte ausgegeben wird.
[in] aData
Ein Zeiger auf den Datenpuffer.
[in] aDataLength
Anzahl der Byte in aData.

otDumpDebgPlat

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

Erzeugt einen Speicherdump auf Debug-Logebene.

Wenn OPENTHREAD_CONFIG_LOG_PLATFORM oder OPENTHREAD_CONFIG_LOG_PKT_DUMP nicht festgelegt ist oder die aktuelle Logebene unter der Debug-Ebene liegt, gibt diese Funktion keine Logmeldungen aus.

Details
Parameter
[in] aText
Ein String, der vor den Byte ausgegeben wird.
[in] aData
Ein Zeiger auf den Datenpuffer.
[in] aDataLength
Anzahl der Byte in aData.

otDumpInfoPlat

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

Erzeugt einen Speicherdump auf Informationslogebene.

Wenn OPENTHREAD_CONFIG_LOG_PLATFORM oder OPENTHREAD_CONFIG_LOG_PKT_DUMP nicht festgelegt ist oder die aktuelle Logebene unter den Informationen liegt, gibt diese Funktion keine Lognachricht aus.

Details
Parameter
[in] aText
Ein String, der vor den Byte ausgegeben wird.
[in] aData
Ein Zeiger auf den Datenpuffer.
[in] aDataLength
Anzahl der Byte in aData.

otDumpNotePlat

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

Erzeugt einen Speicherdump auf Hinweislogebene.

Wenn OPENTHREAD_CONFIG_LOG_PLATFORM oder OPENTHREAD_CONFIG_LOG_PKT_DUMP nicht festgelegt ist oder die aktuelle Logebene darunter liegt, gibt diese Funktion keine Lognachrichten aus.

Details
Parameter
[in] aText
Ein String, der vor den Byte ausgegeben wird.
[in] aData
Ein Zeiger auf den Datenpuffer.
[in] aDataLength
Anzahl der Byte in aData.

otDumpWarnPlat

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

Erzeugt einen Speicherdump auf Warn-Logebene.

Wenn OPENTHREAD_CONFIG_LOG_PLATFORM oder OPENTHREAD_CONFIG_LOG_PKT_DUMP nicht festgelegt ist oder die aktuelle Logebene unter der Warnung liegt, gibt diese Funktion keine Logmeldungen aus.

Details
Parameter
[in] aText
Ein String, der vor den Byte ausgegeben wird.
[in] aData
Ein Zeiger auf den Datenpuffer.
[in] aDataLength
Anzahl der Byte in aData.

otLogCli

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

Gibt eine Lognachricht auf einer bestimmten Logebene aus.

Ist nur für die Verwendung über die Befehlszeile vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_CLI nicht festgelegt ist oder die aktuelle Logebene unter der angegebenen Logebene liegt, gibt diese Funktion keine Lognachrichten aus.

Details
Parameter
[in] aLogLevel
Die Logebene.
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLogCritPlat

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

Gibt eine Lognachricht auf kritischer Logebene aus.

Ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter kritisch liegt, gibt diese Funktion keine Lognachrichten aus.

Details
Parameter
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLogDebgPlat

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

Gibt eine Lognachricht auf Debug-Logebene aus.

Ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter der Fehlerbehebung liegt, gibt diese Funktion keine Lognachrichten aus.

Details
Parameter
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Generiert die nächste Hex-Dump-Zeile.

Diese Methode kann nacheinander aufgerufen werden, um die Ausgabe des Hex-Dumps Zeile für Zeile zu generieren. Beim ersten Aufruf MUSS das Feld mIterator in aInfo auf null gesetzt werden.

Hier ist ein Beispiel für die generierte Hex-Dump-Ausgabe:

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

Details
Parameter
[in,out] aInfo
Ein Zeiger auf otLogHexDumpInfo, der zum Generieren des Hex-Dumps verwendet werden soll.
Rückgabewerte
OT_ERROR_NONE
Die nächste Zeile wurde generiert. Das Feld „mLine“ in „aInfo“ wurde aktualisiert.
OT_ERROR_NOT_FOUND
Sie haben das Ende erreicht und es muss keine weitere Zeile generiert werden.

otLogInfoPlat

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

Gibt eine Lognachricht auf Informationslogebene aus.

Ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter den Informationen liegt, gibt diese Funktion keine Lognachricht aus.

Details
Parameter
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLogNotePlat

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

Gibt eine Lognachricht auf Notiz-Logebene aus.

Ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter dem Hinweis liegt, gibt diese Funktion keine Lognachrichten aus.

Details
Parameter
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLogPlat

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

Gibt eine Lognachricht auf der angegebenen Logebene unter Verwendung eines Plattformmodulnamens aus.

Dies ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter aLogLevel liegt , gibt diese Funktion keine Lognachrichten aus.

Mit dem Namen aPlatModuleName wird der Name des Logmoduls in der ausgegebenen Lognachricht im Format P-{PlatModuleName}--- bestimmt. Das bedeutet, dass der Präfixstring „P-“ hinzugefügt wird, um anzugeben, dass es sich um ein Plattform-Submodul handelt, gefolgt von den nächsten 12 Zeichen des PlatModuleName-Strings mit aufgefüllten Bindestrichen - am Ende, um sicherzustellen, dass der Regionsname 14 Zeichen lang ist.

Details
Parameter
[in] aLogLevel
Die Logebene.
[in] aPlatModuleName
Der Name des untergeordneten Plattformmoduls.
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLogPlatArgs

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

Gibt eine Lognachricht auf der angegebenen Logebene unter Verwendung eines Plattformmodulnamens aus.

Dies ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter aLogLevel liegt , gibt diese Funktion keine Lognachrichten aus.

Mit dem Namen aPlatModuleName wird der Name des Logmoduls in der ausgegebenen Lognachricht im Format P-{PlatModuleName}--- bestimmt. Das bedeutet, dass der Präfixstring „P-“ hinzugefügt wird, um anzugeben, dass es sich um ein Plattform-Submodul handelt, gefolgt von den nächsten 12 Zeichen des PlatModuleName-Strings mit aufgefüllten Bindestrichen - am Ende, um sicherzustellen, dass der Regionsname 14 Zeichen lang ist.

Details
Parameter
[in] aLogLevel
Die Logebene.
[in] aPlatModuleName
Der Name des untergeordneten Plattformmoduls.
[in] aFormat
Formatstring.
[in] aArgs
Argumente für die Formatspezifikation.

otLogWarnPlat

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

Gibt eine Lognachricht auf Logebene mit Warnungen aus.

Ist für die Verwendung durch die Plattform vorgesehen. Wenn OPENTHREAD_CONFIG_LOG_PLATFORM nicht festgelegt ist oder die aktuelle Logebene unter der Warnung liegt, gibt diese Funktion keine Logmeldungen aus.

Details
Parameter
[in] aFormat
Formatstring.
[in] ...
Argumente für die Formatspezifikation.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Gibt die aktuelle Logebene zurück.

Wenn die Funktion OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE der dynamischen Logebene aktiviert ist, gibt diese Funktion die aktuell festgelegte dynamische Logebene zurück. Andernfalls gibt diese Funktion die für die Build-Zeit konfigurierte Logebene zurück.

Details
Rückgabe
Die Logebene.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Legt die Logebene fest.

Details
Parameter
[in] aLogLevel
Die Logebene.
Rückgabewerte
OT_ERROR_NONE
Die Protokollebene wurde aktualisiert.
OT_ERROR_INVALID_ARGS
Der Wert der Protokollebene ist ungültig.

Makros

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Stringgröße für Hex-Dumpzeile

Ressourcen

OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.