log_backend.h File Reference

日志后端适配层接口 More...

#include <stddef.h>
#include <stdint.h>
#include "log_config.h"

Go to the source code of this file.

Macros
#define	TBOX_LOGD_D(fmt, ...)
	日志服务专用输出宏
#define	TBOX_LOGD_I(fmt, ...)
#define	TBOX_LOGD_N(fmt, ...)
#define	TBOX_LOGD_W(fmt, ...)
#define	TBOX_LOGD_E(fmt, ...)
#define	TBOX_LOGD_F(fmt, ...)

Functions
int	tbox_log_backend_init (const tbox_log_config_t *config)
	初始化日志后端。
void	tbox_log_backend_deinit (void)
	释放日志后端资源。
int	tbox_log_backend_set_encrypt (uint8_t enabled)
	设置所有日志后端的加密开关。
int	tbox_log_backend_get_encrypt (void)
	获取日志后端当前加密开关。
int	tbox_log_backend_set_level (uint8_t level)
	设置日志后端级别。
int	tbox_log_backend_set_id_level (uint16_t id, uint8_t level)
	设置指定日志对象后端级别。
int	tbox_log_backend_get_id_level (uint16_t id)
	获取指定日志对象后端级别。
int	tbox_log_backend_get_level (void)
	获取全局日志后端级别。
int	tbox_log_backend_has_id_level_override (uint16_t id)
	判断指定日志对象是否存在按 ID 级别覆盖。
int	tbox_log_backend_write (uint8_t level, const char *text)
	通过日志后端写入一条日志。
int	tbox_log_backend_writef (uint8_t level, const char *fmt,...)
	通过日志后端写入一条格式化日志。
int	tbox_log_backend_write_id (uint16_t id, uint8_t level, const char *text)
	通过日志后端向指定对象写入一条日志。
int	tbox_log_backend_write_meta_id (uint16_t id, uint8_t level, uint64_t ts_ms, uint32_t pid, uint32_t tid, const char *text)
	通过日志后端写入一条带元数据的日志。
int	tbox_log_backend_write_hex (uint8_t level, const void *data, size_t len)
	通过日志后端写入一条十六进制日志。
int	tbox_log_backend_write_hex_id (uint16_t id, uint8_t level, const void *data, size_t len)
	通过日志后端向指定对象写入一条十六进制日志。
int	tbox_log_backend_write_hex_meta_id (uint16_t id, uint8_t level, uint64_t ts_ms, uint32_t pid, uint32_t tid, const char *message, const void *data, size_t len)
	通过日志后端向指定对象写入一条带元数据的十六进制日志。

Detailed Description

日志后端适配层接口

Version

1.0.0

Date

2026-06-18

Copyright

Copyright © 2026 Shenzhen One IOT World Co., Ltd. All rights reserved.

Macro Definition Documentation

TBOX_LOGD_D

#define TBOX_LOGD_D	(		fmt,
			... )

Value:

tbox_log_backend_writef(TBOX_LOG_LEVEL_DEBUG, "logd | " fmt, ##__VA_ARGS__)

日志服务专用输出宏

Parameters

fmt	格式化字符串。
...	可变参数。

Note

日志服务专用输出宏，用于输出日志服务相关的日志。

TBOX_LOGD_E

#define TBOX_LOGD_E	(		fmt,
			... )

Value:

tbox_log_backend_writef(TBOX_LOG_LEVEL_ERROR, "logd | " fmt, ##__VA_ARGS__)

TBOX_LOGD_F

#define TBOX_LOGD_F	(		fmt,
			... )

Value:

tbox_log_backend_writef(TBOX_LOG_LEVEL_FATAL, "logd | " fmt, ##__VA_ARGS__)

TBOX_LOGD_I

#define TBOX_LOGD_I	(		fmt,
			... )

Value:

tbox_log_backend_writef(TBOX_LOG_LEVEL_INFO, "logd | " fmt, ##__VA_ARGS__)

TBOX_LOGD_N

#define TBOX_LOGD_N	(		fmt,
			... )

Value:

tbox_log_backend_writef(TBOX_LOG_LEVEL_NOTICE, "logd | " fmt, ##__VA_ARGS__)

TBOX_LOGD_W

#define TBOX_LOGD_W	(		fmt,
			... )

Value:

