Skip to main content

Navigate the repository

The top-level directories:

src/         library source, headers, and proto files
test/        unit tests
example/     runnable sample applications (not part of the build)
contrib/     local Conan recipes for deps not on Conan Center
docs/        documentation source (this site)

Inside the code:

  • src/braft/ -- the library source. Headers, implementation files, and 8 protobuf definitions all live here. Public headers are in src/braft/*.h (no separate include/ directory yet).
  • test/ -- 23 unit test files (test_*.cpp), plus helper headers (util.h, sstream_workaround.h).
  • example/counter/, example/atomic/, example/block/ -- standalone demo applications. Not wired into the Conan build yet.
  • contrib/brpc/ -- local Conan recipe for brpc 1.11.0, which is not available on Conan Center.
  • conanfile.py -- the project's Conan recipe, declaring all dependencies.

For the reasoning behind this layout, see Repository layout.