sofastack/sofa-jraft

RFC: Add streaming APIs (RpcClient, RpcServer)

Open

#856 opened on Jun 24, 2022

View on GitHub
 (5 comments) (0 reactions) (1 assignee)Java (3,406 stars) (1,125 forks)batch import
enhancementhelp wanted

Description

Add streaming APIs (RpcClient, RpcServer), implement it based on gRPC.

This is a subtask that belongs to the first step of #672 In this subtask, we need a streaming impl, for the leader (client) to continuously send raft logs to followers.

Main goals:

  • Add streaming API to RpcClient and RpcServer
  • Implement streaming based on gRPC (We are not going to use bolt to implement)

Contributor guide

Tech stack
javagrpc
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java programminggRPC basicsRaft algorithm fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Study the existing RpcClient and RpcServer interfaces (jraft core/src/main/java/com/alipay/sofa/jraft/rpc/). Based on gRPC streaming, design and implement streaming versions. Refer to subtask #672 for context. The implementation should allow leader to continuously send raft logs to followers. Consider using gRPC's bidirectional streaming.