xynet 项目使用教程
1. 项目的目录结构及介绍
xynet/
├── include/
│ └── xynet/
│ ├── core/
│ ├── utils/
│ └── ...
├── src/
│ ├── core/
│ ├── utils/
│ └── main.cpp
├── config/
│ └── config.yaml
├── tests/
│ └── ...
├── README.md
├── LICENSE
└── CMakeLists.txt
include/
: 包含项目的头文件。xynet/
: 主要的头文件目录。core/
: 核心功能的头文件。utils/
: 工具类的头文件。
src/
: 包含项目的源文件。core/
: 核心功能的源文件。utils/
: 工具类的源文件。main.cpp
: 项目的启动文件。
config/
: 包含项目的配置文件。config.yaml
: 主要的配置文件。
tests/
: 包含项目的测试文件。README.md
: 项目说明文档。LICENSE
: 项目许可证。CMakeLists.txt
: CMake 构建文件。
2. 项目的启动文件介绍
src/main.cpp
是项目的启动文件,负责初始化项目并启动主循环。以下是 main.cpp
的主要内容:
#include <xynet/core/server.h>
#include <xynet/utils/logger.h>
int main() {
// 初始化日志系统
xynet::utils::Logger::init();
// 创建服务器实例
xynet::core::Server server;
// 加载配置文件
server.loadConfig("config/config.yaml");
// 启动服务器
server.start();
return 0;
}
3. 项目的配置文件介绍
config/config.yaml
是项目的主要配置文件,包含服务器的各种配置参数。以下是配置文件的主要内容:
server:
port: 8080
threads: 4
logging:
level: info
file: "logs/server.log"
database:
host: "localhost"
port: 3306
user: "root"
password: "password"
name: "xynet"
server
: 服务器配置。port
: 服务器监听的端口。threads
: 服务器使用的线程数。
logging
: 日志配置。level
: 日志级别。file
: 日志文件路径。
database
: 数据库配置。host
: 数据库主机地址。port
: 数据库端口。user
: 数据库用户名。password
: 数据库密码。name
: 数据库名称。