Logging - Stack thread

Questo modulo include le definizioni relative al logging OpenThread.

Riepilogo

Funzioni

otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
Genera un dump della memoria a livello di log critico.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un dump della memoria a livello di log di debug.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un dump della memoria a livello di info log.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un dump della memoria a livello di log delle note.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
Genera un dump della memoria a livello di log di avviso.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
Emette un messaggio di log a un determinato livello di log.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
Emette un messaggio di log a livello di log critico.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
Emette un messaggio di log a livello di log di debug.
otLogGenerateNextHexDumpLine(otLogHexDumpInfo *aInfo)
Genera la riga di dump esadecimale successiva.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
Emette un messaggio di log a livello di log informazioni.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
Emette un messaggio di log a livello di log delle note.
otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3
void
Emette un messaggio di log a un determinato livello di log utilizzando il nome di un modulo della piattaforma.
otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
void void
Emette un messaggio di log a un determinato livello di log utilizzando il nome di un modulo della piattaforma.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
Emette un messaggio di log a livello di log di avviso.
otLoggingGetLevel(void)
Restituisce il livello di log corrente.
otLoggingSetLevel(otLogLevel aLogLevel)
Imposta il livello di log.

Strutture

otLogHexDumpInfo

Rappresenta le informazioni utilizzate per generare un output di dump esadecimale.

Funzioni

otDumpCritPlat

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

Genera un dump della memoria a livello di log critico.

Se OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP non sono impostati o il livello di log corrente è inferiore a quello critico, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aText
Una stringa che viene stampata prima dei byte.
[in] aData
Un puntatore al buffer dei dati.
[in] aDataLength
Numero di byte in aData.

otDumpDebgPlat

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

Genera un dump della memoria a livello di log di debug.

Se OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP non è impostato o il livello di log attuale è inferiore al debug, questa funzione non emette alcun messaggio di log.

Dettagli
Parametri
[in] aText
Una stringa che viene stampata prima dei byte.
[in] aData
Un puntatore al buffer dei dati.
[in] aDataLength
Numero di byte in aData.

otDumpInfoPlat

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

Genera un dump della memoria a livello di info log.

Se OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP non sono impostati o il livello di log corrente è inferiore a info, questa funzione non emette alcun messaggio di log.

Dettagli
Parametri
[in] aText
Una stringa che viene stampata prima dei byte.
[in] aData
Un puntatore al buffer dei dati.
[in] aDataLength
Numero di byte in aData.

otDumpNotePlat

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

Genera un dump della memoria a livello di log delle note.

Se OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP non sono impostati o il livello di log corrente è inferiore, tieni presente che questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aText
Una stringa che viene stampata prima dei byte.
[in] aData
Un puntatore al buffer dei dati.
[in] aDataLength
Numero di byte in aData.

otDumpWarnPlat

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

Genera un dump della memoria a livello di log di avviso.

Se OPENTHREAD_CONFIG_LOG_PLATFORM o OPENTHREAD_CONFIG_LOG_PKT_DUMP non sono impostati o il livello di log corrente è inferiore a questo avviso, questa funzione non emette alcun messaggio di log.

Dettagli
Parametri
[in] aText
Una stringa che viene stampata prima dei byte.
[in] aData
Un puntatore al buffer dei dati.
[in] aDataLength
Numero di byte in aData.

otLogCli

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

Emette un messaggio di log a un determinato livello di log.

È destinato esclusivamente all'utilizzo tramite interfaccia a riga di comando. Se OPENTHREAD_CONFIG_LOG_CLI non è impostato o il livello di log corrente è inferiore al livello di log specificato, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aLogLevel
Il livello di log.
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLogCritPlat

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

Emette un messaggio di log a livello di log critico.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log corrente è inferiore a quello critico, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLogDebgPlat

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

Emette un messaggio di log a livello di log di debug.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log attuale è inferiore al debug, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLogGenerateNextHexDumpLine

otError otLogGenerateNextHexDumpLine(
  otLogHexDumpInfo *aInfo
)

