org.apache.ratis.server

Interface RaftServer

All Superinterfaces:

AdminAsynchronousProtocol, AdminProtocol, AutoCloseable, Closeable, RaftClientAsynchronousProtocol, RaftClientProtocol, RaftServerAsynchronousProtocol, RaftServerProtocol, RpcType.Get

All Known Implementing Classes:

RaftServerProxy

public interface RaftServer
extends Closeable, RpcType.Get, RaftServerProtocol, RaftServerAsynchronousProtocol, RaftClientProtocol, RaftClientAsynchronousProtocol, AdminProtocol, AdminAsynchronousProtocol

Raft server interface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RaftServer.Builder To build RaftServer objects.

Nested classes/interfaces inherited from interface org.apache.ratis.server.protocol.RaftServerProtocol

RaftServerProtocol.Op

Method Summary

Modifier and Type	Method and Description
ServerFactory	getFactory()
Iterable<RaftGroupId>	getGroupIds()
Iterable<RaftGroup>	getGroups()
RaftPeerId	getId()
LifeCycle.State	getLifeCycleState()
RaftProperties	getProperties()
static RaftServer.Builder	newBuilder()
void	start() Start this server.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.ratis.rpc.RpcType.Get

getRpcType

Methods inherited from interface org.apache.ratis.server.protocol.RaftServerProtocol

appendEntries, installSnapshot, requestVote

Methods inherited from interface org.apache.ratis.server.protocol.RaftServerAsynchronousProtocol

appendEntriesAsync

Methods inherited from interface org.apache.ratis.protocol.RaftClientProtocol

setConfiguration, submitClientRequest

Methods inherited from interface org.apache.ratis.protocol.RaftClientAsynchronousProtocol

setConfigurationAsync, submitClientRequestAsync

Methods inherited from interface org.apache.ratis.protocol.AdminProtocol

getGroupInfo, getGroupList, groupManagement

Methods inherited from interface org.apache.ratis.protocol.AdminAsynchronousProtocol

getGroupInfoAsync, getGroupListAsync, groupManagementAsync

Method Detail

getId

RaftPeerId getId()

Returns:

the server ID.

getGroupIds

Iterable<RaftGroupId> getGroupIds()

Returns:

the group IDs the server is part of.

getGroups

Iterable<RaftGroup> getGroups()
                       throws IOException

Returns:

the groups the server is part of.

Throws:

IOException

getProperties

RaftProperties getProperties()

Returns:

the server properties.

getFactory

ServerFactory getFactory()

Returns:

the factory for creating server components.

start

void start()
    throws IOException

Start this server.

Throws:

IOException

getLifeCycleState

LifeCycle.State getLifeCycleState()

newBuilder

static RaftServer.Builder newBuilder()

Returns:

a RaftServer.Builder.