Logging – stos wątków

Ten moduł zawiera definicje związane z rejestrowaniem OpenThread.

Podsumowanie

Funkcje
otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)	void void void void void void Generuje zrzut pamięci na krytycznym poziomie logu.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)	void Generuje zrzut pamięci na poziomie logu debugowania.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)	void Generuje zrzut pamięci na poziomie logu informacyjnego.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)	void Generuje zrzut pamięci na poziomie logu notatki.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)	void Generuje zrzut pamięci na poziomie logu ostrzegawczego.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2	void Przekazuje komunikat logu na określonym poziomie logu.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1	void Wysyła komunikat logu na krytycznym poziomie.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1	void void void void void Przekazuje komunikat logu na poziomie logu debugowania.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)	otError Generuje następny wiersz zrzutu szesnastkowego.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1	void void void void Przekazuje komunikat logu na poziomie logu informacyjnego.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1	void void void Wysyła komunikat logu na poziomie logu notatki.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3	void Wysyła komunikat logu na danym poziomie logu przy użyciu nazwy modułu platformy.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)	void void Wysyła komunikat logu na danym poziomie logu przy użyciu nazwy modułu platformy.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1	void void Wysyła komunikat logu na poziomie logu z ostrzeżeniem.
otLoggingGetLevel(void)	otLogLevel Zwraca bieżący poziom logu.
otLoggingSetLevel(otLogLevel aLogLevel)	otError Ustawia poziom rejestrowania.

Konstrukcja
otLogHexDumpInfo	Reprezentuje informacje używane do generowania danych wyjściowych zrzutu szesnastkowego.

Funkcje

otDumpCritPlat

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

Generuje zrzut pamięci na krytycznym poziomie logu.

Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM lub OPENTHREAD_CONFIG_LOG_PKT_DUMP nie jest skonfigurowana albo bieżący poziom rejestrowania jest niższy niż krytyczne, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aText Ciąg znaków wyświetlany przed bajtami. [in] aData Wskaźnik do bufora danych. [in] aDataLength Liczba bajtów w pliku aData.

otDumpDebgPlat

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

Generuje zrzut pamięci na poziomie logu debugowania.

Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM lub OPENTHREAD_CONFIG_LOG_PKT_DUMP nie jest ustawiona albo bieżący poziom logu jest poniżej stanu debugowania, ta funkcja nie wysyła żadnego komunikatu logu.

Szczegóły
Parametry	[in] aText Ciąg znaków wyświetlany przed bajtami. [in] aData Wskaźnik do bufora danych. [in] aDataLength Liczba bajtów w pliku aData.

otDumpInfoPlat

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

Generuje zrzut pamięci na poziomie logu informacyjnego.

Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM lub OPENTHREAD_CONFIG_LOG_PKT_DUMP nie jest skonfigurowana albo bieżący poziom rejestrowania jest poniżej informacji, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aText Ciąg znaków wyświetlany przed bajtami. [in] aData Wskaźnik do bufora danych. [in] aDataLength Liczba bajtów w pliku aData.

otDumpNotePlat

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

Generuje zrzut pamięci na poziomie logu notatki.

Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM lub OPENTHREAD_CONFIG_LOG_PKT_DUMP nie jest ustawiona albo bieżący poziom rejestrowania jest niższy niż bieżący, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aText Ciąg znaków wyświetlany przed bajtami. [in] aData Wskaźnik do bufora danych. [in] aDataLength Liczba bajtów w pliku aData.

otDumpWarnPlat

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

Generuje zrzut pamięci na poziomie logu ostrzegawczego.

Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM lub OPENTHREAD_CONFIG_LOG_PKT_DUMP nie jest skonfigurowana albo bieżący poziom logu jest poniżej ostrzeżenia, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aText Ciąg znaków wyświetlany przed bajtami. [in] aData Wskaźnik do bufora danych. [in] aDataLength Liczba bajtów w pliku aData.

otLogCli

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

Przekazuje komunikat logu na określonym poziomie logu.

