RaftServerProtocol (Atomix API Reference (2.0.4))

```
public interface RaftServerProtocol
```
Raft server protocol.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<AppendResponse>`	`append(MemberId memberId, AppendRequest request)` Sends an append request to the given node.
`CompletableFuture<CloseSessionResponse>`	`closeSession(MemberId memberId, CloseSessionRequest request)` Sends a close session request to the given node.
`CompletableFuture<CommandResponse>`	`command(MemberId memberId, CommandRequest request)` Sends a command request to the given node.
`CompletableFuture<ConfigureResponse>`	`configure(MemberId memberId, ConfigureRequest request)` Sends a configure request to the given node.
`CompletableFuture<HeartbeatResponse>`	`heartbeat(MemberId memberId, HeartbeatRequest request)` Sends a heartbeat 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<KeepAliveResponse>`	`keepAlive(MemberId memberId, KeepAliveRequest request)` Sends a keep alive request to the given node.
`CompletableFuture<LeaveResponse>`	`leave(MemberId memberId, LeaveRequest request)` Sends a leave request to the given node.
`CompletableFuture<MetadataResponse>`	`metadata(MemberId memberId, MetadataRequest request)` Sends a metadata request to the given node.
`CompletableFuture<OpenSessionResponse>`	`openSession(MemberId memberId, OpenSessionRequest request)` Sends an open session request to the given node.
`CompletableFuture<PollResponse>`	`poll(MemberId memberId, PollRequest request)` Sends a poll request to the given node.
`void`	`publish(MemberId memberId, PublishRequest request)` Unicasts a publish request to the given node.
`CompletableFuture<QueryResponse>`	`query(MemberId memberId, QueryRequest request)` Sends a query request to the given node.
`CompletableFuture<ReconfigureResponse>`	`reconfigure(MemberId memberId, ReconfigureRequest request)` Sends a reconfigure request to the given node.
`void`	`registerAppendHandler(Function<AppendRequest,CompletableFuture<AppendResponse>> handler)` Registers an append request callback.
`void`	`registerCloseSessionHandler(Function<CloseSessionRequest,CompletableFuture<CloseSessionResponse>> handler)` Registers a close session request callback.
`void`	`registerCommandHandler(Function<CommandRequest,CompletableFuture<CommandResponse>> handler)` Registers a command request callback.
`void`	`registerConfigureHandler(Function<ConfigureRequest,CompletableFuture<ConfigureResponse>> handler)` Registers a configure request callback.
`void`	`registerInstallHandler(Function<InstallRequest,CompletableFuture<InstallResponse>> handler)` Registers a install request callback.
`void`	`registerJoinHandler(Function<JoinRequest,CompletableFuture<JoinResponse>> handler)` Registers a join request callback.
`void`	`registerKeepAliveHandler(Function<KeepAliveRequest,CompletableFuture<KeepAliveResponse>> handler)` Registers a keep alive request callback.
`void`	`registerLeaveHandler(Function<LeaveRequest,CompletableFuture<LeaveResponse>> handler)` Registers a leave request callback.
`void`	`registerMetadataHandler(Function<MetadataRequest,CompletableFuture<MetadataResponse>> handler)` Registers a metadata request callback.
`void`	`registerOpenSessionHandler(Function<OpenSessionRequest,CompletableFuture<OpenSessionResponse>> handler)` Registers an open session request callback.
`void`	`registerPollHandler(Function<PollRequest,CompletableFuture<PollResponse>> handler)` Registers a poll request callback.
`void`	`registerQueryHandler(Function<QueryRequest,CompletableFuture<QueryResponse>> handler)` Registers a query request callback.
`void`	`registerReconfigureHandler(Function<ReconfigureRequest,CompletableFuture<ReconfigureResponse>> handler)` Registers a reconfigure request callback.
`void`	`registerResetListener(SessionId sessionId, Consumer<ResetRequest> listener, Executor executor)` Registers a reset request listener.
`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`	`unregisterCloseSessionHandler()` Unregisters the close session request handler.
`void`	`unregisterCommandHandler()` Unregisters the command request handler.
`void`	`unregisterConfigureHandler()` Unregisters the configure request handler.
`void`	`unregisterInstallHandler()` Unregisters the install request handler.
`void`	`unregisterJoinHandler()` Unregisters the join request handler.
`void`	`unregisterKeepAliveHandler()` Unregisters the keep alive request handler.
`void`	`unregisterLeaveHandler()` Unregisters the leave request handler.
`void`	`unregisterMetadataHandler()` Unregisters the metadata request handler.
`void`	`unregisterOpenSessionHandler()` Unregisters the open session request handler.
`void`	`unregisterPollHandler()` Unregisters the poll request handler.
`void`	`unregisterQueryHandler()` Unregisters the query request handler.
`void`	`unregisterReconfigureHandler()` Unregisters the reconfigure request handler.
`void`	`unregisterResetListener(SessionId sessionId)` Unregisters the given reset request listener.
`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 Detail
  - openSession
```
CompletableFuture<OpenSessionResponse> openSession(MemberId memberId,
                                                   OpenSessionRequest request)
```
    Sends an open session 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
  - closeSession
```
CompletableFuture<CloseSessionResponse> closeSession(MemberId memberId,
                                                     CloseSessionRequest request)
