io.atomix.protocols.raft.protocol

Interface RaftClientProtocol

public interface RaftClientProtocol

Raft client protocol.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<CloseSessionResponse>	closeSession(io.atomix.cluster.NodeId nodeId, CloseSessionRequest request) Sends a close session request to the given node.
CompletableFuture<CommandResponse>	command(io.atomix.cluster.NodeId nodeId, CommandRequest request) Sends a command request to the given node.
CompletableFuture<KeepAliveResponse>	keepAlive(io.atomix.cluster.NodeId nodeId, KeepAliveRequest request) Sends a keep alive request to the given node.
CompletableFuture<MetadataResponse>	metadata(io.atomix.cluster.NodeId nodeId, MetadataRequest request) Sends a metadata request to the given node.
CompletableFuture<OpenSessionResponse>	openSession(io.atomix.cluster.NodeId nodeId, OpenSessionRequest request) Sends an open session request to the given node.
CompletableFuture<QueryResponse>	query(io.atomix.cluster.NodeId nodeId, QueryRequest request) Sends a query request to the given node.
void	registerHeartbeatHandler(Function<HeartbeatRequest,CompletableFuture<HeartbeatResponse>> handler) Registers a heartbeat request callback.
void	registerPublishListener(io.atomix.primitive.session.SessionId sessionId, Consumer<PublishRequest> listener, Executor executor) Registers a publish request listener.
void	reset(Set<io.atomix.cluster.NodeId> members, ResetRequest request) Multicasts a reset request to all nodes in the cluster.
void	unregisterHeartbeatHandler() Unregisters the heartbeat request handler.
void	unregisterPublishListener(io.atomix.primitive.session.SessionId sessionId) Unregisters the publish request listener for the given session.

Method Detail

openSession

CompletableFuture<OpenSessionResponse> openSession(io.atomix.cluster.NodeId nodeId,
                                                   OpenSessionRequest request)

Sends an open session request to the given node.

Parameters:

nodeId - 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(io.atomix.cluster.NodeId nodeId,
                                                     CloseSessionRequest request)

Sends a close session request to the given node.

Parameters:

nodeId - 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(io.atomix.cluster.NodeId nodeId,
                                               KeepAliveRequest request)

Sends a keep alive request to the given node.

Parameters:

nodeId - 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(io.atomix.cluster.NodeId nodeId,
                                       QueryRequest request)

Sends a query request to the given node.

Parameters:

nodeId - 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(io.atomix.cluster.NodeId nodeId,
                                           CommandRequest request)

Sends a command request to the given node.

Parameters:

nodeId - 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(io.atomix.cluster.NodeId nodeId,
                                             MetadataRequest request)

Sends a metadata request to the given node.

Parameters:

nodeId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

reset

void reset(Set<io.atomix.cluster.NodeId> members,
           ResetRequest request)

Multicasts a reset request to all nodes in the cluster.

Parameters:

members - the members to which to send the request

request - the reset request to multicast

registerHeartbeatHandler

void registerHeartbeatHandler(Function<HeartbeatRequest,CompletableFuture<HeartbeatResponse>> handler)

Registers a heartbeat request callback.

Parameters:

handler - the heartbeat request handler to register

unregisterHeartbeatHandler

void unregisterHeartbeatHandler()

Unregisters the heartbeat request handler.

registerPublishListener

void registerPublishListener(io.atomix.primitive.session.SessionId sessionId,
                             Consumer<PublishRequest> listener,
                             Executor executor)

Registers a publish request listener.

Parameters:

sessionId - the session for which to listen for the publish request

listener - the listener to register

executor - the executor with which to execute the listener callback

unregisterPublishListener

void unregisterPublishListener(io.atomix.primitive.session.SessionId sessionId)

Unregisters the publish request listener for the given session.

Parameters:

sessionId - the session for which to unregister the listener