org.apache.ratis.protocol

Class RaftClientRequest

java.lang.Object

org.apache.ratis.protocol.RaftClientMessage

org.apache.ratis.protocol.RaftClientRequest

All Implemented Interfaces:

RaftRpcMessage

Direct Known Subclasses:

GroupInfoRequest, GroupListRequest, GroupManagementRequest, LeaderElectionManagementRequest, SetConfigurationRequest, SnapshotManagementRequest, TransferLeadershipRequest

public class RaftClientRequest
extends RaftClientMessage

Request from client to server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftClientRequest.Builder To build RaftClientRequest
static class	RaftClientRequest.Type The type of a request (oneof write, read, staleRead, watch; see the message RaftClientRequestProto).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RaftClientRequest(ClientId clientId, RaftPeerId serverId, RaftGroupId groupId, long callId, boolean toLeader, RaftClientRequest.Type type)
protected	RaftClientRequest(ClientId clientId, RaftPeerId serverId, RaftGroupId groupId, long callId, RaftClientRequest.Type type, long timeoutMs)

Method Summary

Modifier and Type	Method and Description
static RaftClientRequest.Type	dataStreamRequestType()
static RaftClientRequest.Type	forwardRequestType()
Message	getMessage()
RoutingTable	getRoutingTable()
org.apache.ratis.proto.RaftProtos.SlidingWindowEntry	getSlidingWindowEntry()
long	getTimeoutMs()
RaftClientRequest.Type	getType()
boolean	is(org.apache.ratis.proto.RaftProtos.RaftClientRequestProto.TypeCase typeCase)
boolean	isRequest()
boolean	isToLeader()
static RaftClientRequest.Type	messageStreamRequestType(long streamId, long messageId, boolean endOfRequest)
static RaftClientRequest.Builder	newBuilder()
static RaftClientRequest.Type	readRequestType()
static RaftClientRequest.Type	staleReadRequestType(long minIndex)
String	toString()
static RaftClientRequest	toWriteRequest(RaftClientRequest r, Message message) Convert the given request to a write request with the given message.
static RaftClientRequest.Type	watchRequestType()
static RaftClientRequest.Type	watchRequestType(long index, org.apache.ratis.proto.RaftProtos.ReplicationLevel replication)
static RaftClientRequest.Type	writeRequestType()

Methods inherited from class org.apache.ratis.protocol.RaftClientMessage

getCallId, getClientId, getRaftGroupId, getReplierId, getRequestorId, getServerId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RaftClientRequest

protected RaftClientRequest(ClientId clientId,
                            RaftPeerId serverId,
                            RaftGroupId groupId,
                            long callId,
                            boolean toLeader,
                            RaftClientRequest.Type type)

RaftClientRequest

protected RaftClientRequest(ClientId clientId,
                            RaftPeerId serverId,
                            RaftGroupId groupId,
                            long callId,
                            RaftClientRequest.Type type,
                            long timeoutMs)

Method Detail

writeRequestType

public static RaftClientRequest.Type writeRequestType()

dataStreamRequestType

public static RaftClientRequest.Type dataStreamRequestType()

forwardRequestType

public static RaftClientRequest.Type forwardRequestType()

messageStreamRequestType

public static RaftClientRequest.Type messageStreamRequestType(long streamId,
                                                              long messageId,
                                                              boolean endOfRequest)

readRequestType

public static RaftClientRequest.Type readRequestType()

staleReadRequestType

public static RaftClientRequest.Type staleReadRequestType(long minIndex)

watchRequestType

public static RaftClientRequest.Type watchRequestType()

watchRequestType

public static RaftClientRequest.Type watchRequestType(long index,
                                                      org.apache.ratis.proto.RaftProtos.ReplicationLevel replication)

newBuilder

public static RaftClientRequest.Builder newBuilder()

toWriteRequest

public static RaftClientRequest toWriteRequest(RaftClientRequest r,
                                               Message message)

Convert the given request to a write request with the given message.

isRequest

public final boolean isRequest()

isToLeader

public boolean isToLeader()

getSlidingWindowEntry

public org.apache.ratis.proto.RaftProtos.SlidingWindowEntry getSlidingWindowEntry()

getMessage

public Message getMessage()

getType

public RaftClientRequest.Type getType()

is

public boolean is(org.apache.ratis.proto.RaftProtos.RaftClientRequestProto.TypeCase typeCase)

getRoutingTable

public RoutingTable getRoutingTable()

getTimeoutMs

public long getTimeoutMs()

toString

public String toString()

Overrides:

toString in class RaftClientMessage