libfiber 开源项目教程

libfiber 开源项目教程

libfiberThe high performance coroutine library for Linux/FreeBSD/MacOS/Windows, supporting select/poll/epoll/kqueue/iouring/iocp/windows GUI项目地址:https://gitcode.com/gh_mirrors/lib/libfiber

1. 项目的目录结构及介绍

libfiber 是一个高性能的 C/C++ 协程库，支持多种操作系统。以下是项目的目录结构及其介绍：

libfiber/
├── include/          # 头文件目录
│   └── fiber/        # 协程库相关的头文件
├── src/              # 源代码目录
│   ├── core/         # 核心实现代码
│   ├── io/           # IO 相关代码
│   ├── net/          # 网络相关代码
│   └── sync/         # 同步机制相关代码
├── samples/          # 示例代码目录
│   ├── c_api/        # C 语言 API 示例
│   ├── cpp_api/      # C++ 语言 API 示例
│   └── windows_gui/  # Windows GUI 示例
├── tests/            # 测试代码目录
├── docs/             # 文档目录
├── Makefile          # 编译文件
├── README.md         # 项目介绍文档
└── LICENSE           # 许可证文件

1.1 include 目录

include/fiber/ 目录包含了协程库的所有头文件，这些头文件定义了协程库的 API 接口。

1.2 src 目录

src/ 目录包含了协程库的实现代码，分为核心实现、IO 处理、网络通信和同步机制等子目录。

1.3 samples 目录

samples/ 目录包含了使用协程库的示例代码，包括 C 语言和 C++ 语言的 API 示例，以及 Windows GUI 示例。

1.4 tests 目录

tests/ 目录包含了协程库的测试代码，用于验证库的正确性和性能。

1.5 docs 目录

docs/ 目录包含了项目的文档，包括用户手册、API 文档等。

1.6 Makefile

Makefile 文件用于在 Unix 系统上编译项目。

1.7 README.md

README.md 文件是项目的介绍文档，包含了项目的基本信息、安装和使用说明。

1.8 LICENSE

LICENSE 文件包含了项目的许可证信息。

2. 项目的启动文件介绍

项目的启动文件通常是 main.cpp 或 main.c，位于 samples/ 目录下。以下是一个典型的启动文件示例：

#include <stdio.h>
#include "fiber/libfiber.hpp"

static void fiber_routine(int i) {
    printf("hi i=%d curr fiber=%u\r\n", i, acl::fiber::self());
}

int main(void) {
    for (int i = 0; i < 10; i++) {
        go[=] { fiber_routine(i); };
    }
    acl::fiber::schedule();
    return 0;
}

2.1 引入头文件

#include "fiber/libfiber.hpp" 引入了协程库的头文件。

2.2 定义协程函数

static void fiber_routine(int i) 定义了一个协程函数，用于执行具体的任务。

2.3 主函数

int main(void) 是程序的入口点，通过 go 关键字创建协程，并调用 acl::fiber::schedule() 启动协程调度器。

3. 项目的配置文件介绍

libfiber 项目本身没有特定的配置文件，但可以在编译和运行时通过环境变量或命令行参数进行配置。以下是一些常见的配置方式：

3.1 编译配置

在 Unix 系统上，可以通过修改 Makefile 文件来配置编译选项，例如：

fiber_server: fiber_server.c
    gcc -o fiber_server fiber_server.c -I[path_of_fiber_header] -L[path_of_fiber_lib] -lfiber -ldl -lpthread

3.2 运行时配置

在运行时，可以通过环境变量或命令行参数配置协程库的行为，例如设置最大协程数、IO 事件引擎类型等。

export LIBFIBER_MAX_FIB

libfiberThe high performance coroutine library for Linux/FreeBSD/MacOS/Windows, supporting select/poll/epoll/kqueue/iouring/iocp/windows GUI项目地址:https://gitcode.com/gh_mirrors/lib/libfiber