开源项目 served 使用教程

开源项目 served 使用教程

served项目地址:https://gitcode.com/gh_mirrors/ser/served

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

served/
├── CMakeLists.txt
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── docs/
├── examples/
│   ├── basic_server.cpp
│   ├── echo_server.cpp
│   └── ...
├── include/
│   └── served/
│       ├── mux.hpp
│       ├── request.hpp
│       ├── response.hpp
│       └── ...
├── src/
│   ├── mux.cpp
│   ├── request.cpp
│   ├── response.cpp
│   └── ...
└── tests/
    ├── test_mux.cpp
    ├── test_request.cpp
    ├── test_response.cpp
    └── ...

• CMakeLists.txt: 用于构建项目的CMake配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• docs/: 项目文档。
• examples/: 示例代码，包括基本的HTTP服务器和回显服务器等。
• include/served/: 头文件，包含核心功能的接口定义。
• src/: 源代码文件，实现头文件中定义的功能。
• tests/: 测试代码，确保项目功能的正确性。

2. 项目的启动文件介绍

在 examples/ 目录下，有几个示例文件展示了如何启动和使用 served 项目。其中最基础的启动文件是 basic_server.cpp。

#include <served/served.hpp>

int main(int argc, char const* argv[]) {
    // 创建一个多路复用器
    served::multiplexer mux;

    // 定义一个路由
    mux.handle("/hello")
        .get([](served::response & res, const served::request & req) {
            res << "Hello, World!";
        });

    // 启动服务器，监听8080端口
    served::net::server server("127.0.0.1", "8080", mux);
    server.run(10); // 使用10个线程

    return 0;
}

这个示例展示了如何创建一个简单的HTTP服务器，监听8080端口，并在访问 /hello 路径时返回 "Hello, World!"。

3. 项目的配置文件介绍

served 项目本身没有特定的配置文件，配置主要通过代码实现。例如，在启动文件中，可以通过修改 server 的参数来配置服务器的监听地址和端口。

served::net::server server("127.0.0.1", "8080", mux);

这里可以修改 "127.0.0.1" 和 "8080" 来改变服务器的监听地址和端口。

此外，可以通过修改 mux 对象来添加更多的路由和处理逻辑，以满足不同的业务需求。

mux.handle("/path")
    .get([](served::response & res, const served::request & req) {
        res << "Response content";
    });

通过这种方式，可以灵活地配置和扩展 served 项目。

served项目地址:https://gitcode.com/gh_mirrors/ser/served