Package io.atomix.raft.protocol

Interface RaftServerProtocol

All Known Implementing Classes:

RaftServerCommunicator

public interface RaftServerProtocol

Raft server protocol.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AppendResponse>	append(MemberId memberId, AppendRequest request)	Sends an append request to the given node.
CompletableFuture<AppendResponse>	append(MemberId memberId, VersionedAppendRequest request)
CompletableFuture<ConfigureResponse>	configure(MemberId memberId, ConfigureRequest request)	Sends a configure request to the given node.
CompletableFuture<ForceConfigureResponse>	forceConfigure(MemberId memberId, ForceConfigureRequest request)	Sends a force configure request to the given node.
CompletableFuture<InstallResponse>	install(MemberId memberId, InstallRequest request)	Sends an install request to the given node.
CompletableFuture<JoinResponse>	join(MemberId memberId, JoinRequest request)	Sends a join request to the given node.
CompletableFuture<LeaveResponse>	leave(MemberId memberId, LeaveRequest request)	Sends a leave request to the given node.
CompletableFuture<PollResponse>	poll(MemberId memberId, PollRequest request)	Sends a poll request to the given node.
CompletableFuture<ReconfigureResponse>	reconfigure(MemberId memberId, ReconfigureRequest request)	Sends a reconfigure request to the given node.
void	registerAppendV1Handler(Function<AppendRequest,CompletableFuture<AppendResponse>> handler)	Registers an append request callback.
void	registerAppendV2Handler(Function<VersionedAppendRequest,CompletableFuture<AppendResponse>> handler)
void	registerConfigureHandler(Function<ConfigureRequest,CompletableFuture<ConfigureResponse>> handler)	Registers a configure request callback.
void	registerForceConfigureHandler(Function<ForceConfigureRequest,CompletableFuture<ForceConfigureResponse>> handler)
void	registerInstallHandler(Function<InstallRequest,CompletableFuture<InstallResponse>> handler)	Registers a install request callback.
void	registerJoinHandler(Function<JoinRequest,CompletableFuture<JoinResponse>> handler)
void	registerLeaveHandler(Function<LeaveRequest,CompletableFuture<LeaveResponse>> handler)
void	registerPollHandler(Function<PollRequest,CompletableFuture<PollResponse>> handler)	Registers a poll request callback.
void	registerReconfigureHandler(Function<ReconfigureRequest,CompletableFuture<ReconfigureResponse>> handler)	Registers a reconfigure request callback.
void	registerTransferHandler(Function<TransferRequest,CompletableFuture<TransferResponse>> handler)	Registers a transfer request callback.
void	registerVoteHandler(Function<VoteRequest,CompletableFuture<VoteResponse>> handler)	Registers a vote request callback.
CompletableFuture<TransferResponse>	transfer(MemberId memberId, TransferRequest request)	Sends a transfer request to the given node.
void	unregisterAppendHandler()	Unregisters the append request handler.
void	unregisterConfigureHandler()	Unregisters the configure request handler.
void	unregisterForceConfigureHandler()
void	unregisterInstallHandler()	Unregisters the install request handler.
void	unregisterJoinHandler()
void	unregisterLeaveHandler()
void	unregisterPollHandler()	Unregisters the poll request handler.
void	unregisterReconfigureHandler()	Unregisters the reconfigure request handler.
void	unregisterTransferHandler()	Unregisters the transfer request handler.
void	unregisterVoteHandler()	Unregisters the vote request handler.
CompletableFuture<VoteResponse>	vote(MemberId memberId, VoteRequest request)	Sends a vote request to the given node.

Method Details

configure

CompletableFuture<ConfigureResponse> configure(MemberId memberId,
 ConfigureRequest request)

Sends a configure request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

reconfigure

CompletableFuture<ReconfigureResponse> reconfigure(MemberId memberId,
 ReconfigureRequest request)

Sends a reconfigure request to the given node.

Parameters:

memberId - the node to which to send the request

request - 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 request

request - the request to send

Returns:

a future to be completed with the response

join

CompletableFuture<JoinResponse> join(MemberId memberId,
 JoinRequest request)

Sends a join request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

leave

CompletableFuture<LeaveResponse> leave(MemberId memberId,
 LeaveRequest request)

Sends a leave request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

install

CompletableFuture<InstallResponse> install(MemberId memberId,
 InstallRequest request)

Sends an install request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

transfer

CompletableFuture<TransferResponse> transfer(MemberId memberId,
 TransferRequest request)

Sends a transfer request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

poll

CompletableFuture<PollResponse> poll(MemberId memberId,
 PollRequest request)

Sends a poll request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

vote

CompletableFuture<VoteResponse> vote(MemberId memberId,
 VoteRequest request)

Sends a vote request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

append

CompletableFuture<AppendResponse> append(MemberId memberId,
 AppendRequest request)

Sends an append request to the given node.

Parameters:

memberId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

append

CompletableFuture<AppendResponse> append(MemberId memberId,
 VersionedAppendRequest request)

registerTransferHandler

void registerTransferHandler(Function<TransferRequest,CompletableFuture<TransferResponse>> handler)

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

void registerJoinHandler(Function<JoinRequest,CompletableFuture<JoinResponse>> handler)

unregisterJoinHandler

void unregisterJoinHandler()

registerLeaveHandler

void registerLeaveHandler(Function<LeaveRequest,CompletableFuture<LeaveResponse>> handler)

unregisterLeaveHandler

void unregisterLeaveHandler()

registerInstallHandler

void registerInstallHandler(Function<InstallRequest,CompletableFuture<InstallResponse>> handler)

Registers a install request callback.

Parameters:

handler - the open session request handler to register

unregisterInstallHandler

void unregisterInstallHandler()

Unregisters the install request handler.

registerPollHandler

void registerPollHandler(Function<PollRequest,CompletableFuture<PollResponse>> handler)

Registers a poll request callback.

Parameters:

handler - the open session request handler to register

unregisterPollHandler

void unregisterPollHandler()

Unregisters the poll request handler.

registerVoteHandler

void registerVoteHandler(Function<VoteRequest,CompletableFuture<VoteResponse>> handler)

Registers a vote request callback.

Parameters:

handler - the open session request handler to register

unregisterVoteHandler

void unregisterVoteHandler()

Unregisters the vote request handler.

registerAppendV1Handler

void registerAppendV1Handler(Function<AppendRequest,CompletableFuture<AppendResponse>> handler)

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.