tbox_log_backend_writef(TBOX_LOG_LEVEL_WARN, "logd | " fmt, ##__VA_ARGS__)

Function Documentation

tbox_log_backend_get_encrypt()

int tbox_log_backend_get_encrypt

(

void

)

获取日志后端当前加密开关。

Returns

0 表示关闭，1 表示开启，失败返回负值

tbox_log_backend_get_id_level()

int tbox_log_backend_get_id_level

(

uint16_t

id

)

获取指定日志对象后端级别。

Parameters

id

日志对象 ID。

Returns

日志级别，失败返回负值

tbox_log_backend_get_level()

int tbox_log_backend_get_level

(

void

)

获取全局日志后端级别。

Returns

日志级别，失败返回负值

tbox_log_backend_has_id_level_override()

int tbox_log_backend_has_id_level_override

(

uint16_t

id

)

判断指定日志对象是否存在按 ID 级别覆盖。

Parameters

id

日志对象 ID。

Returns

非 0 表示存在覆盖，0 表示不存在，失败返回负值

tbox_log_backend_init()

int tbox_log_backend_init

(

const tbox_log_config_t *

config

)

初始化日志后端。

Parameters

config

日志配置。

Returns

0 成功，其他 失败

tbox_log_backend_set_encrypt()

int tbox_log_backend_set_encrypt

(

uint8_t

enabled

)

设置所有日志后端的加密开关。

Parameters

enabled

加密开关，仅允许 0 或 1。

Returns

0 成功，其他 失败

tbox_log_backend_set_id_level()

int tbox_log_backend_set_id_level	(	uint16_t	id,
		uint8_t	level )

设置指定日志对象后端级别。

Parameters

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

Returns

0 成功，其他 失败

tbox_log_backend_set_level()

int tbox_log_backend_set_level

(

uint8_t

level

)

设置日志后端级别。

Parameters

level

目标日志级别。

Returns

0 成功，其他 失败

tbox_log_backend_write()

int tbox_log_backend_write	(	uint8_t	level,
		const char *	text )

通过日志后端写入一条日志。

Parameters

level	日志级别。
text	日志正文。

Returns

0 成功，其他 失败

tbox_log_backend_write_hex()

int tbox_log_backend_write_hex	(	uint8_t	level,
		const void *	data,
		size_t	len )

通过日志后端写入一条十六进制日志。

Parameters

level	日志级别。
data	原始二进制数据。
len	原始二进制数据长度。

Returns

0 成功，其他 失败

tbox_log_backend_write_hex_id()

int tbox_log_backend_write_hex_id	(	uint16_t	id,
		uint8_t	level,
		const void *	data,
		size_t	len )

通过日志后端向指定对象写入一条十六进制日志。

Parameters

id	日志对象 ID。
level	日志级别。
data	原始二进制数据。
len	原始二进制数据长度。

Returns

0 成功，其他 失败

tbox_log_backend_write_hex_meta_id()

int tbox_log_backend_write_hex_meta_id	(	uint16_t	id,
		uint8_t	level,
		uint64_t	ts_ms,
		uint32_t	pid,
		uint32_t	tid,
		const char *	message,
		const void *	data,
		size_t	len )

通过日志后端向指定对象写入一条带元数据的十六进制日志。

Parameters

id	日志对象 ID。
level	日志级别。
ts_ms	原始时间戳，单位毫秒。
pid	原始进程 ID。
tid	原始线程 ID。
message	附加说明信息，可为空。
data	原始二进制数据。
len	原始二进制数据长度。

Returns

0 成功，其他 失败

tbox_log_backend_write_id()

int tbox_log_backend_write_id	(	uint16_t	id,
		uint8_t	level,
		const char *	text )

通过日志后端向指定对象写入一条日志。

Parameters

id	日志对象 ID。
level	日志级别。
text	日志正文。

Returns

0 成功，其他 失败

tbox_log_backend_write_meta_id()

int tbox_log_backend_write_meta_id	(	uint16_t	id,
		uint8_t	level,
		uint64_t	ts_ms,
		uint32_t	pid,
		uint32_t	tid,
		const char *	text )

通过日志后端写入一条带元数据的日志。

Parameters

id	日志对象 ID。
level	日志级别。
ts_ms	原始时间戳，单位毫秒。
pid	原始进程 ID。
tid	原始线程 ID。
text	日志正文。

Returns

0 成功，其他 失败

tbox_log_backend_writef()

int tbox_log_backend_writef	(	uint8_t	level,
		const char *	fmt,
			... )

通过日志后端写入一条格式化日志。

Parameters

level	日志级别。
fmt	日志正文格式化字符串。
...	格式化参数。

Returns

0 成功，其他 失败