Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wanmuc/MyCoroutine
https://github.com/wanmuc/MyCoroutine
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wanmuc/MyCoroutine
- Owner: wanmuc
- Created: 2024-08-06T00:38:42.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-23T13:21:34.000Z (3 months ago)
- Last Synced: 2024-08-24T04:23:36.018Z (3 months ago)
- Language: C++
- Size: 230 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# MyCoroutine
> MyCoroutine是使用C++11编写的协程库。
注意：因为本协程库的实现依赖Linux平台下的ucontext库，所以本协程库只支持Linux平台，不支持跨平台。
# 目录结构说明
本仓库的目录结构说明如下。
```
.
├── batch.cpp
├── common.h
├── conditionvariable.cpp
├── conditionvariable.h
├── coroutine.cpp
├── demo
│ ├── batchrun
│ ├── conditionvariable
│ ├── helloworld
│ ├── localvariable
│ └── mutex
├── localvariable.cpp
├── localvariable.h
├── mp_account.png
├── mutex.cpp
├── mutex.h
├── mycoroutine.h
├── readme.md
├── test
│ ├── batch_test.cpp
│ ├── conditionvariable_test.cpp
│ ├── coroutine_test.cpp
│ ├── localvariable_test.cpp
│ ├── makefile
│ ├── mutex_test.cpp
│ └── UTestCore.h
└── waitgroup.h
```
- batch.cpp：批量执行的实现
- common.h：公共结构体、枚举、常量的定义
- conditionvariable.h、conditionvariable.cpp：协程条件变量的实现
- coroutine.cpp：协程基础API的实现
- demo目录：所有示例程序的目录，每个子目录对应一个示例程序
- localvariable.h、localvariable.cpp：协程本地变量的实现
- mutex.h、mutex.cpp：协程互斥量的实现
- mycoroutine.h：协程库主要接口的声明
- test目录：单元测试代码目录，里面有每个特性的测试代码
- waitgroup.h：批量执行的WaitGroup封装
# 协程调度模型
本协程库使用的是1对1的调度模型，也就是说一个协程只会在一个线程上被调度。
因为同一个线程上的多个协程之间是串行执行的，它们之间不存在并发读写数据的问题。
虽然没有了并发读写数据的问题，但是需要处理多个请求之间读写共享数据的时序问题。
多个请求之间读写共享数据的时序问题也比较好解决，通过状态机来处理即可。
注意：如果在一个进程中创建多个线程，并在每个线程中使用了独立的协程池，则依然需要处理多线程的并发读写数据的问题。
# 实现的特性
- 协程创建、协程恢复、协程挂起、协程调度。
- 协程本地变量。
- 协程批量执行。
- 协程互斥锁。
- 协程条件变量。
# 快速开始
下面展示了如何使用本协程库来实现hello world的打印。
```C++
#include "mycoroutine.h"
#include
using namespace std;
using namespace MyCoroutine;
void HelloWorld(Schedule &schedule) {
cout << "hello ";
schedule.CoroutineYield();
cout << "world" << endl;
}
int main() {
// 创建一个协程调度对象，并自动生成大小为1024的协程池
Schedule schedule(1024);
// 创建一个从协程，并手动调度
{
int32_t cid = schedule.CoroutineCreate(HelloWorld, ref(schedule));
schedule.CoroutineResume(cid);
schedule.CoroutineResume(cid);
}
// 创建一个从协程，并自行调度
{
schedule.CoroutineCreate(HelloWorld, ref(schedule));
schedule.Run(); // Run函数完成从协程的自行调度，直到所有的从协程都执行完
}
return 0;
}
```
本仓库的代码都是使用make命令来编译，采用的是通用的makefile编译脚本。
更多的示例代码，详见demo子目录内容，demo目录下的每个子目录都是一个单独的示例程序。
# 微信公众号
欢迎关注微信公众号「Linux后端开发工程实践」，第一时间获取最新文章！扫码即可订阅。
