awtk/docs/manual/log_t.md

191 lines
4.0 KiB
Markdown
Raw Normal View History

2019-11-26 17:08:01 +08:00
## log\_t
### 概述
log。
----------------------------------
### 函数
<p id="log_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2019-12-14 13:25:56 +08:00
| <a href="#log_t_log_debug">log\_debug</a> | 输出调试信息。 |
| <a href="#log_t_log_error">log\_error</a> | 输出错误信息。 |
2019-11-26 17:08:01 +08:00
| <a href="#log_t_log_get_log_level">log\_get\_log\_level</a> | 获取log的级别。 |
2019-12-14 13:25:56 +08:00
| <a href="#log_t_log_info">log\_info</a> | 输出参考信息。 |
2022-12-05 12:10:53 +08:00
| <a href="#log_t_log_notify_debugger">log\_notify\_debugger</a> | 用于debugger拦截日志发送给客户端。 |
| <a href="#log_t_log_set_debugger_hook">log\_set\_debugger\_hook</a> | 设置调试器的钩子函数。 |
2019-11-26 17:08:01 +08:00
| <a href="#log_t_log_set_log_level">log\_set\_log\_level</a> | 设置log的级别。 |
2019-12-14 13:25:56 +08:00
| <a href="#log_t_log_warn">log\_warn</a> | 输出警告信息。 |
2019-11-26 17:08:01 +08:00
#### log\_debug 函数
-----------------------
* 函数功能:
2019-12-14 13:25:56 +08:00
> <p id="log_t_log_debug">输出调试信息。
> 变参函数。
```
log_debug("debug message\n");
```
2019-11-26 17:08:01 +08:00
* 函数原型:
```
void log_debug (const char* format);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无返回值。 |
| format | const char* | 格式或信息。 |
#### log\_error 函数
-----------------------
* 函数功能:
2019-12-14 13:25:56 +08:00
> <p id="log_t_log_error">输出错误信息。
> 变参函数。
```
log_error("error message\n");
```
2019-11-26 17:08:01 +08:00
* 函数原型:
```
void log_error (const char* format);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无返回值。 |
| format | const char* | 格式或信息。 |
#### log\_get\_log\_level 函数
-----------------------
* 函数功能:
> <p id="log_t_log_get_log_level">获取log的级别。
* 函数原型:
```
log_level_t log_get_log_level ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | log\_level\_t | 返回log的级别。 |
#### log\_info 函数
-----------------------
* 函数功能:
2019-12-14 13:25:56 +08:00
> <p id="log_t_log_info">输出参考信息。
> 变参函数。
```
log_info("info message\n");
```
2019-11-26 17:08:01 +08:00
* 函数原型:
```
void log_info (const char* format);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无返回值。 |
| format | const char* | 格式或信息。 |
2022-12-05 12:10:53 +08:00
#### log\_notify\_debugger 函数
-----------------------
* 函数功能:
> <p id="log_t_log_notify_debugger">用于debugger拦截日志发送给客户端。
> 变参函数。
* 函数原型:
```
ret_t log_notify_debugger (const char* format);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| format | const char* | 格式或信息。 |
#### log\_set\_debugger\_hook 函数
-----------------------
* 函数功能:
> <p id="log_t_log_set_debugger_hook">设置调试器的钩子函数。
* 函数原型:
```
ret_t log_set_debugger_hook (tk_debugger_log_t log, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| log | tk\_debugger\_log\_t | 回调函数。 |
| ctx | void* | 回调函数的上下文。 |
2019-11-26 17:08:01 +08:00
#### log\_set\_log\_level 函数
-----------------------
* 函数功能:
> <p id="log_t_log_set_log_level">设置log的级别。
* 函数原型:
```
ret_t log_set_log_level (log_level_t log_level);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| log\_level | log\_level\_t | log的级别。 |
#### log\_warn 函数
-----------------------
* 函数功能:
2019-12-14 13:25:56 +08:00
> <p id="log_t_log_warn">输出警告信息。
> 变参函数。
```
log_warn("warn message\n");
```
2019-11-26 17:08:01 +08:00
* 函数原型:
```
void log_warn (const char* format);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无返回值。 |
| format | const char* | 格式或信息。 |