Jest przeznaczona do użycia tylko w interfejsie wiersza poleceń. Jeśli funkcja OPENTHREAD_CONFIG_LOG_CLI nie jest ustawiona lub bieżący poziom rejestrowania jest niższy niż dany poziom logowania, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aLogLevel Poziom logu. [in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLogCritPlat

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

Wysyła komunikat logu na krytycznym poziomie.

Jest przeznaczona do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest niższy niż krytyczne, ta funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLogDebgPlat

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

Przekazuje komunikat logu na poziomie logu debugowania.

Jest przeznaczona do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest poniżej stanu debugowania, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Generuje następny wiersz zrzutu szesnastkowego.

Może wywoływać tę metodę po kolei, aby wygenerować dane wyjściowe zrzutu szesnastkowego po jednym w wierszu. Przy pierwszym wywołaniu pole mIterator w tabeli aInfo MUSI być ustawione na 0.

Oto przykład generowanych danych wyjściowych zrzutu szesnastkowego:

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

Szczegóły
Parametry	[in,out] aInfo Wskaźnik do otLogHexDumpInfo, który służy do generowania zrzutu szesnastkowego.
Zwracane wartości	OT_ERROR_NONE Wygenerowano następny wiersz, zaktualizowano pole mLine w tabeli aInfo. OT_ERROR_NOT_FOUND Osiągnięto koniec i nie ma więcej wierszy do wygenerowania.

otLogInfoPlat

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

Przekazuje komunikat logu na poziomie logu informacyjnego.

Jest przeznaczona do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest poniżej informacji, ta funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLogNotePlat

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

Wysyła komunikat logu na poziomie logu notatki.

Jest przeznaczona do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest niższy niż uwaga, ta funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLogPlat

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

Wysyła komunikat logu na danym poziomie logu przy użyciu nazwy modułu platformy.

To oznaczenie jest przeznaczone do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest niższy niż aLogLevel , funkcja nie wysyła żadnych komunikatów logu.

Nazwa aPlatModuleName służy do określania nazwy modułu logów w wysyłanym komunikacie logu zgodnie z formatem P-{PlatModuleName}---. Oznacza to, że ciąg prefiksu „P-” wskazuje, że jest to moduł podrzędny platformy, po którym następują kolejne 12 znaków ciągu PlatModuleName z dopełnieniem łączników - na końcu, aby zapewnić, że nazwa regionu będzie miała 14 znaków.

Szczegóły
Parametry	[in] aLogLevel Poziom logu. [in] aPlatModuleName Nazwa modułu podrzędnego platformy. [in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLogPlatArgs

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

Wysyła komunikat logu na danym poziomie logu przy użyciu nazwy modułu platformy.

To oznaczenie jest przeznaczone do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest niższy niż aLogLevel , funkcja nie wysyła żadnych komunikatów logu.

Nazwa aPlatModuleName służy do określania nazwy modułu logów w wysyłanym komunikacie logu zgodnie z formatem P-{PlatModuleName}---. Oznacza to, że ciąg prefiksu „P-” wskazuje, że jest to moduł podrzędny platformy, po którym następują kolejne 12 znaków ciągu PlatModuleName z dopełnieniem łączników - na końcu, aby zapewnić, że nazwa regionu będzie miała 14 znaków.

Szczegóły
Parametry	[in] aLogLevel Poziom logu. [in] aPlatModuleName Nazwa modułu podrzędnego platformy. [in] aFormat Ciąg formatu. [in] aArgs Argumenty specyfikacji formatu.

otLogWarnPlat

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

Wysyła komunikat logu na poziomie logu z ostrzeżeniem.

Jest przeznaczona do użytku przez platformę. Jeśli zasada OPENTHREAD_CONFIG_LOG_PLATFORM nie jest ustawiona lub bieżący poziom rejestrowania jest poniżej ostrzeżenia, funkcja nie wysyła żadnych komunikatów logu.

Szczegóły
Parametry	[in] aFormat Ciąg formatu. [in] ... Argumenty specyfikacji formatu.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Zwraca bieżący poziom logu.

Jeśli włączona jest funkcja dynamicznego poziomu logu OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE, funkcja zwraca obecnie ustawiony dynamiczny poziom logu. W przeciwnym razie ta funkcja zwraca poziom logowania skonfigurowany w czasie kompilacji.

Szczegóły
Zwroty	Poziom logu.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Ustawia poziom rejestrowania.

Uwaga: ta funkcja wymaga OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1.

Szczegóły
Parametry	[in] aLogLevel Poziom logu.
Zwracane wartości	OT_ERROR_NONE Poziom logowania został zaktualizowany. OT_ERROR_INVALID_ARGS Wartość poziomu rejestrowania jest nieprawidłowa.

Makra

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Rozmiar ciągu szesnastkowego wiersza zrzutu.

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.