Logging - Thread Stack#
This module includes OpenThread logging related definitions.
Functions#
This function returns the current log level.
This function sets the log level.
This function emits a log message at critical log level.
This function emits a log message at warning log level.
This function emits a log message at note log level.
This function emits a log message at info log level.
This function emits a log message at debug log level.
This function generates a memory dump at critical log level.
This function generates a memory dump at warning log level.
This function generates a memory dump at note log level.
This function generates a memory dump at info log level.
This function generates a memory dump at debug log level.
This function emits a log message at a given log level.
Function Documentation#
otLoggingGetLevel#
otLogLevel otLoggingGetLevel (void )
This function returns the current log level.
N/A |
If dynamic log level feature OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE
is enabled, this function returns the currently set dynamic log level. Otherwise, this function returns the build-time configured log level.
Returns
The log level.
64
of file include/openthread/logging.h
otLoggingSetLevel#
otError otLoggingSetLevel (otLogLevel aLogLevel)
This function sets the log level.
[in] | aLogLevel | The log level. |
Note
This function requires
OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1
.
77
of file include/openthread/logging.h
otLogCritPlat#
void otLogCritPlat (const char * aFormat, ... )
This function emits a log message at critical log level.
[in] | aFormat | The format string. |
[in] | Arguments for the format specification. |
This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM
is not set or the current log level is below critical, this function does not emit any log message.
89
of file include/openthread/logging.h
otLogWarnPlat#
void void otLogWarnPlat (const char * aFormat, ... )
This function emits a log message at warning log level.
[in] | aFormat | The format string. |
[in] | Arguments for the format specification. |
This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM
is not set or the current log level is below warning, this function does not emit any log message.
101
of file include/openthread/logging.h
otLogNotePlat#
void void void otLogNotePlat (const char * aFormat, ... )
This function emits a log message at note log level.
[in] | aFormat | The format string. |
[in] | Arguments for the format specification. |
This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM
is not set or the current log level is below note, this function does not emit any log message.
113
of file include/openthread/logging.h
otLogInfoPlat#
void void void void otLogInfoPlat (const char * aFormat, ... )
This function emits a log message at info log level.
[in] | aFormat | The format string. |
[in] | Arguments for the format specification. |
This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM
is not set or the current log level is below info, this function does not emit any log message.
125
of file include/openthread/logging.h
otLogDebgPlat#
void void void void void otLogDebgPlat (const char * aFormat, ... )
This function emits a log message at debug log level.
[in] | aFormat | The format string. |
[in] | Arguments for the format specification. |
This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM
is not set or the current log level is below debug, this function does not emit any log message.
137
of file include/openthread/logging.h
otDumpCritPlat#
void void void void void void otDumpCritPlat (const char * aText, const void * aData, uint16_t aDataLength)
This function generates a memory dump at critical log level.
[in] | aText | A string that is printed before the bytes. |
[in] | aData | A pointer to the data buffer. |
[in] | aDataLength | Number of bytes in |
If OPENTHREAD_CONFIG_LOG_PLATFORM
or OPENTHREAD_CONFIG_LOG_PKT_DUMP
is not set or the current log level is below critical this function does not emit any log message.
150
of file include/openthread/logging.h
otDumpWarnPlat#
void otDumpWarnPlat (const char * aText, const void * aData, uint16_t aDataLength)
This function generates a memory dump at warning log level.
[in] | aText | A string that is printed before the bytes. |
[in] | aData | A pointer to the data buffer. |
[in] | aDataLength | Number of bytes in |
If OPENTHREAD_CONFIG_LOG_PLATFORM
or OPENTHREAD_CONFIG_LOG_PKT_DUMP
is not set or the current log level is below warning this function does not emit any log message.
163
of file include/openthread/logging.h
otDumpNotePlat#
void otDumpNotePlat (const char * aText, const void * aData, uint16_t aDataLength)
This function generates a memory dump at note log level.
[in] | aText | A string that is printed before the bytes. |
[in] | aData | A pointer to the data buffer. |
[in] | aDataLength | Number of bytes in |
If OPENTHREAD_CONFIG_LOG_PLATFORM
or OPENTHREAD_CONFIG_LOG_PKT_DUMP
is not set or the current log level is below note this function does not emit any log message.
176
of file include/openthread/logging.h
otDumpInfoPlat#
void otDumpInfoPlat (const char * aText, const void * aData, uint16_t aDataLength)
This function generates a memory dump at info log level.
[in] | aText | A string that is printed before the bytes. |
[in] | aData | A pointer to the data buffer. |
[in] | aDataLength | Number of bytes in |
If OPENTHREAD_CONFIG_LOG_PLATFORM
or OPENTHREAD_CONFIG_LOG_PKT_DUMP
is not set or the current log level is below info this function does not emit any log message.
189
of file include/openthread/logging.h
otDumpDebgPlat#
void otDumpDebgPlat (const char * aText, const void * aData, uint16_t aDataLength)
This function generates a memory dump at debug log level.
[in] | aText | A string that is printed before the bytes. |
[in] | aData | A pointer to the data buffer. |
[in] | aDataLength | Number of bytes in |
If OPENTHREAD_CONFIG_LOG_PLATFORM
or OPENTHREAD_CONFIG_LOG_PKT_DUMP
is not set or the current log level is below debug this function does not emit any log message.
202
of file include/openthread/logging.h
otLogCli#
void otLogCli (otLogLevel aLogLevel, const char * aFormat, ... )
This function emits a log message at a given log level.
[in] | aLogLevel | The log level. |
[in] | aFormat | The format string. |
[in] | Arguments for the format specification. |
This function is intended for use by CLI only. If OPENTHREAD_CONFIG_LOG_CLI
is not set or the current log level is below the given log level, this function does not emit any log message.
215
of file include/openthread/logging.h