1@page select select
2
3[更正文档](https://gitee.com/alios-things/select/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6select组件实现了IO多路复用机制select和poll。
7
8组件支持以下功能：
9- select
10- poll
11
12支持以下几种场景：
13- socket fd事件通知；
14- VFS fd事件通知；
15- socket与VFS fd混合通知。
16
17## 版权信息
18> Apache license v2.0
19
20## 目录结构
21```tree
22.
23├── example        #示例程序
24│   ├── select_example.c
25│   └── test_device.c
26├── include
27│   └── select.h   # 对外头文件
28├── package.yaml   # 编译文件
29├── poll
30│   └── poll.c     # aos_poll接口实现
31├── README.md      # 说明文档
32└── select
33    └── select.c   # aos_select接口实现
34
35```
36
37## 依赖组件
38* osal_aos
39* vfs
40
41# 常用配置
42系统中相关配置已有默认值，如需修改配置，统一在yaml中**def_config**节点修改，具体如下：
43
44配置fd_set中fd最大值:
45```yaml
46def_config:
47  FD_SETSIZE: 64  # 配置fd_set大小。注意必须大于VFS组件中的 VFS_CONFIG_FD_OFFSET 数值！
48```
49# API说明
50
51aos_select/aos_poll功能定义与posix标准的select/poll兼容，可参考linux相关接口文档:
52
53- 参考 [select](https://man7.org/linux/man-pages/man2/select.2.html)
54- 参考 [poll](https://man7.org/linux/man-pages/man2/poll.2.html)
55
56
57# 使用示例
58组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
59待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
60
61## 步骤1 创建或打开工程
62
63**打开已有工程**
64
65如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
66
67**创建新的工程**
68
69组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
70
71## 步骤2 添加组件
72
73案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
74```sh
75depends:
76  - select: master # helloworld_demo中引入select组件
77```
78## 步骤3 下载组件
79
80在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
81
82```shell
83
84aos install select
85
86```
87
88上述命令执行成功后，组件源码则被下载到了./components/select路径中。
89
90## 步骤4 添加示例
91
92在select组件的package.yaml中添加example：
93```yaml
94source_file:
95  - "src/*.c"
96  - "example/*.c" # add example source
97```
98
99## 步骤5 编译固件
100
101在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
102
103## 步骤6 烧录固件
104
105helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
106
107## 步骤7 打开串口
108
109固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
110
111当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
112
113## 步骤8 测试示例
114
115在串口终端输入cli命令：
116```sh
117select_example
118```
119可看到如下打印：
120```sh
121select_example
122+++++++select example+++++++++
123aos_select timeout:ret = 0
124aos_select ret = 1
125 read fd =49,data = 1
126+++++++poll example+++++++++
127aos_poll timeout, ret = 0
128aos_poll ret = 1
129 read fd =49,data = 1
130```
131# 注意事项
132无
133
134# FAQ
135无
136