test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-02 12:08:16 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
bc0a980207
awtk/docs/manual/tk_thread_t.md

201 lines
5.1 KiB
Markdown
Raw Normal View History

update docs
2019-05-07 14:37:26 +08:00
## tk\_thread\_t
### 概述
update docs
2019-11-15 11:33:43 +08:00
线程对象。
update docs
2019-05-07 14:37:26 +08:00
----------------------------------
### 函数
<p id="tk_thread_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#tk_thread_t_tk_thread_create">tk\_thread\_create</a> | 创建thread对象。 |
| <a href="#tk_thread_t_tk_thread_destroy">tk\_thread\_destroy</a> | 销毁thread对象。 |
update docs
2019-11-15 10:07:18 +08:00
| <a href="#tk_thread_t_tk_thread_get_args">tk\_thread\_get\_args</a> | 获取线程的参数。 |
update docs
2019-05-07 14:37:26 +08:00
| <a href="#tk_thread_t_tk_thread_join">tk\_thread\_join</a> | 等待线程退出。 |
update docs
2020-06-24 12:06:19 +08:00
| <a href="#tk_thread_t_tk_thread_self">tk\_thread\_self</a> | 获取当前线程的原生句柄。 |
update docs
2019-12-14 13:25:56 +08:00
| <a href="#tk_thread_t_tk_thread_set_name">tk\_thread\_set\_name</a> | 设置线程的名称。 |
| <a href="#tk_thread_t_tk_thread_set_priority">tk\_thread\_set\_priority</a> | 设置线程的优先级。 |
| <a href="#tk_thread_t_tk_thread_set_stack_size">tk\_thread\_set\_stack\_size</a> | 设置线程的栈大小。 |
update docs
2019-05-07 14:37:26 +08:00
| <a href="#tk_thread_t_tk_thread_start">tk\_thread\_start</a> | 启动线程。 |
#### tk\_thread\_create 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="tk_thread_t_tk_thread_create">创建thread对象。
update docs
2019-05-07 14:37:26 +08:00
* 函数原型：
```
update docs
2019-10-25 17:53:38 +08:00
tk_thread_t* tk_thread_create (tk_thread_entry_t entry, void* args);
update docs
2019-05-07 14:37:26 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | tk\_thread\_t* | thread对象。 |
update docs
2019-10-25 17:53:38 +08:00
| entry | tk\_thread\_entry\_t | 线程函数。 |
| args | void* | 线程函数的上下文。 |
update docs
2019-05-07 14:37:26 +08:00
#### tk\_thread\_destroy 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="tk_thread_t_tk_thread_destroy">销毁thread对象。
update docs and idls
2020-09-16 09:58:28 +08:00
在销毁对象前必须调用 tk_thread_join 函数等待退出线程
update docs (fix issue #253)
2019-10-16 09:02:32 +08:00
update docs
2019-05-07 14:37:26 +08:00
* 函数原型：
```
ret_t tk_thread_destroy (tk_thread_t* thread);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| thread | tk\_thread\_t* | thread对象。 |
update docs
2019-11-15 10:07:18 +08:00
#### tk\_thread\_get\_args 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="tk_thread_t_tk_thread_get_args">获取线程的参数。
update docs
2019-11-15 10:07:18 +08:00
* 函数原型：
```
void* tk_thread_get_args (tk_thread_t* thread);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void* | 返回线程的参数。 |
| thread | tk\_thread\_t* | thread对象。 |
update docs
2019-05-07 14:37:26 +08:00
#### tk\_thread\_join 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="tk_thread_t_tk_thread_join">等待线程退出。
update docs and idls
2020-09-16 09:58:28 +08:00
必须调用 tk_thread_destroy 函数来释放线程资源，以免出现内存泄漏的问题。
update docs (fix issue #253)
2019-10-16 09:02:32 +08:00
update docs
2019-05-07 14:37:26 +08:00
* 函数原型：
```
ret_t tk_thread_join (tk_thread_t* thread);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| thread | tk\_thread\_t* | thread对象。 |
update docs
2020-06-24 12:06:19 +08:00
#### tk\_thread\_self 函数
-----------------------
* 函数功能：
> <p id="tk_thread_t_tk_thread_self">获取当前线程的原生句柄。
* 函数原型：
```
uint64_t tk_thread_self ();
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint64\_t | 返回当前线程的原生句柄。 |
update docs
2019-10-25 17:53:38 +08:00
#### tk\_thread\_set\_name 函数
-----------------------
* 函数功能：
update docs
2019-12-14 13:25:56 +08:00
> <p id="tk_thread_t_tk_thread_set_name">设置线程的名称。
> 需要在调用start之前调用本函数。
update docs
2019-10-25 17:53:38 +08:00
* 函数原型：
```
ret_t tk_thread_set_name (tk_thread_t* thread, const char* name);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| thread | tk\_thread\_t* | thread对象。 |
| name | const char* | 名称。 |
#### tk\_thread\_set\_priority 函数
-----------------------
* 函数功能：
update docs
2019-12-14 13:25:56 +08:00
> <p id="tk_thread_t_tk_thread_set_priority">设置线程的优先级。
> 部分平台支持。
update docs
2019-10-25 17:53:38 +08:00
* 函数原型：
```
ret_t tk_thread_set_priority (tk_thread_t* thread, uint32_t priority);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| thread | tk\_thread\_t* | thread对象。 |
update docs
2019-11-15 10:07:18 +08:00
| priority | uint32\_t | 优先级。 |
update docs
2019-10-25 17:53:38 +08:00
#### tk\_thread\_set\_stack\_size 函数
-----------------------
* 函数功能：
update docs
2019-12-14 13:25:56 +08:00
> <p id="tk_thread_t_tk_thread_set_stack_size">设置线程的栈大小。
> 需要在调用start之前调用本函数。
update docs
2019-10-25 17:53:38 +08:00
* 函数原型：
```
ret_t tk_thread_set_stack_size (tk_thread_t* thread, uint32_t stack_size);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| thread | tk\_thread\_t* | thread对象。 |
| stack\_size | uint32\_t | 栈的大小。 |
update docs
2019-05-07 14:37:26 +08:00
#### tk\_thread\_start 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="tk_thread_t_tk_thread_start">启动线程。
update docs (fix issue #253)
2019-10-16 09:02:32 +08:00
update docs
2019-05-07 14:37:26 +08:00
* 函数原型：
```
ret_t tk_thread_start (tk_thread_t* thread);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| thread | tk\_thread\_t* | thread对象。 |
Reference in New Issue Copy Permalink