io.atomix.protocols.raft

Class RaftClient.Builder

java.lang.Object

io.atomix.protocols.raft.RaftClient.Builder

All Implemented Interfaces:

io.atomix.utils.Builder<RaftClient>

Enclosing interface:

RaftClient

public abstract static class RaftClient.Builder
extends Object
implements io.atomix.utils.Builder<RaftClient>

Builds a new Raft client.

New client builders should be constructed using the static RaftClient.newBuilder() factory method.

   
     RaftClient client = RaftClient.builder(new Address("123.456.789.0", 5000), new Address("123.456.789.1", 5000)
       .withTransport(new NettyTransport())
       .build();
   
 

Method Summary

Modifier and Type	Method and Description
RaftClient.Builder	withClientId(String clientId) Sets the client ID.
RaftClient.Builder	withMemberId(MemberId nodeId) Sets the local node identifier.
RaftClient.Builder	withProtocol(RaftClientProtocol protocol) Sets the client protocol.
RaftClient.Builder	withThreadModel(ThreadModel threadModel) Sets the client thread model.
RaftClient.Builder	withThreadPoolSize(int threadPoolSize) Sets the client thread pool size.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.atomix.utils.Builder

build

Method Detail

withClientId

public RaftClient.Builder withClientId(String clientId)

Sets the client ID.

The client ID is a name that should be unique among all clients. The ID will be used to resolve and recover sessions.

Parameters:

clientId - The client ID.

Returns:

The client builder.

Throws:

NullPointerException - if clientId is null

withMemberId

public RaftClient.Builder withMemberId(MemberId nodeId)

Sets the local node identifier.

Parameters:

nodeId - The local node identifier.

Returns:

The client builder.

Throws:

NullPointerException - if nodeId is null

withProtocol

public RaftClient.Builder withProtocol(RaftClientProtocol protocol)

Sets the client protocol.

Parameters:

protocol - the client protocol

Returns:

the client builder

Throws:

NullPointerException - if the protocol is null

withThreadModel

public RaftClient.Builder withThreadModel(ThreadModel threadModel)

Sets the client thread model.

Parameters:

threadModel - the client thread model

Returns:

the client builder

Throws:

NullPointerException - if the thread model is null

withThreadPoolSize

public RaftClient.Builder withThreadPoolSize(int threadPoolSize)

Sets the client thread pool size.

Parameters:

threadPoolSize - The client thread pool size.

Returns:

The client builder.

Throws:

IllegalArgumentException - if the thread pool size is not positive