io.atomix.protocols.raft

Interface RaftClient

public interface RaftClient

Provides an interface for submitting operations to the Raft cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RaftClient.Builder Builds a new Raft client.

Method Summary

Modifier and Type	Method and Description
static RaftClient.Builder	builder() Returns a new Raft client builder.
static RaftClient.Builder	builder(Collection<io.atomix.cluster.MemberId> cluster) Returns a new Raft client builder.
static RaftClient.Builder	builder(io.atomix.cluster.MemberId... cluster) Returns a new Raft client builder.
String	clientId() Returns the globally unique client identifier.
CompletableFuture<Void>	close() Closes the client.
default CompletableFuture<RaftClient>	connect() Connects the client to Raft cluster via the default server address.
CompletableFuture<RaftClient>	connect(Collection<io.atomix.cluster.MemberId> members) Connects the client to Raft cluster via the provided server addresses.
default CompletableFuture<RaftClient>	connect(io.atomix.cluster.MemberId... members) Connects the client to Raft cluster via the provided server addresses.
io.atomix.cluster.MemberId	leader() Returns the current leader.
RaftMetadataClient	metadata() Returns the Raft metadata.
RaftSessionClient.Builder	sessionBuilder(String primitiveName, io.atomix.primitive.PrimitiveType primitiveType, io.atomix.primitive.service.ServiceConfig serviceConfig) Builds a Raft proxy session.
long	term() Returns the current term.

Method Detail

builder

static RaftClient.Builder builder()

Returns a new Raft client builder.

The provided set of members will be used to connect to the Raft cluster. The members list does not have to represent the complete list of servers in the cluster, but it must have at least one reachable member that can communicate with the cluster's leader.

Returns:

The client builder.

builder

static RaftClient.Builder builder(io.atomix.cluster.MemberId... cluster)

Returns a new Raft client builder.

The provided set of members will be used to connect to the Raft cluster. The members list does not have to represent the complete list of servers in the cluster, but it must have at least one reachable member that can communicate with the cluster's leader.

Parameters:

cluster - The cluster to which to connect.

Returns:

The client builder.

builder

static RaftClient.Builder builder(Collection<io.atomix.cluster.MemberId> cluster)

Returns a new Raft client builder.

The provided set of members will be used to connect to the Raft cluster. The members list does not have to represent the complete list of servers in the cluster, but it must have at least one reachable member that can communicate with the cluster's leader.

Parameters:

cluster - The cluster to which to connect.

Returns:

The client builder.

clientId

String clientId()

Returns the globally unique client identifier.

Returns:

the globally unique client identifier

term

long term()

Returns the current term.

Returns:

the current term

leader

io.atomix.cluster.MemberId leader()

Returns the current leader.

Returns:

the current leader

metadata

RaftMetadataClient metadata()

Returns the Raft metadata.

Returns:

The Raft metadata.

sessionBuilder

RaftSessionClient.Builder sessionBuilder(String primitiveName,
                                         io.atomix.primitive.PrimitiveType primitiveType,
                                         io.atomix.primitive.service.ServiceConfig serviceConfig)

Builds a Raft proxy session.

Parameters:

primitiveName - the primitive name

primitiveType - the primitive type

serviceConfig - the service configuration

Returns:

the Raft proxy session builder

connect

default CompletableFuture<RaftClient> connect()

Connects the client to Raft cluster via the default server address.

If the client was built with a default cluster list, the default server addresses will be used. Otherwise, the client will attempt to connect to localhost:8700.

The client will connect to servers in the cluster according to the pattern specified by the configured CommunicationStrategy.

Returns:

A completable future to be completed once the client is registered.

connect

default CompletableFuture<RaftClient> connect(io.atomix.cluster.MemberId... members)

Connects the client to Raft cluster via the provided server addresses.

The client will connect to servers in the cluster according to the pattern specified by the configured CommunicationStrategy.

Parameters:

members - A set of server addresses to which to connect.

Returns:

A completable future to be completed once the client is registered.

connect

CompletableFuture<RaftClient> connect(Collection<io.atomix.cluster.MemberId> members)

Connects the client to Raft cluster via the provided server addresses.

The client will connect to servers in the cluster according to the pattern specified by the configured CommunicationStrategy.

Parameters:

members - A set of server addresses to which to connect.

Returns:

A completable future to be completed once the client is registered.

close

CompletableFuture<Void> close()

Closes the client.

Returns:

A completable future to be completed once the client has been closed.