项目简介

DCF（Distributed Consensus Framework）是基于C语言开发的分布式一致性框架，能为分布式系统提供高效、可靠的一致性保证。框架支持Paxos、Raft等多种分布式一致性算法，还提供丰富API接口，便于开发者集成到各类分布式应用中。

项目的主要特性和功能

1. 分布式一致性算法支持：支持Paxos、Raft等算法，保障分布式环境下的数据一致性与高可用性。
2. 丰富的API接口：提供参数设置、节点管理、数据读写及截断等操作的API，利于二次开发。
3. 动态节点管理：可动态添加、删除节点及变更角色，适应分布式系统节点的动态变化。
4. 高性能通信：采用高效通信机制，支持多种压缩算法和流控策略，确保高负载下的性能。
5. 错误处理和日志记录：提供详细错误码和信息，方便排查错误与调试，支持自定义日志输出，便于监控和分析系统运行状态。

安装使用步骤

1. 环境准备

• 操作系统：支持CentOS 7.6、openEuler - 20.03 - LTS等Linux发行版。
• 编译工具：建议用CMake编译，也可用make。
• 依赖库：需安装securec、lz4、zstd、openssl、cjson等第三方库。

2. 源码获取

从开源社区或项目仓库获取DCF源代码。

3. 编译第三方库

bash cd DCF/build/linux sh compile_opensource.sh

4. 编译DCF

使用DCF/build/linux/opengauss/build.sh脚本编译，参数说明如下： | 选项 | 参数 | 说明 | | --- | --- | --- | | -3rd | [binarylibs path] | 指定binarylibs路径，必须为绝对路径 | | -m | [version_mode] | 编译目标版本，Debug或Release，默认Release | | -t | [build_tool] | 指定编译工具，cmake或make，默认cmake |

示例命令： bash sh build.sh -3rd /path/to/binarylibs -m Release -t cmake

5. 运行测试用例

bash cd DCF/test ./run_tests.sh

6. 集成到应用中

开发者依据DCF提供的API接口，将其集成到自己的分布式应用，实现数据一致性和高可用性。

示例代码

```c

include "dcf_api.h"

int main() { // 初始化DCF dcf_init();

// 设置参数
dcf_set_param("ELECTION_TIMEOUT", "1000");
dcf_set_param("HEARTBEAT_INTERVAL", "500");

// 启动DCF
dcf_start(1, "{\"stream_id\":1,\"node_id\":1,\"ip\":\"127.0.0.1\",\"port\":1711,\"role\":\"LEADER\"}");

// 写入数据
unsigned long long index;
dcf_write(1, "Hello, DCF!", 12, 1, &index);

// 读取数据
char buffer[1024];
dcf_read(1, index, buffer, sizeof(buffer));

// 输出读取到的数据
printf("Read data: %s\n", buffer);

// 停止DCF
dcf_stop();

return 0;

} ```

参考文档

• DCF API文档
• openGauss使能Paxos特性实践

许可证

本项目采用开源许可证，具体信息见项目根目录下的LICENSE文件。

下载地址

点击下载 【提取码: 4003】