TBOX_LOG

T-Box 日志 More...

Macros
#define	TBOX_LOG_DEFAULT_ID   1U
	默认日志 ID
#define	TBOX_LOG_ID_PLATFORM   1U
	平台日志 ID
#define	TBOX_LOG_ID_MCU   2U
	MCU 日志 ID.
#define	TBOX_LOG_ID_SECURITY   3U
	安全日志 ID

Typedefs
typedef unsigned short	tbox_log_id_t
	日志 ID 类型

Enumerations
enum	tbox_log_level_t {   TBOX_LOG_LEVEL_DEBUG = 0 , TBOX_LOG_LEVEL_INFO = 1 , TBOX_LOG_LEVEL_NOTICE = 2 , TBOX_LOG_LEVEL_WARN = 3 ,   TBOX_LOG_LEVEL_ERROR = 4 , TBOX_LOG_LEVEL_FATAL = 5 , TBOX_LOG_LEVEL_NOLOG = 6 }
	日志级别 More...

Functions
int	tbox_log_init (void)
	初始化日志客户端。
void	tbox_log_deinit (void)
	释放日志客户端资源。
int	tbox_log_set_id (tbox_log_id_t id)
	设置当前客户端默认日志 ID。
int	tbox_log_get_id (tbox_log_id_t *id)
	获取当前客户端默认日志 ID。
int	tbox_log_set_level (tbox_log_level_t level)
	设置 tbox_logd 当前日志级别。
int	tbox_log_set_encrypt (bool enabled)
	设置 tbox_logd 日志加密开关。
int	tbox_log_set_id_level (tbox_log_id_t id, tbox_log_level_t level)
	设置指定日志 ID 当前日志级别。
int	tbox_log_get_level (tbox_log_level_t *level)
	获取 tbox_logd 当前日志级别。
int	tbox_log_get_id_level (tbox_log_id_t id, tbox_log_level_t *level)
	获取指定日志 ID 当前日志级别。
int	tbox_log_write (tbox_log_level_t level, const char *format,...)
	写入一条格式化日志。
int	tbox_log_write_id (tbox_log_id_t id, tbox_log_level_t level, const char *format,...)
	向指定日志 ID 写入一条格式化日志。
int	tbox_log_write_hex (tbox_log_level_t level, const void *data, size_t len, const char *format,...)
	写入一条二进制 hex 日志。
int	tbox_log_write_hex_id (tbox_log_id_t id, tbox_log_level_t level, const void *data, size_t len, const char *format,...)
	向指定日志 ID 写入一条二进制 hex 日志。

Detailed Description

T-Box 日志

Enumeration Type Documentation

tbox_log_level_t

enum tbox_log_level_t

日志级别

Enumerator
TBOX_LOG_LEVEL_DEBUG	调试日志级别
TBOX_LOG_LEVEL_INFO	信息日志级别
TBOX_LOG_LEVEL_NOTICE	通知日志级别
TBOX_LOG_LEVEL_WARN	警告日志级别
TBOX_LOG_LEVEL_ERROR	错误日志级别
TBOX_LOG_LEVEL_FATAL	致命错误日志级别
TBOX_LOG_LEVEL_NOLOG	不记录日志级别

Function Documentation

tbox_log_get_id()

int tbox_log_get_id

(

tbox_log_id_t *

id

)

获取当前客户端默认日志 ID。

Parameters

id

输出日志 ID。

Returns

0 成功，其他 失败

tbox_log_get_id_level()

int tbox_log_get_id_level	(	tbox_log_id_t	id,
		tbox_log_level_t *	level )

获取指定日志 ID 当前日志级别。

Parameters

id	目标日志 ID。
level	输出日志级别。

Returns

0 成功，其他 失败

tbox_log_get_level()

int tbox_log_get_level

(

tbox_log_level_t *

level

)

获取 tbox_logd 当前日志级别。

Parameters

level

输出日志级别。

Returns

0 成功，其他 失败

tbox_log_init()

int tbox_log_init

(

void

)

初始化日志客户端。

Returns

0 成功，其他 失败

tbox_log_set_encrypt()

int tbox_log_set_encrypt

(

bool

enabled

)

设置 tbox_logd 日志加密开关。

加密码由只读配置提供，本接口仅控制是否启用加密。

Parameters

enabled

true 开启加密，false 关闭加密。

Returns

0 成功，其他 失败

tbox_log_set_id()

int tbox_log_set_id

(

tbox_log_id_t

id

)

设置当前客户端默认日志 ID。

Parameters

id

目标日志 ID。

Returns

0 成功，其他 失败

tbox_log_set_id_level()

int tbox_log_set_id_level	(	tbox_log_id_t	id,
		tbox_log_level_t	level )

设置指定日志 ID 当前日志级别。

Parameters

id	目标日志 ID。
level	目标日志级别。

Returns

0 成功，其他 失败

tbox_log_set_level()

int tbox_log_set_level

(

tbox_log_level_t

level

)

设置 tbox_logd 当前日志级别。

Parameters

level

目标日志级别。

Returns

0 成功，其他 失败

tbox_log_write()

int tbox_log_write	(	tbox_log_level_t	level,
		const char *	format,
			... )

写入一条格式化日志。

Parameters

level	日志级别。
format	printf 风格格式串。
...	格式化参数。

Returns

0 成功，其他 失败

tbox_log_write_hex()

int tbox_log_write_hex	(	tbox_log_level_t	level,
		const void *	data,
		size_t	len,
		const char *	format,
			... )

写入一条二进制 hex 日志。

Parameters

level	日志级别。
data	原始二进制数据。
len	原始二进制数据长度。
format	printf 风格格式串，可为空表示无说明信息。
...	格式化参数。

Returns

0 成功，其他 失败

tbox_log_write_hex_id()

int tbox_log_write_hex_id	(	tbox_log_id_t	id,
		tbox_log_level_t	level,
		const void *	data,
		size_t	len,
		const char *	format,
			... )

向指定日志 ID 写入一条二进制 hex 日志。

Parameters

id	目标日志 ID。
level	日志级别。
data	原始二进制数据。
len	原始二进制数据长度。
format	printf 风格格式串，可为空表示无说明信息。
...	格式化参数。

Returns

0 成功，其他 失败

tbox_log_write_id()

int tbox_log_write_id	(	tbox_log_id_t	id,
		tbox_log_level_t	level,
		const char *	format,
			... )

向指定日志 ID 写入一条格式化日志。

Parameters

id	目标日志 ID。
level	日志级别。
format	printf 风格格式串。
...	格式化参数。

Returns

0 成功，其他 失败