net.kuujo.catalog.server

Class RaftServer

java.lang.Object

net.kuujo.catalog.server.RaftServer

All Implemented Interfaces:

net.kuujo.catalyst.util.Managed<RaftServer>

public class RaftServer
extends Object
implements net.kuujo.catalyst.util.Managed<RaftServer>

Raft server.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftServer.Builder Raft server builder.
static class	RaftServer.State Raft server state types.

Method Summary

Modifier and Type	Method and Description
static RaftServer.Builder	builder(net.kuujo.catalyst.transport.Address address, net.kuujo.catalyst.transport.Address... cluster) Returns a new Raft server builder.
static RaftServer.Builder	builder(net.kuujo.catalyst.transport.Address address, Collection<net.kuujo.catalyst.transport.Address> cluster) Returns a new Raft server builder.
CompletableFuture<Void>	close()
net.kuujo.catalyst.util.concurrent.Context	context() Returns the server execution context.
CompletableFuture<Void>	delete() Deletes the Raft server and its logs.
boolean	isClosed()
boolean	isOpen()
net.kuujo.catalyst.transport.Address	leader() Returns the current Raft leader.
CompletableFuture<RaftServer>	open()
RaftServer.State	state() Returns the Raft server state.
long	term() Returns the current Raft term.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static RaftServer.Builder builder(net.kuujo.catalyst.transport.Address address,
                                         net.kuujo.catalyst.transport.Address... cluster)

Returns a new Raft server builder.

The provided set of members will be used to connect to the other members in the Raft cluster. The memberId must be the Member#id() of a member listed in the provided members list.

Parameters:

address - The local server member ID. This must be the ID of a member listed in the provided members list.

cluster - The cluster members to which to connect.

Returns:

The server builder.

builder

public static RaftServer.Builder builder(net.kuujo.catalyst.transport.Address address,
                                         Collection<net.kuujo.catalyst.transport.Address> cluster)

Returns a new Raft server builder.

The provided set of members will be used to connect to the other members in the Raft cluster. The memberId must be the Member#id() of a member listed in the provided members list.

Parameters:

address - The local server member ID. This must be the ID of a member listed in the provided members list.

cluster - The cluster members to which to connect.

Returns:

The server builder.

term

public long term()

Returns the current Raft term.

Returns:

The current Raft term.

leader

public net.kuujo.catalyst.transport.Address leader()

Returns the current Raft leader.

Returns:

The current Raft leader.

context

public net.kuujo.catalyst.util.concurrent.Context context()

Returns the server execution context.

The execution context is the event loop that this server uses to communicate other Raft servers. Implementations must guarantee that all asynchronous CompletableFuture callbacks are executed on a single thread via the returned Context.

The Context can also be used to access the Raft server's internal serializer via Context.serializer().

Returns:

The Raft context.

state

public RaftServer.State state()

Returns the Raft server state.

Returns:

The Raft server state.

open

public CompletableFuture<RaftServer> open()

Specified by:

open in interface net.kuujo.catalyst.util.Managed<RaftServer>

isOpen

public boolean isOpen()

Specified by:

isOpen in interface net.kuujo.catalyst.util.Managed<RaftServer>

close

public CompletableFuture<Void> close()

Specified by:

close in interface net.kuujo.catalyst.util.Managed<RaftServer>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface net.kuujo.catalyst.util.Managed<RaftServer>

delete

public CompletableFuture<Void> delete()

Deletes the Raft server and its logs.

Returns:

A completable future to be completed once the server has been deleted.