org.corfudb.runtime.clients

Class BaseClient

java.lang.Object

org.corfudb.runtime.clients.BaseClient

All Implemented Interfaces:

IClient

public class BaseClient
extends Object
implements IClient

This is a base client which sends basic messages. It mainly sends PINGs, as well as the ACK/NACKs defined by the Corfu protocol. This is also responsible to send SET_EPOCH messages used to seal the servers with an epoch

Created by mwei on 12/9/15.

Constructor Summary

Constructors

Constructor and Description
BaseClient(IClientRouter router, long epoch)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<VersionInfo>	getVersionInfo()
CompletableFuture<Boolean>	ping() Ping the endpoint, asynchronously.
boolean	pingSync() Ping the endpoint, synchronously.
CompletableFuture<Boolean>	reset() Reset the endpoint, asynchronously.
CompletableFuture<Boolean>	restart() Restart the endpoint, asynchronously.
CompletableFuture<Boolean>	setRemoteEpoch(long newEpoch) Sets the epoch on client router and on the target layout server.

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

BaseClient

public BaseClient(IClientRouter router,
                  long epoch)

Method Detail

pingSync

public boolean pingSync()

Ping the endpoint, synchronously. Note: this ping is epoch aware

Returns:

True, if the endpoint was reachable, false otherwise.

setRemoteEpoch

public CompletableFuture<Boolean> setRemoteEpoch(long newEpoch)

Sets the epoch on client router and on the target layout server.

Parameters:

newEpoch - New Epoch to be set

Returns:

Completable future which returns true on successful epoch set.

getVersionInfo

public CompletableFuture<VersionInfo> getVersionInfo()

ping

public CompletableFuture<Boolean> ping()

Ping the endpoint, asynchronously.

Returns:

A completable future which will be completed with True if the endpoint is reachable, otherwise False or exceptional completion.

reset

public CompletableFuture<Boolean> reset()

Reset the endpoint, asynchronously. WARNING: ALL EXISTING DATA ON THIS NODE WILL BE LOST.

Returns:

A completable future which will be completed with True if the endpoint acks, otherwise False or exceptional completion.

restart

public CompletableFuture<Boolean> restart()

Restart the endpoint, asynchronously.

Returns:

A completable future which will be completed with True if the endpoint acks, otherwise False or exceptional completion.