Expand description
§Architecture Documentation
This section covers D-Engine’s architecture and design principles. These documents explain core components, how they interact, and the design decisions behind them.
§Topics
- Single Responsibility Principle - Core design philosophy
- Error Handling Design - Error management approach
- Raft Role Implementation - Leader, follower and candidate behaviors
- Snapshot Design - State transfer and recovery
- Node Joining - Dynamic cluster membership
- Election Design - Leader election process
- Log Persistence - Durable storage design
Modules§
- election_
design - Conditions That Cause a Leader to Step Down
- error_
handling_ design_ principles - This section outlines the core principles for distinguishing between protocol logic errors (expected business failures) and system-level errors (unrecoverable faults) across the entire project. Developers extending this codebase should strictly follow these guidelines to ensure consistency and reliability.
- new_
node_ join_ architecture - Raft Node Join & Promotion Architecture
- raft_
log_ persistence_ architecture - Raft Log Persistence Architecture
- raft_
role - Raft Roles and Leader Election: Responsibilities and Step-Down Conditions
- single_
responsibility_ principle - This project strictly follows the Single Responsibility Principle (SRP) to ensure modularity and maintainability. Developers extending the codebase must adhere to this principle to preserve clean separation of concerns. Below are key guidelines and examples.
- snapshot_
module_ design - Snapshot Module Design