awtk/docs/manual/tk_istream_udp_t.md
2019-12-11 16:21:15 +08:00

75 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## tk\_istream\_udp\_t
### 概述
![image](images/tk_istream_udp_t_0.png)
基于UDP实现的输入流。
----------------------------------
### 函数
<p id="tk_istream_udp_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#tk_istream_udp_t_tk_istream_udp_create">tk\_istream\_udp\_create</a> | 创建istream对象。 |
| <a href="#tk_istream_udp_t_tk_istream_udp_set_target_with_addr">tk\_istream\_udp\_set\_target\_with\_addr</a> | 设置目标。 |
| <a href="#tk_istream_udp_t_tk_istream_udp_set_target_with_host">tk\_istream\_udp\_set\_target\_with\_host</a> | 设置目标。 |
#### tk\_istream\_udp\_create 函数
-----------------------
* 函数功能:
> <p id="tk_istream_udp_t_tk_istream_udp_create">创建istream对象。
* 函数原型:
```
tk_istream_t* tk_istream_udp_create (int sock);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | tk\_istream\_t* | 返回istream对象。 |
| sock | int | socket。 |
#### tk\_istream\_udp\_set\_target\_with\_addr 函数
-----------------------
* 函数功能:
> <p id="tk_istream_udp_t_tk_istream_udp_set_target_with_addr">设置目标。
* 函数原型:
```
ret_t tk_istream_udp_set_target_with_addr (tk_istream_t* stream, struct sockaddr_in addr);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| stream | tk\_istream\_t* | istream对象。 |
| addr | struct sockaddr\_in | 地址。 |
#### tk\_istream\_udp\_set\_target\_with\_host 函数
-----------------------
* 函数功能:
> <p id="tk_istream_udp_t_tk_istream_udp_set_target_with_host">设置目标。
* 函数原型:
```
ret_t tk_istream_udp_set_target_with_host (tk_istream_t* stream, const char* host, int port);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| stream | tk\_istream\_t* | istream对象。 |
| host | const char* | 主机或IP。 |
| port | int | 端口。 |