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