Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neverchanje/yaraft
Yet Another RAFT implementation
https://github.com/neverchanje/yaraft
consensus cpp etcd raft
Last synced: 3 months ago
JSON representation
Yet Another RAFT implementation
- Host: GitHub
- URL: https://github.com/neverchanje/yaraft
- Owner: neverchanje
- License: apache-2.0
- Archived: true
- Created: 2017-01-13T04:02:45.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-12T08:33:16.000Z (about 6 years ago)
- Last Synced: 2024-06-12T07:15:59.263Z (5 months ago)
- Topics: consensus, cpp, etcd, raft
- Language: C++
- Size: 294 KB
- Stars: 127
- Watchers: 11
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yaraft
[](https://travis-ci.org/neverchanje/yaraft)
## What is yaraft?
yaraft is a C++11 port of [etcd/raft](https://github.com/coreos/etcd/tree/master/raft), which is a widely
proven [Raft](https://raft.github.io) library written in Go. Raft is a well-known distributed consensus
algorithm. It's a practical solution designed for understandability, without sacrificing performance and
fault-tolerance comparing to Paxos.
etcd/raft features at its minimalistic design that only the core Raft protocol is implemented.
No RPC, no WAL storage, no multi-threaded environment. It has nothing more than a pure state machine,
so that we can test it in a deterministic way. For state machines with the same state, the same state machine
input should always generate the same state machine output.
## APIs
Read [docs/index.md](docs/index.md) for more details.
The public interfaces are under include/*.
- **include/conf.h**: The configuration to control over the behavior of raft state machine.
- **include/raw_node.h**: Main interface for controlling over raft state machine.
- **include/memory_storage.h**: A copy of the uncompacted log entries that are kept in memory for efficient retrieval.
- **include/ready.h**: The output of the state machine.
- **src/yaraft/thrift/**: The thrift messages sent and received by yaraft. Read [docs/message_types.md](docs/message_types.md) for more information.
- **include/logger.h**: Logger is the interface for writing log messages. You can customize the
logging mechanism by implementing the interface. By default logs are simply written to stderr.
- **include/errors.h**: `error_s` is returned from many of the public interfaces and is used to
report success and various kinds of errors.
## Building from source
```bash
sudo apt-get -y install libboost-dev
bash install_deps_if_neccessary.sh
cd build && cmake .. && make && make install
```
### Running the tests
```bash
$ BUILD=Debug STANDARD=11 ENABLE_GCOV=false ./run_tests.sh
```
you can run [run_gcov.sh](run_gcov.sh) to generate the coverage report.
## Contacts
Contact me or submit an issue if you have any questions about the project.
- **Mail**: [email protected]
## License
yaraft is under the Apache 2.0 license. See the LICENSE file for details.