Package io.atomix.raft.protocol
Interface RaftServerProtocol
- All Known Implementing Classes:
RaftServerCommunicator
public interface RaftServerProtocol
Raft server protocol.
-
Method Summary
Modifier and TypeMethodDescriptionappend(MemberId memberId, AppendRequest request) Sends an append request to the given node.append(MemberId memberId, VersionedAppendRequest request) configure(MemberId memberId, ConfigureRequest request) Sends a configure request to the given node.forceConfigure(MemberId memberId, ForceConfigureRequest request) Sends a force configure request to the given node.install(MemberId memberId, InstallRequest request) Sends an install request to the given node.join(MemberId memberId, JoinRequest request) Sends a join request to the given node.leave(MemberId memberId, LeaveRequest request) Sends a leave request to the given node.poll(MemberId memberId, PollRequest request) Sends a poll request to the given node.reconfigure(MemberId memberId, ReconfigureRequest request) Sends a reconfigure request to the given node.voidRegisters an append request callback.voidvoidRegisters a configure request callback.voidregisterForceConfigureHandler(Function<ForceConfigureRequest, CompletableFuture<ForceConfigureResponse>> handler) voidRegisters a install request callback.voidvoidvoidRegisters a poll request callback.voidregisterReconfigureHandler(Function<ReconfigureRequest, CompletableFuture<ReconfigureResponse>> handler) Registers a reconfigure request callback.voidRegisters a transfer request callback.voidRegisters a vote request callback.transfer(MemberId memberId, TransferRequest request) Sends a transfer request to the given node.voidUnregisters the append request handler.voidUnregisters the configure request handler.voidvoidUnregisters the install request handler.voidvoidvoidUnregisters the poll request handler.voidUnregisters the reconfigure request handler.voidUnregisters the transfer request handler.voidUnregisters the vote request handler.vote(MemberId memberId, VoteRequest request) Sends a vote request to the given node.
-
Method Details
-
configure
Sends a configure request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
reconfigure
Sends a reconfigure request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
forceConfigure
CompletableFuture<ForceConfigureResponse> forceConfigure(MemberId memberId, ForceConfigureRequest request) Sends a force configure request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
join
Sends a join request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
leave
Sends a leave request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
install
Sends an install request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
transfer
Sends a transfer request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
poll
Sends a poll request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
vote
Sends a vote request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
append
Sends an append request to the given node.- Parameters:
memberId- the node to which to send the requestrequest- the request to send- Returns:
- a future to be completed with the response
-
append
-
registerTransferHandler
Registers a transfer request callback.- Parameters:
handler- the open session request handler to register
-
unregisterTransferHandler
void unregisterTransferHandler()Unregisters the transfer request handler. -
registerConfigureHandler
void registerConfigureHandler(Function<ConfigureRequest, CompletableFuture<ConfigureResponse>> handler) Registers a configure request callback.- Parameters:
handler- the open session request handler to register
-
unregisterConfigureHandler
void unregisterConfigureHandler()Unregisters the configure request handler. -
registerReconfigureHandler
void registerReconfigureHandler(Function<ReconfigureRequest, CompletableFuture<ReconfigureResponse>> handler) Registers a reconfigure request callback.- Parameters:
handler- the open session request handler to register
-
unregisterReconfigureHandler
void unregisterReconfigureHandler()Unregisters the reconfigure request handler. -
registerForceConfigureHandler
void registerForceConfigureHandler(Function<ForceConfigureRequest, CompletableFuture<ForceConfigureResponse>> handler) -
unregisterForceConfigureHandler
void unregisterForceConfigureHandler() -
registerJoinHandler
-
unregisterJoinHandler
void unregisterJoinHandler() -
registerLeaveHandler
-
unregisterLeaveHandler
void unregisterLeaveHandler() -
registerInstallHandler
Registers a install request callback.- Parameters:
handler- the open session request handler to register
-
unregisterInstallHandler
void unregisterInstallHandler()Unregisters the install request handler. -
registerPollHandler
Registers a poll request callback.- Parameters:
handler- the open session request handler to register
-
unregisterPollHandler
void unregisterPollHandler()Unregisters the poll request handler. -
registerVoteHandler
Registers a vote request callback.- Parameters:
handler- the open session request handler to register
-
unregisterVoteHandler
void unregisterVoteHandler()Unregisters the vote request handler. -
registerAppendV1Handler
Registers an append request callback.- Parameters:
handler- the open session request handler to register
-
registerAppendV2Handler
void registerAppendV2Handler(Function<VersionedAppendRequest, CompletableFuture<AppendResponse>> handler) -
unregisterAppendHandler
void unregisterAppendHandler()Unregisters the append request handler.
-