quik-lua-rpc 项目教程
1. 项目的目录结构及介绍
quik-lua-rpc/
├── built/
│ └── quik_lua_rpc.tar.xz
├── docs/
├── impl/
├── json/schema/
├── qlua/
├── quik_redist/
├── test/json/
├── utils/
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── README.md
├── SConstruct
├── VERSION.txt
├── config.json
├── curve_keypair_generator.lua
├── docker-compose.yaml
├── main.lua
├── redist.zip
└── service.lua
目录结构介绍
- built/: 包含编译后的二进制文件,如
quik_lua_rpc.tar.xz
。 - docs/: 存放项目文档。
- impl/: 实现相关代码。
- json/schema/: JSON 模式文件。
- qlua/: QLua 相关代码。
- quik_redist/: QUIK 的 DLL 文件。
- test/json/: JSON 测试文件。
- utils/: 工具类代码。
- .gitignore: Git 忽略文件。
- .travis.yml: Travis CI 配置文件。
- CONTRIBUTING.md: 贡献指南。
- Dockerfile: Docker 配置文件。
- LICENSE: 项目许可证。
- README.md: 项目介绍和使用说明。
- SConstruct: SCons 构建文件。
- VERSION.txt: 项目版本号。
- config.json: 项目配置文件。
- curve_keypair_generator.lua: 曲线密钥对生成器。
- docker-compose.yaml: Docker Compose 配置文件。
- main.lua: 主启动文件。
- redist.zip: 重新分发的压缩包。
- service.lua: 服务启动文件。
2. 项目的启动文件介绍
main.lua
main.lua
是项目的启动文件。它负责初始化并启动整个服务。以下是 main.lua
的主要功能:
- 初始化配置: 从
config.json
文件中读取配置。 - 加载依赖: 加载所需的 Lua 库和 DLL 文件。
- 启动服务: 启动 RPC 服务,监听指定的端口。
service.lua
service.lua
是服务的核心文件,负责处理 RPC 请求并调用相应的 QLua API。以下是 service.lua
的主要功能:
- 处理请求: 接收并解析 RPC 请求。
- 调用 API: 根据请求调用相应的 QLua API。
- 返回结果: 将 API 调用的结果返回给客户端。
3. 项目的配置文件介绍
config.json
config.json
是项目的配置文件,包含服务启动所需的各项配置。以下是 config.json
的主要配置项:
{
"port": 8080,
"log_level": "info",
"quik_path": "D:/QUIK/",
"dll_path": "quik_redist/",
"timeout": 60
}
配置项说明
- port: 服务监听的端口号。
- log_level: 日志级别,如
info
,debug
,error
等。 - quik_path: QUIK 终端的安装路径。
- dll_path: QUIK 的 DLL 文件路径。
- timeout: RPC 请求的超时时间,单位为秒。
通过以上配置,可以灵活地调整服务的运行参数,以适应不同的环境和需求。