```
    Sends a close session 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
  - keepAlive
```
CompletableFuture<KeepAliveResponse> keepAlive(MemberId memberId,
                                               KeepAliveRequest request)
```
    Sends a keep alive 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
  - query
```
CompletableFuture<QueryResponse> query(MemberId memberId,
                                       QueryRequest request)
```
    Sends a query 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
  - command
```
CompletableFuture<CommandResponse> command(MemberId memberId,
                                           CommandRequest request)
```
    Sends a command 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
  - metadata
```
CompletableFuture<MetadataResponse> metadata(MemberId memberId,
                                             MetadataRequest request)
```
    Sends a metadata 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
  - 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
  - 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
  - heartbeat
```
CompletableFuture<HeartbeatResponse> heartbeat(MemberId memberId,
                                               HeartbeatRequest request)
```
    Sends a heartbeat 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
  - publish
```
void publish(MemberId memberId,
             PublishRequest request)
```
    Unicasts a publish request to the given node.
    
    Parameters:
    
    memberId - the node to which to send the request
    
    request - the request to send
  - registerOpenSessionHandler
```
void registerOpenSessionHandler(Function<OpenSessionRequest,CompletableFuture<OpenSessionResponse>> handler)
```
    Registers an open session request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterOpenSessionHandler
```
void unregisterOpenSessionHandler()
```
    Unregisters the open session request handler.
  - registerCloseSessionHandler
```
void registerCloseSessionHandler(Function<CloseSessionRequest,CompletableFuture<CloseSessionResponse>> handler)
```
    Registers a close session request callback.
    
    Parameters:
    
    handler - the close session request handler to register
  - unregisterCloseSessionHandler
```
void unregisterCloseSessionHandler()
```
    Unregisters the close session request handler.
  - registerKeepAliveHandler
```
void registerKeepAliveHandler(Function<KeepAliveRequest,CompletableFuture<KeepAliveResponse>> handler)
```
    Registers a keep alive request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterKeepAliveHandler
```
void unregisterKeepAliveHandler()
```
    Unregisters the keep alive request handler.
  - registerQueryHandler
```
void registerQueryHandler(Function<QueryRequest,CompletableFuture<QueryResponse>> handler)
```
    Registers a query request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterQueryHandler
```
void unregisterQueryHandler()
```
    Unregisters the query request handler.
  - registerCommandHandler
```
void registerCommandHandler(Function<CommandRequest,CompletableFuture<CommandResponse>> handler)
```
    Registers a command request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterCommandHandler
```
void unregisterCommandHandler()
```
    Unregisters the command request handler.
  - registerMetadataHandler
```
void registerMetadataHandler(Function<MetadataRequest,CompletableFuture<MetadataResponse>> handler)
```
    Registers a metadata request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterMetadataHandler
```
void unregisterMetadataHandler()
```
    Unregisters the metadata request handler.
  - registerJoinHandler
```
void registerJoinHandler(Function<JoinRequest,CompletableFuture<JoinResponse>> handler)
```
    Registers a join request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterJoinHandler
```
void unregisterJoinHandler()
```
    Unregisters the join request handler.
  - registerLeaveHandler
```
void registerLeaveHandler(Function<LeaveRequest,CompletableFuture<LeaveResponse>> handler)
```
    Registers a leave request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterLeaveHandler
```
void unregisterLeaveHandler()
```
    Unregisters the leave request handler.
  - 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.
  - 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.
  - registerAppendHandler
```
void registerAppendHandler(Function<AppendRequest,CompletableFuture<AppendResponse>> handler)
```
    Registers an append request callback.
    
    Parameters:
    
    handler - the open session request handler to register
  - unregisterAppendHandler
```
void unregisterAppendHandler()
```
    Unregisters the append request handler.
  - registerResetListener
```
void registerResetListener(SessionId sessionId,
                           Consumer<ResetRequest> listener,
                           Executor executor)
```
    Registers a reset request listener.
    
    Parameters:
    
    sessionId - the session ID for which to register the listener
    
    listener - the reset request listener to add
    
    executor - the executor with which to execute the listener
  - unregisterResetListener
```
void unregisterResetListener(SessionId sessionId)
```
    Unregisters the given reset request listener.
    
    Parameters:
    
    sessionId - the session ID for which to unregister the listener

Interface RaftServerProtocol

Method Summary

Method Detail

openSession

closeSession

keepAlive

query

command

metadata

join

leave

configure

reconfigure

install

transfer

poll

vote

append

heartbeat

publish

registerOpenSessionHandler

unregisterOpenSessionHandler

registerCloseSessionHandler

unregisterCloseSessionHandler

registerKeepAliveHandler

unregisterKeepAliveHandler

registerQueryHandler

unregisterQueryHandler

registerCommandHandler

unregisterCommandHandler

registerMetadataHandler

unregisterMetadataHandler

registerJoinHandler

unregisterJoinHandler

registerLeaveHandler

unregisterLeaveHandler

registerTransferHandler

unregisterTransferHandler

registerConfigureHandler

unregisterConfigureHandler

registerReconfigureHandler

unregisterReconfigureHandler

registerInstallHandler

unregisterInstallHandler

registerPollHandler

unregisterPollHandler

registerVoteHandler

unregisterVoteHandler

registerAppendHandler

unregisterAppendHandler

registerResetListener

unregisterResetListener