io.atomix.protocols.raft.proxy

Interface RaftProxy

All Superinterfaces:

io.atomix.utils.Managed<RaftProxy>, RaftProxyExecutor

public interface RaftProxy
extends RaftProxyExecutor, io.atomix.utils.Managed<RaftProxy>

Raft client proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RaftProxy.Builder Raft session builder.
static class	RaftProxy.State Indicates the state of the client's communication with the Raft cluster.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(EventType eventType, Consumer<byte[]> listener) Adds a session event listener.
<T> void	addEventListener(EventType eventType, Function<byte[],T> decoder, Consumer<T> listener) Adds an event listener.
void	addEventListener(EventType eventType, Runnable listener) Adds an empty session event listener.
default CompletableFuture<Void>	invoke(OperationId operationId) Submits an empty operation to the Raft cluster, awaiting a void result.
default <R> CompletableFuture<R>	invoke(OperationId operationId, Function<byte[],R> decoder) Submits an empty operation to the Raft cluster.
default <T> CompletableFuture<Void>	invoke(OperationId operationId, Function<T,byte[]> encoder, T operation) Submits an operation to the Raft cluster.
default <T,R> CompletableFuture<R>	invoke(OperationId operationId, Function<T,byte[]> encoder, T operation, Function<byte[],R> decoder) Submits an operation to the Raft cluster.
void	removeEventListener(EventType eventType, Consumer listener) Removes a session event listener.
void	removeEventListener(EventType eventType, Runnable listener) Removes an empty session event listener.

Methods inherited from interface io.atomix.protocols.raft.proxy.RaftProxyExecutor

addEventListener, addStateChangeListener, execute, execute, execute, getState, name, removeEventListener, removeStateChangeListener, serviceType, sessionId

Methods inherited from interface io.atomix.utils.Managed

close, isClosed, isOpen, open

Method Detail

invoke

default CompletableFuture<Void> invoke(OperationId operationId)

Submits an empty operation to the Raft cluster, awaiting a void result.

Parameters:

operationId - the operation identifier

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all RaftOperation submission futures that preceded it. The future will always be completed on the

Throws:

NullPointerException - if operation is null

invoke

default <R> CompletableFuture<R> invoke(OperationId operationId,
                                        Function<byte[],R> decoder)

Submits an empty operation to the Raft cluster.

Type Parameters:

R - the operation result type

Parameters:

operationId - the operation identifier

decoder - the operation result decoder

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all RaftOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

invoke

default <T> CompletableFuture<Void> invoke(OperationId operationId,
                                           Function<T,byte[]> encoder,
                                           T operation)

Submits an operation to the Raft cluster.

Type Parameters:

T - the operation type

Parameters:

operationId - the operation identifier

encoder - the operation encoder

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all RaftOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

invoke

default <T,R> CompletableFuture<R> invoke(OperationId operationId,
                                          Function<T,byte[]> encoder,
                                          T operation,
                                          Function<byte[],R> decoder)

Submits an operation to the Raft cluster.

Type Parameters:

T - the operation type

R - the operation result type

Parameters:

operationId - the operation identifier

encoder - the operation encoder

operation - the operation to submit

decoder - the operation result decoder

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all RaftOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

addEventListener

<T> void addEventListener(EventType eventType,
                          Function<byte[],T> decoder,
                          Consumer<T> listener)

Adds an event listener.

Type Parameters:

T - the event value type.

Parameters:

eventType - the event type identifier.

decoder - the event decoder.

listener - the event listener.

addEventListener

void addEventListener(EventType eventType,
                      Runnable listener)

Adds an empty session event listener.

Parameters:

eventType - the event type

listener - the event listener to add

addEventListener

void addEventListener(EventType eventType,
                      Consumer<byte[]> listener)

Adds a session event listener.

Parameters:

eventType - the event type identifier

listener - the event listener to add

removeEventListener

void removeEventListener(EventType eventType,
                         Runnable listener)

Removes an empty session event listener.

Parameters:

eventType - the event type

listener - the event listener to add

removeEventListener

void removeEventListener(EventType eventType,
                         Consumer listener)

Removes a session event listener.

Parameters:

eventType - the event type identifier

listener - the event listener to remove