log_config.h File Reference

日志配置接口 More...

#include <tbox/log.h>

Go to the source code of this file.

Data Structures
struct	tbox_log_category_config_t
	单个日志分类配置 More...
struct	tbox_log_config_t
	日志配置 More...

Macros
#define	TBOX_LOG_CATEGORY_NAME_MAX   15
	日志分类名最大长度
#define	TBOX_LOG_CATEGORY_COUNT_MAX   16
	最大日志分类数
#define	TBOX_LOGD_SOCKET_PATH   "/tmp/tbox_logd.sock"
	logd socket 路径
#define	TBOX_LOGD_PID_PATH   "/var/run/tbox_logd.pid"
	pid 文件路径
#define	TBOX_LOGD_ROTATE_SIZE   (3 * 1024 * 1024)
	单个日志文件轮转大小
#define	TBOX_LOGD_ROTATE_COUNT   5
	日志文件保留数量
#define	TBOX_LOGD_MAX_CLIENTS   64
	最大并发客户端数
#define	TBOX_LOGD_MAX_EVENTS   16
	单次 epoll 最大事件数
#define	TBOX_LOGD_ENCRYPT_CODE   0xA5
	默认日志加密码
#define	TBOX_LOG_PROP_LEVEL   "rw.logd.level"
	日志级别属性
#define	TBOX_LOG_PROP_MAX_CLIENTS   "ro.logd.max_clients"
	最大并发客户端数属性
#define	TBOX_LOG_PROP_MAX_EVENTS   "ro.logd.max_events"
	单次 epoll 最大事件数属性
#define	TBOX_LOG_PROP_ENCRYPT   "rw.logd.encrypt"
	日志加密开关属性
#define	TBOX_LOG_PROP_ENCRYPT_CODE   "ro.logd.encrypt_code"
	日志加密码属性
#define	TBOX_LOG_PROP_LEVEL_FMT   "rw.logd.level%u"
	日志级别格式化属性
#define	TBOX_LOG_PROP_OBJECT_FILE_FMT   "ro.logd.file%u"
	日志文件基础路径格式化属性
#define	TBOX_LOG_PROP_OBJECT_ROTATE_SIZE_FMT   "ro.logd.rotate_size%u"
	单个日志文件轮转大小格式化属性
#define	TBOX_LOG_PROP_OBJECT_ROTATE_COUNT_FMT   "ro.logd.rotate_count%u"
	日志文件保留数量格式化属性
#define	TBOX_LOG_PROP_BACKUP_INDEX_FMT   "rw.logd.index%u"
	日志备份序号格式化属性

Functions
void	tbox_log_config_init_defaults (tbox_log_config_t *config)
	使用默认值初始化日志配置。
int	tbox_log_config_load (tbox_log_config_t *config)
	从属性服务加载日志配置。
int	tbox_log_config_store_level (tbox_log_id_t id, int level)
	将指定日志 ID 级别写入属性服务。
int	tbox_log_config_store_global_level (int level)
	将全局日志级别写入属性服务。
int	tbox_log_config_store_encrypt (int enabled)
	将日志加密开关写入属性服务。
int	tbox_log_config_is_category_valid (const char *category)
	判断日志分类名是否有效。
const tbox_log_category_config_t *	tbox_log_config_find_category (const tbox_log_config_t *config, tbox_log_id_t id)
	根据日志 ID 查找分类配置。

Detailed Description

日志配置接口

Version

1.0.0

Date

2026-06-18

Copyright

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

Function Documentation

tbox_log_config_find_category()

const tbox_log_category_config_t * tbox_log_config_find_category	(	const tbox_log_config_t *	config,
		tbox_log_id_t	id )

根据日志 ID 查找分类配置。

Parameters

config	日志配置对象。
id	日志 ID。

Returns

分类配置指针，失败返回 NULL

tbox_log_config_init_defaults()

void tbox_log_config_init_defaults

(

tbox_log_config_t *

config

)

使用默认值初始化日志配置。

Parameters

config

日志配置对象。

tbox_log_config_is_category_valid()

int tbox_log_config_is_category_valid

(

const char *

category

)

判断日志分类名是否有效。

Parameters

category

日志分类名。

Returns

非 0 有效，0 无效

tbox_log_config_load()

int tbox_log_config_load

(

tbox_log_config_t *

config

)

从属性服务加载日志配置。

Parameters

config

日志配置对象。

Returns

0 成功，其他 失败

tbox_log_config_store_encrypt()

int tbox_log_config_store_encrypt

(

int

enabled

)

将日志加密开关写入属性服务。

Parameters

enabled

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

Returns

0 成功，其他 失败

tbox_log_config_store_global_level()

int tbox_log_config_store_global_level

(

int

level

)

将全局日志级别写入属性服务。

Parameters

level

日志级别。

Returns

0 成功，其他 失败

tbox_log_config_store_level()

int tbox_log_config_store_level	(	tbox_log_id_t	id,
		int	level )

将指定日志 ID 级别写入属性服务。

Parameters

id	日志 ID。
level	日志级别。

Returns

0 成功，其他 失败