org.corfudb.runtime.clients

Class LayoutClient

java.lang.Object

org.corfudb.runtime.clients.LayoutClient

All Implemented Interfaces:

IClient

public class LayoutClient
extends Object

A client to the layout server.

The layout client is used by layout servers to initiate a Paxos-based protocol for determining the next layout.

Created by mwei on 12/9/15.

Constructor Summary

Constructors

Constructor and Description
LayoutClient(IClientRouter router, long epoch)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	bootstrapLayout(Layout l) Bootstraps a layout server.
CompletableFuture<Boolean>	committed(long epoch, Layout layout) Informs the server that the proposal (layout) has been committed to a quorum.
CompletableFuture<Boolean>	force(Layout layout) Send a force commit layout request to a layout server
CompletableFuture<Layout>	getLayout() Retrieves the layout from the endpoint, asynchronously.
CompletableFuture<LayoutPrepareResponse>	prepare(long epoch, long rank) Begins phase 1 of a Paxos round with a prepare message.
CompletableFuture<Boolean>	propose(long epoch, long rank, Layout layout) Begins phase 2 of a Paxos round with a propose message.
void	sendMessage(CorfuMsg msg)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corfudb.runtime.clients.IClient

getHandledTypes, getMsgHandler, getRouter, handleMessage, setRouter

Constructor Detail

LayoutClient

public LayoutClient(IClientRouter router,
                    long epoch)

Method Detail

getLayout

public CompletableFuture<Layout> getLayout()

Retrieves the layout from the endpoint, asynchronously.

Returns:

A future which will be completed with the current layout.

bootstrapLayout

public CompletableFuture<Boolean> bootstrapLayout(Layout l)

Bootstraps a layout server.

Parameters:

l - The layout to bootstrap with.

Returns:

A completable future which will return TRUE if the bootstrap was successful, false otherwise.

prepare

public CompletableFuture<LayoutPrepareResponse> prepare(long epoch,
                                                        long rank)

Begins phase 1 of a Paxos round with a prepare message.

Parameters:

epoch - epoch for which the paxos rounds are being run

rank - The rank to use for the prepare.

Returns:

True, if the prepare was successful. Otherwise, the completableFuture completes exceptionally with OutrankedException.

propose

public CompletableFuture<Boolean> propose(long epoch,
                                          long rank,
                                          Layout layout)

Begins phase 2 of a Paxos round with a propose message.

Parameters:

epoch - epoch for which the paxos rounds are being run

rank - The rank to use for the propose. It should be the same rank from a successful prepare (phase 1).

layout - The layout to install for phase 2.

Returns:

True, if the propose was successful. Otherwise, the completableFuture completes exceptionally with OutrankedException.

committed

public CompletableFuture<Boolean> committed(long epoch,
                                            Layout layout)

Informs the server that the proposal (layout) has been committed to a quorum.

Parameters:

epoch - epoch affiliated with the layout.

layout - Layout to be committed.

Returns:

True, if the commit was successful.

force

public CompletableFuture<Boolean> force(@Nonnull
                                        Layout layout)

Send a force commit layout request to a layout server

Parameters:

layout - the new layout to force commit

Returns:

true if it was committed, otherwise false.

sendMessage

public void sendMessage(CorfuMsg msg)