Genera la riga di dump esadecimale successiva.

Puoi richiamare questo metodo in sequenza per generare l'output del dump esadecimale riga per riga. Alla prima chiamata, il campo mIterator in aInfo DEVE essere impostato su zero.

Ecco un esempio dell'output del dump esadecimale generato:

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

Dettagli
Parametri
[in,out] aInfo
Un puntatore a otLogHexDumpInfo da utilizzare per generare il dump esadecimale.
Valori restituiti
OT_ERROR_NONE
La riga successiva è stata generata correttamente, il campo mLine in aInfo è stato aggiornato.
OT_ERROR_NOT_FOUND
Raggiunta la fine e non c'è più linea da generare.

otLogInfoPlat

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

Emette un messaggio di log a livello di log informazioni.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log corrente è inferiore a quello specificato, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLogNotePlat

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

Emette un messaggio di log a livello di log delle note.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log corrente è inferiore alla nota, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLogPlat

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

Emette un messaggio di log a un determinato livello di log utilizzando il nome di un modulo della piattaforma.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log corrente è inferiore a aLogLevel , questa funzione non emette messaggi di log.

Il nome aPlatModuleName viene utilizzato per determinare il nome del modulo di log nel messaggio di log emesso, nel formato P-{PlatModuleName}---. Ciò significa che viene aggiunta la stringa prefisso "P-" per indicare che si tratta di un sottomodulo della piattaforma, seguito dai 12 caratteri successivi della stringa PlatModuleName, con trattini imbottiti - alla fine per garantire che il nome della regione abbia una lunghezza di 14 caratteri.

Dettagli
Parametri
[in] aLogLevel
Il livello di log.
[in] aPlatModuleName
Il nome del sottomodulo della piattaforma.
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLogPlatArgs

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

Emette un messaggio di log a un determinato livello di log utilizzando il nome di un modulo della piattaforma.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log corrente è inferiore a aLogLevel , questa funzione non emette messaggi di log.

Il nome aPlatModuleName viene utilizzato per determinare il nome del modulo di log nel messaggio di log emesso, nel formato P-{PlatModuleName}---. Ciò significa che viene aggiunta la stringa prefisso "P-" per indicare che si tratta di un sottomodulo della piattaforma, seguito dai 12 caratteri successivi della stringa PlatModuleName, con trattini imbottiti - alla fine per garantire che il nome della regione abbia una lunghezza di 14 caratteri.

Dettagli
Parametri
[in] aLogLevel
Il livello di log.
[in] aPlatModuleName
Il nome del sottomodulo della piattaforma.
[in] aFormat
La stringa del formato.
[in] aArgs
Argomenti per la specifica del formato.

otLogWarnPlat

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

Emette un messaggio di log a livello di log di avviso.

È destinato all'utilizzo da parte della piattaforma. Se OPENTHREAD_CONFIG_LOG_PLATFORM non è impostato o il livello di log corrente è inferiore all'avviso, questa funzione non emette messaggi di log.

Dettagli
Parametri
[in] aFormat
La stringa del formato.
[in] ...
Argomenti per la specifica del formato.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

Restituisce il livello di log corrente.

Se la funzionalità a livello di log dinamico OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE è abilitata, questa funzione restituisce il livello di log dinamico attualmente impostato. In caso contrario, questa funzione restituisce il livello di log configurato in fase di build.

Dettagli
Restituisce
Il livello di log.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

Imposta il livello di log.

Dettagli
Parametri
[in] aLogLevel
Il livello di log.
Valori restituiti
OT_ERROR_NONE
Livello di log aggiornato correttamente.
OT_ERROR_INVALID_ARGS
Il valore a livello di log non è valido.

Macro

OT_LOG_HEX_DUMP_LINE_SIZE

 OT_LOG_HEX_DUMP_LINE_SIZE 73

Dimensioni della stringa della riga di dump esadecimale.

Risorse

Gli argomenti di riferimento dell'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per saperne di più o per contribuire alla nostra documentazione, consulta la sezione Risorse.