| Package | Description |
|---|---|
| io.atomix.protocols.raft |
Core interfaces for operating on replicated state machines in the Raft cluster.
|
| io.atomix.protocols.raft.cluster |
Interfaces for managing and interacting with the Raft cluster.
|
| io.atomix.protocols.raft.protocol |
RaftRequest and RaftResponse
implementations for all client-server communication. |
| io.atomix.protocols.raft.proxy |
Facilitates modification of a Raft state machine via proxy.
|
| io.atomix.protocols.raft.session |
Interfaces for managing client sessions on a Raft server.
|
| io.atomix.protocols.raft.storage.system |
Classes and interfaces that aid in storing and loading persistent cluster and server configurations.
|
| Modifier and Type | Method and Description |
|---|---|
MemberId |
RaftMetadataClient.getLeader()
Returns the current cluster leader.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<MemberId> |
RaftMetadataClient.getMembers()
Returns the set of known members in the cluster.
|
default Collection<MemberId> |
RaftMetadataClient.getServers()
Returns the set of known members in the cluster.
|
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<RaftServer> |
RaftServer.bootstrap(MemberId... members)
Bootstraps the cluster using the provided cluster configuration.
|
default CompletableFuture<RaftClient> |
RaftClient.connect(MemberId... members)
Connects the client to Raft cluster via the provided server addresses.
|
default CompletableFuture<RaftServer> |
RaftServer.join(MemberId... members)
Joins the cluster.
|
default CompletableFuture<RaftServer> |
RaftServer.listen(MemberId... cluster)
Joins the cluster as a passive listener.
|
static RaftClient.Builder |
RaftClient.newBuilder(MemberId... cluster)
Returns a new Raft client builder.
|
static RaftServer.Builder |
RaftServer.newBuilder(MemberId localMemberId)
Returns a new Raft server builder.
|
RaftClient.Builder |
RaftClient.Builder.withMemberId(MemberId nodeId)
Sets the local node identifier.
|
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<RaftServer> |
RaftServer.bootstrap(Collection<MemberId> cluster)
Bootstraps the cluster using the provided cluster configuration.
|
CompletableFuture<RaftClient> |
RaftClient.connect(Collection<MemberId> members)
Connects the client to Raft cluster via the provided server addresses.
|
CompletableFuture<RaftServer> |
RaftServer.join(Collection<MemberId> members)
Joins the cluster.
|
CompletableFuture<RaftServer> |
RaftServer.listen(Collection<MemberId> cluster)
Joins the cluster as a passive listener.
|
static RaftClient.Builder |
RaftClient.newBuilder(Collection<MemberId> cluster)
Returns a new Raft client builder.
|
| Modifier and Type | Method and Description |
|---|---|
static MemberId |
MemberId.from(String id)
Creates a new cluster node identifier from the specified string.
|
MemberId |
RaftMember.memberId()
Returns the member node ID.
|
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<Void> |
RaftCluster.bootstrap(MemberId... cluster)
Bootstraps the cluster.
|
int |
MemberId.compareTo(MemberId that) |
RaftMember |
RaftCluster.getMember(MemberId id)
Returns a member by ID.
|
default CompletableFuture<Void> |
RaftCluster.join(MemberId... cluster)
Joins the cluster.
|
default CompletableFuture<Void> |
RaftCluster.listen(MemberId... cluster)
Joins the cluster as a listener.
|
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<Void> |
RaftCluster.bootstrap(Collection<MemberId> cluster)
Bootstraps the cluster.
|
CompletableFuture<Void> |
RaftCluster.join(Collection<MemberId> cluster)
Joins the cluster.
|
CompletableFuture<Void> |
RaftCluster.listen(Collection<MemberId> cluster)
Joins the cluster as a listener.
|
| Modifier and Type | Method and Description |
|---|---|
MemberId |
VoteRequest.candidate()
Returns the candidate's address.
|
MemberId |
PollRequest.candidate()
Returns the candidate's address.
|
MemberId |
KeepAliveResponse.leader()
Returns the cluster leader.
|
MemberId |
InstallRequest.leader()
Returns the requesting leader address.
|
MemberId |
HeartbeatRequest.leader()
Returns the cluster leader.
|
MemberId |
ConfigureRequest.leader()
Returns the requesting leader address.
|
MemberId |
AppendRequest.leader()
Returns the requesting leader address.
|
MemberId |
TransferRequest.member()
Returns the member to which to transfer.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<MemberId> |
KeepAliveResponse.members()
Returns the cluster members.
|
Collection<MemberId> |
HeartbeatRequest.members()
Returns the cluster members.
|
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<AppendResponse> |
RaftServerProtocol.append(MemberId memberId,
AppendRequest request)
Sends an append request to the given node.
|
CompletableFuture<CloseSessionResponse> |
RaftServerProtocol.closeSession(MemberId memberId,
CloseSessionRequest request)
Sends a close session request to the given node.
|
CompletableFuture<CloseSessionResponse> |
RaftClientProtocol.closeSession(MemberId memberId,
CloseSessionRequest request)
Sends a close session request to the given node.
|
CompletableFuture<CommandResponse> |
RaftServerProtocol.command(MemberId memberId,
CommandRequest request)
Sends a command request to the given node.
|
CompletableFuture<CommandResponse> |
RaftClientProtocol.command(MemberId memberId,
CommandRequest request)
Sends a command request to the given node.
|
CompletableFuture<ConfigureResponse> |
RaftServerProtocol.configure(MemberId memberId,
ConfigureRequest request)
Sends a configure request to the given node.
|
CompletableFuture<HeartbeatResponse> |
RaftServerProtocol.heartbeat(MemberId memberId,
HeartbeatRequest request)
Sends a heartbeat request to the given node.
|
CompletableFuture<InstallResponse> |
RaftServerProtocol.install(MemberId memberId,
InstallRequest request)
Sends an install request to the given node.
|
CompletableFuture<JoinResponse> |
RaftServerProtocol.join(MemberId memberId,
JoinRequest request)
Sends a join request to the given node.
|
CompletableFuture<KeepAliveResponse> |
RaftServerProtocol.keepAlive(MemberId memberId,
KeepAliveRequest request)
Sends a keep alive request to the given node.
|
CompletableFuture<KeepAliveResponse> |
RaftClientProtocol.keepAlive(MemberId memberId,
KeepAliveRequest request)
Sends a keep alive request to the given node.
|
CompletableFuture<LeaveResponse> |
RaftServerProtocol.leave(MemberId memberId,
LeaveRequest request)
Sends a leave request to the given node.
|
CompletableFuture<MetadataResponse> |
RaftServerProtocol.metadata(MemberId memberId,
MetadataRequest request)
Sends a metadata request to the given node.
|
CompletableFuture<MetadataResponse> |
RaftClientProtocol.metadata(MemberId memberId,
MetadataRequest request)
Sends a metadata request to the given node.
|
CompletableFuture<OpenSessionResponse> |
RaftServerProtocol.openSession(MemberId memberId,
OpenSessionRequest request)
Sends an open session request to the given node.
|
CompletableFuture<OpenSessionResponse> |
RaftClientProtocol.openSession(MemberId memberId,
OpenSessionRequest request)
Sends an open session request to the given node.
|
CompletableFuture<PollResponse> |
RaftServerProtocol.poll(MemberId memberId,
PollRequest request)
Sends a poll request to the given node.
|
void |
RaftServerProtocol.publish(MemberId memberId,
PublishRequest request)
Unicasts a publish request to the given node.
|
CompletableFuture<QueryResponse> |
RaftServerProtocol.query(MemberId memberId,
QueryRequest request)
Sends a query request to the given node.
|
CompletableFuture<QueryResponse> |
RaftClientProtocol.query(MemberId memberId,
QueryRequest request)
Sends a query request to the given node.
|
CompletableFuture<ReconfigureResponse> |
RaftServerProtocol.reconfigure(MemberId memberId,
ReconfigureRequest request)
Sends a reconfigure request to the given node.
|
CompletableFuture<TransferResponse> |
RaftServerProtocol.transfer(MemberId memberId,
TransferRequest request)
Sends a transfer request to the given node.
|
CompletableFuture<VoteResponse> |
RaftServerProtocol.vote(MemberId memberId,
VoteRequest request)
Sends a vote request to the given node.
|
VoteRequest.Builder |
VoteRequest.Builder.withCandidate(MemberId candidate)
Sets the request leader.
|
PollRequest.Builder |
PollRequest.Builder.withCandidate(MemberId candidate)
Sets the request leader.
|
KeepAliveResponse.Builder |
KeepAliveResponse.Builder.withLeader(MemberId leader)
Sets the response leader.
|
InstallRequest.Builder |
InstallRequest.Builder.withLeader(MemberId leader)
Sets the request leader.
|
HeartbeatRequest.Builder |
HeartbeatRequest.Builder.withLeader(MemberId leader)
Sets the request leader.
|
ConfigureRequest.Builder |
ConfigureRequest.Builder.withLeader(MemberId leader)
Sets the request leader.
|
AppendRequest.Builder |
AppendRequest.Builder.withLeader(MemberId leader)
Sets the request leader.
|
TransferRequest.Builder |
TransferRequest.Builder.withMember(MemberId member)
Sets the request member.
|
OpenSessionRequest.Builder |
OpenSessionRequest.Builder.withMemberId(MemberId member)
Sets the client node identifier.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RaftClientProtocol.reset(Collection<MemberId> members,
ResetRequest request)
Multicasts a reset request to all nodes in the cluster.
|
KeepAliveResponse.Builder |
KeepAliveResponse.Builder.withMembers(Collection<MemberId> members)
Sets the response members.
|
HeartbeatRequest.Builder |
HeartbeatRequest.Builder.withMembers(Collection<MemberId> members)
Sets the request members.
|
| Constructor and Description |
|---|
HeartbeatRequest(MemberId leader,
Collection<MemberId> members) |
InstallRequest(long term,
MemberId leader,
long serviceId,
String serviceName,
long index,
long timestamp,
int offset,
byte[] data,
boolean complete) |
KeepAliveResponse(RaftResponse.Status status,
RaftError error,
MemberId leader,
Collection<MemberId> members,
long[] sessionIds) |
| Constructor and Description |
|---|
HeartbeatRequest(MemberId leader,
Collection<MemberId> members) |
KeepAliveResponse(RaftResponse.Status status,
RaftError error,
MemberId leader,
Collection<MemberId> members,
long[] sessionIds) |
| Modifier and Type | Method and Description |
|---|---|
abstract List<MemberId> |
CommunicationStrategy.selectConnections(MemberId leader,
List<MemberId> members)
Returns a prioritized list of servers to which the client can connect and submit operations.
|
| Modifier and Type | Method and Description |
|---|---|
abstract List<MemberId> |
CommunicationStrategy.selectConnections(MemberId leader,
List<MemberId> members)
Returns a prioritized list of servers to which the client can connect and submit operations.
|
| Modifier and Type | Method and Description |
|---|---|
abstract List<MemberId> |
CommunicationStrategy.selectConnections(MemberId leader,
List<MemberId> members)
Returns a prioritized list of servers to which the client can connect and submit operations.
|
| Modifier and Type | Method and Description |
|---|---|
MemberId |
RaftSession.memberId()
Returns the member identifier to which the session belongs.
|
| Modifier and Type | Method and Description |
|---|---|
MemberId |
MetaStore.loadVote()
Loads the last vote for the server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
MetaStore.storeVote(MemberId vote)
Stores the last voted server.
|
Copyright © 2013–2017. All rights reserved.