org.apache.ratis.server.impl

Interface ServerProtoUtils

public interface ServerProtoUtils

Server proto utilities for internal use.

Method Summary

Modifier and Type	Method and Description
static org.apache.ratis.proto.RaftProtos.LogEntryProto	addStateMachineData(org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData, org.apache.ratis.proto.RaftProtos.LogEntryProto entry) Return a new log entry based on the input log entry with stateMachineData added.
static int	getSerializedSize(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static Optional<org.apache.ratis.thirdparty.com.google.protobuf.ByteString>	getStateMachineData(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static Optional<org.apache.ratis.proto.RaftProtos.StateMachineEntryProto>	getStateMachineEntry(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static org.apache.ratis.proto.RaftProtos.LogEntryProto	rebuildLogEntryProto(org.apache.ratis.proto.RaftProtos.LogEntryProto entry, org.apache.ratis.proto.RaftProtos.StateMachineEntryProto.Builder smEntry)
static org.apache.ratis.proto.RaftProtos.LogEntryProto	removeStateMachineData(org.apache.ratis.proto.RaftProtos.LogEntryProto entry) If the given entry has state machine log entry and it has state machine data, build a new entry without the state machine data.
static boolean	shouldReadStateMachineData(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto	toAppendEntriesReplyProto(RaftPeerId requestorId, RaftGroupMemberId replyId, long term, long followerCommit, long nextIndex, org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto.AppendResult result, long callId, long matchIndex, boolean isHeartbeat)
static org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto	toAppendEntriesRequestProto(RaftGroupMemberId requestorId, RaftPeerId replyId, long leaderTerm, List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries, long leaderCommit, boolean initializing, TermIndex previous, Collection<org.apache.ratis.proto.RaftProtos.CommitInfoProto> commitInfos, long callId)
static org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto	toInstallSnapshotReplyProto(RaftPeerId requestorId, RaftGroupMemberId replyId, long currentTerm, int requestIndex, org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result)
static org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto	toInstallSnapshotReplyProto(RaftPeerId requestorId, RaftGroupMemberId replyId, long currentTerm, org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result, long installedSnapshotIndex)
static org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto	toInstallSnapshotReplyProto(RaftPeerId requestorId, RaftGroupMemberId replyId, org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result)
static org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto	toInstallSnapshotRequestProto(RaftGroupMemberId requestorId, RaftPeerId replyId, long leaderTerm, TermIndex firstAvailable)
static org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto	toInstallSnapshotRequestProto(RaftGroupMemberId requestorId, RaftPeerId replyId, String requestId, int requestIndex, long term, TermIndex lastTermIndex, List<org.apache.ratis.proto.RaftProtos.FileChunkProto> chunks, long totalSize, boolean done)
static org.apache.ratis.proto.RaftProtos.LogEntryProto	toLogEntryProto(long commitIndex, long term, long index)
static org.apache.ratis.proto.RaftProtos.LogEntryProto	toLogEntryProto(RaftConfiguration conf, long term, long index)
static org.apache.ratis.proto.RaftProtos.LogEntryProto	toLogEntryProto(org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto smLog, long term, long index)
static String	toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static String	toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto entry, Function<org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto,String> function)
static org.apache.ratis.proto.RaftProtos.MetadataProto.Builder	toMetadataEntryBuilder(long commitIndex)
static RaftConfiguration	toRaftConfiguration(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static org.apache.ratis.proto.RaftProtos.RaftConfigurationProto.Builder	toRaftConfigurationProto(RaftConfiguration conf)
static org.apache.ratis.proto.RaftProtos.RaftRpcReplyProto.Builder	toRaftRpcReplyProtoBuilder(RaftPeerId requestorId, RaftGroupMemberId replyId, boolean success)
static org.apache.ratis.proto.RaftProtos.RaftRpcRequestProto.Builder	toRaftRpcRequestProtoBuilder(RaftGroupMemberId requestorId, RaftPeerId replyId)
static org.apache.ratis.proto.RaftProtos.RequestVoteReplyProto	toRequestVoteReplyProto(RaftPeerId requestorId, RaftGroupMemberId replyId, boolean success, long term, boolean shouldShutdown)
static org.apache.ratis.proto.RaftProtos.RequestVoteRequestProto	toRequestVoteRequestProto(RaftGroupMemberId requestorId, RaftPeerId replyId, long term, TermIndex lastEntry)
static org.apache.ratis.proto.RaftProtos.ServerRpcProto	toServerRpcProto(RaftPeer peer, long delay)
static String	toShortString(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)
static org.apache.ratis.proto.RaftProtos.StateMachineEntryProto.Builder	toStateMachineEntryProtoBuilder(org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData)
static org.apache.ratis.proto.RaftProtos.StateMachineEntryProto.Builder	toStateMachineEntryProtoBuilder(int logEntryProtoSerializedSize)
static org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto	toStateMachineLogEntryProto(ClientId clientId, long callId, org.apache.ratis.thirdparty.com.google.protobuf.ByteString logData, org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData)
static org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto	toStateMachineLogEntryProto(RaftClientRequest request, org.apache.ratis.thirdparty.com.google.protobuf.ByteString logData, org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData)
static String	toStateMachineLogEntryString(org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto smLog, Function<org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto,String> function)
static String	toString(org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto reply)
static String	toString(org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto proto)
static String	toString(org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto proto)
static String	toString(org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto proto)
static String	toString(org.apache.ratis.proto.RaftProtos.LogEntryProto... entries)
static String	toString(org.apache.ratis.proto.RaftProtos.RequestVoteReplyProto proto)
static TermIndex	toTermIndex(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static TermIndex	toTermIndex(org.apache.ratis.proto.RaftProtos.TermIndexProto p)
static org.apache.ratis.proto.RaftProtos.TermIndexProto	toTermIndexProto(TermIndex ti)
static String	toTermIndexString(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
static String	toTermIndexString(org.apache.ratis.proto.RaftProtos.TermIndexProto proto)

Method Detail

toTermIndex

static TermIndex toTermIndex(org.apache.ratis.proto.RaftProtos.TermIndexProto p)

toTermIndexProto

static org.apache.ratis.proto.RaftProtos.TermIndexProto toTermIndexProto(TermIndex ti)

toTermIndex

static TermIndex toTermIndex(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

toTermIndexString

static String toTermIndexString(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

toTermIndexString

static String toTermIndexString(org.apache.ratis.proto.RaftProtos.TermIndexProto proto)

toLogEntryString

static String toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

toStateMachineLogEntryString

static String toStateMachineLogEntryString(org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto smLog,
                                           Function<org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto,String> function)

toLogEntryString

static String toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto entry,
                               Function<org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto,String> function)

toString

static String toString(org.apache.ratis.proto.RaftProtos.LogEntryProto... entries)

toShortString

static String toShortString(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)

toString

static String toString(org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto proto)

toString

static String toString(org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto reply)

toString

static String toString(org.apache.ratis.proto.RaftProtos.RequestVoteReplyProto proto)

toString

static String toString(org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto proto)

toString

static String toString(org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto proto)

toRaftConfigurationProto

static org.apache.ratis.proto.RaftProtos.RaftConfigurationProto.Builder toRaftConfigurationProto(RaftConfiguration conf)

toRaftConfiguration

static RaftConfiguration toRaftConfiguration(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

toLogEntryProto

static org.apache.ratis.proto.RaftProtos.LogEntryProto toLogEntryProto(RaftConfiguration conf,
                                                                       long term,
                                                                       long index)

toLogEntryProto

static org.apache.ratis.proto.RaftProtos.LogEntryProto toLogEntryProto(org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto smLog,
                                                                       long term,
                                                                       long index)

toLogEntryProto

static org.apache.ratis.proto.RaftProtos.LogEntryProto toLogEntryProto(long commitIndex,
                                                                       long term,
                                                                       long index)

toMetadataEntryBuilder

static org.apache.ratis.proto.RaftProtos.MetadataProto.Builder toMetadataEntryBuilder(long commitIndex)

toStateMachineEntryProtoBuilder

static org.apache.ratis.proto.RaftProtos.StateMachineEntryProto.Builder toStateMachineEntryProtoBuilder(org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData)

toStateMachineEntryProtoBuilder

static org.apache.ratis.proto.RaftProtos.StateMachineEntryProto.Builder toStateMachineEntryProtoBuilder(int logEntryProtoSerializedSize)

toStateMachineLogEntryProto

static org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto toStateMachineLogEntryProto(RaftClientRequest request,
                                                                                               org.apache.ratis.thirdparty.com.google.protobuf.ByteString logData,
                                                                                               org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData)

toStateMachineLogEntryProto

static org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto toStateMachineLogEntryProto(ClientId clientId,
                                                                                               long callId,
                                                                                               org.apache.ratis.thirdparty.com.google.protobuf.ByteString logData,
                                                                                               org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData)

getStateMachineEntry

static Optional<org.apache.ratis.proto.RaftProtos.StateMachineEntryProto> getStateMachineEntry(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

getStateMachineData

static Optional<org.apache.ratis.thirdparty.com.google.protobuf.ByteString> getStateMachineData(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

shouldReadStateMachineData

static boolean shouldReadStateMachineData(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

removeStateMachineData

static org.apache.ratis.proto.RaftProtos.LogEntryProto removeStateMachineData(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

If the given entry has state machine log entry and it has state machine data, build a new entry without the state machine data.

Returns:

a new entry without the state machine data if the given has state machine data; otherwise, return the given entry.

rebuildLogEntryProto

static org.apache.ratis.proto.RaftProtos.LogEntryProto rebuildLogEntryProto(org.apache.ratis.proto.RaftProtos.LogEntryProto entry,
                                                                            org.apache.ratis.proto.RaftProtos.StateMachineEntryProto.Builder smEntry)

addStateMachineData

static org.apache.ratis.proto.RaftProtos.LogEntryProto addStateMachineData(org.apache.ratis.thirdparty.com.google.protobuf.ByteString stateMachineData,
                                                                           org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

Return a new log entry based on the input log entry with stateMachineData added.

Parameters:

stateMachineData - - state machine data to be added

entry - - log entry to which stateMachineData needs to be added

Returns:

LogEntryProto with stateMachineData added

getSerializedSize

static int getSerializedSize(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

toRaftRpcReplyProtoBuilder

static org.apache.ratis.proto.RaftProtos.RaftRpcReplyProto.Builder toRaftRpcReplyProtoBuilder(RaftPeerId requestorId,
                                                                                              RaftGroupMemberId replyId,
                                                                                              boolean success)

toRequestVoteReplyProto

static org.apache.ratis.proto.RaftProtos.RequestVoteReplyProto toRequestVoteReplyProto(RaftPeerId requestorId,
                                                                                       RaftGroupMemberId replyId,
                                                                                       boolean success,
                                                                                       long term,
                                                                                       boolean shouldShutdown)

toRaftRpcRequestProtoBuilder

static org.apache.ratis.proto.RaftProtos.RaftRpcRequestProto.Builder toRaftRpcRequestProtoBuilder(RaftGroupMemberId requestorId,
                                                                                                  RaftPeerId replyId)

toRequestVoteRequestProto

static org.apache.ratis.proto.RaftProtos.RequestVoteRequestProto toRequestVoteRequestProto(RaftGroupMemberId requestorId,
                                                                                           RaftPeerId replyId,
                                                                                           long term,
                                                                                           TermIndex lastEntry)

toInstallSnapshotReplyProto

static org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto toInstallSnapshotReplyProto(RaftPeerId requestorId,
                                                                                               RaftGroupMemberId replyId,
                                                                                               long currentTerm,
                                                                                               int requestIndex,
                                                                                               org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result)

toInstallSnapshotReplyProto

static org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto toInstallSnapshotReplyProto(RaftPeerId requestorId,
                                                                                               RaftGroupMemberId replyId,
                                                                                               long currentTerm,
                                                                                               org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result,
                                                                                               long installedSnapshotIndex)

toInstallSnapshotReplyProto

static org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto toInstallSnapshotReplyProto(RaftPeerId requestorId,
                                                                                               RaftGroupMemberId replyId,
                                                                                               org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result)

toInstallSnapshotRequestProto

static org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto toInstallSnapshotRequestProto(RaftGroupMemberId requestorId,
                                                                                                   RaftPeerId replyId,
                                                                                                   String requestId,
                                                                                                   int requestIndex,
                                                                                                   long term,
                                                                                                   TermIndex lastTermIndex,
                                                                                                   List<org.apache.ratis.proto.RaftProtos.FileChunkProto> chunks,
                                                                                                   long totalSize,
                                                                                                   boolean done)

toInstallSnapshotRequestProto

static org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto toInstallSnapshotRequestProto(RaftGroupMemberId requestorId,
                                                                                                   RaftPeerId replyId,
                                                                                                   long leaderTerm,
                                                                                                   TermIndex firstAvailable)

toAppendEntriesReplyProto

static org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto toAppendEntriesReplyProto(RaftPeerId requestorId,
                                                                                           RaftGroupMemberId replyId,
                                                                                           long term,
                                                                                           long followerCommit,
                                                                                           long nextIndex,
                                                                                           org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto.AppendResult result,
                                                                                           long callId,
                                                                                           long matchIndex,
                                                                                           boolean isHeartbeat)

toAppendEntriesRequestProto

static org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto toAppendEntriesRequestProto(RaftGroupMemberId requestorId,
                                                                                               RaftPeerId replyId,
                                                                                               long leaderTerm,
                                                                                               List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries,
                                                                                               long leaderCommit,
                                                                                               boolean initializing,
                                                                                               TermIndex previous,
                                                                                               Collection<org.apache.ratis.proto.RaftProtos.CommitInfoProto> commitInfos,
                                                                                               long callId)

toServerRpcProto

static org.apache.ratis.proto.RaftProtos.ServerRpcProto toServerRpcProto(RaftPeer peer,
                                                                         long delay)