epoll

更正文档      贡献说明

概述

epoll实现了linux兼容的高效的IO多路复用机制epoll.

支持以下几种场景:

  • socket fd事件通知;
  • VFS fd事件通知;
  • socket与VFS fd混合事件通知。

版权信息

Apache license v2.0

目录结构

.
├── example # 示例程序
│   ├── epoll_example.c
│   └── test_device.c
├── include
│   ├── epoll.h # 对外头文件
│   ├── poll.h # 系统中无poll功能时poll的数据结构定义,常用与驱动开发
│   └── private
│   ├── epoll_inner.h # epoll内部数据结构
│   └── rbtree_wrapper.h # 红黑树wrapper层
├── package.yaml # 编译文件
├── README.md # 说明文档
└── src
├── device.c # epoll设备节点实现
├── epoll.c # epoll接口实现
└── rbtree_wrapper.c # 红黑树适配层

依赖组件

  • osal_aos
  • vfs

常用配置

系统中相关配置已有默认值,如需修改配置,统一在yaml中**def_config**节点修改,具体如下:

配置是否支持LWIP:

def_config:
CONFIG_EPOLL_LWIP: 1

配置是否支持标准epoll接口:

def_config:
CONFIG_WITH_MUSL: 0 # 0 支持标准epoll接口,非零说明在musl库中支持。

API说明

epoll接口定义与linux的epoll兼容,可参考linux相关文档: https://man7.org/linux/man-pages/man7/epoll.7.html

使用示例

组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具,所以首先需要参考《AliOS Things集成开发环境使用说明之搭建开发环境》,下载安装。 待开发环境搭建完成后,可以按照以下步骤进行示例的测试。

步骤1 创建或打开工程

打开已有工程

如果用于测试的案例工程已存在,可参考《AliOS Things集成开发环境使用说明之打开工程》打开已有工程。

创建新的工程

组件的示例代码可以通过编译链接到AliOS Things的任意案例(solution)来运行,这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考《AliOS Things集成开发环境使用说明之创建工程》

步骤2 添加组件

案例下载完成后,需要在helloworld_demo组件的package.yaml中添加对epoll组件的依赖:

helloworld_demo组件的package.yaml中添加

depends:
- epoll: dev_aos # helloworld_demo中引入epoll组件

步骤3 下载组件

在已安装了 的开发环境工具栏中,选择Terminal -> New Terminal启动终端,并且默认工作路径为当前工程的workspace,此时在终端命令行中输入:

aos install epoll

上述命令执行成功后,组件源码则被下载到了./components/epoll

步骤4 添加示例

在epoll组件的package.yaml中添加example示例代码

source_file:
- "src/*.c"
- "example/*.c" # add example source

步骤5 编译固件

在示例代码已经添加至组件的配置文件,并且helloworld_demo已添加了对该组件的依赖后,就可以编译helloworld_demo案例来生成固件了,具体编译方法可参考《AliOS Things集成开发环境使用说明之编译固件》

步骤6 烧录固件

helloworld_demo案例的固件生成后,可参考《AliOS Things集成开发环境使用说明之烧录固件》来烧录固件。

步骤7 打开串口

固件烧录完成后,可以通过串口查看示例的运行结果,打开串口的具体方法可参考《AliOS Things集成开发环境使用说明之查看日志》

当串口终端打开成功后,可在串口中输入help来查看已添加的测试命令。

步骤8 测试示例

烧入固件后,输入cli命令:

epoll_example

可看到如下打印:

epoll_example
epoll wait timeout:ret = 0
epoll_wait,ret = 1
epoll_wait,get event, fd = 513, event = 1
read fd =513, data = 2

注意事项

FAQ