org.corfudb.runtime.clients

Class SequencerClient

java.lang.Object

org.corfudb.runtime.clients.SequencerClient

All Implemented Interfaces:

IClient

public class SequencerClient
extends Object

A sequencer client.

This client allows the client to obtain sequence numbers from a sequencer.

Created by mwei on 12/10/15.

Constructor Summary

Constructors

Constructor and Description
SequencerClient(IClientRouter router, long epoch)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	bootstrap(Long initialToken, Map<UUID,StreamAddressSpace> streamAddressSpaceMap, Long readyStateEpoch) Resets the sequencer with the specified initialToken.
CompletableFuture<Boolean>	bootstrap(Long initialToken, Map<UUID,StreamAddressSpace> streamAddressSpaceMap, Long readyStateEpoch, boolean bootstrapWithoutTailsUpdate) Resets the sequencer with the specified initialToken
CompletableFuture<StreamsAddressResponse>	getStreamsAddressSpace(List<StreamAddressRange> streamsAddressesRange) Retrieves from the sequencer the address space for the specified streams in the given ranges.
CompletableFuture<TokenResponse>	nextToken(List<UUID> streamIDs, long numTokens) Fetches the next available token from the sequencer.
CompletableFuture<TokenResponse>	nextToken(List<UUID> streamIDs, long numTokens, TxResolutionInfo conflictInfo) Fetches the next available token from the sequencer.
CompletableFuture<SequencerMetrics>	requestMetrics() Sends a metrics request to the sequencer server.
void	sendMessage(CorfuMsg msg)
CompletableFuture<Void>	trimCache(Long address)

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

SequencerClient

public SequencerClient(IClientRouter router,
                       long epoch)

Method Detail

requestMetrics

public CompletableFuture<SequencerMetrics> requestMetrics()

Sends a metrics request to the sequencer server.

nextToken

public CompletableFuture<TokenResponse> nextToken(List<UUID> streamIDs,
                                                  long numTokens)

Fetches the next available token from the sequencer.

Parameters:

streamIDs - Set of streamIDs to be assigned ot the token.

numTokens - Number of tokens to be reserved.

Returns:

A completable future with the token response from the sequencer.

getStreamsAddressSpace

public CompletableFuture<StreamsAddressResponse> getStreamsAddressSpace(List<StreamAddressRange> streamsAddressesRange)

Retrieves from the sequencer the address space for the specified streams in the given ranges.

Parameters:

streamsAddressesRange - requested streams and ranges.

Returns:

streams address maps in the given range.

nextToken

public CompletableFuture<TokenResponse> nextToken(List<UUID> streamIDs,
                                                  long numTokens,
                                                  TxResolutionInfo conflictInfo)

Fetches the next available token from the sequencer.

Parameters:

streamIDs - Set of streamIDs to be assigned ot the token.

numTokens - Number of tokens to be reserved.

conflictInfo - Transaction resolution conflict parameters.

Returns:

A completable future with the token response from the sequencer.

trimCache

public CompletableFuture<Void> trimCache(Long address)

bootstrap

public CompletableFuture<Boolean> bootstrap(Long initialToken,
                                            Map<UUID,StreamAddressSpace> streamAddressSpaceMap,
                                            Long readyStateEpoch,
                                            boolean bootstrapWithoutTailsUpdate)

Resets the sequencer with the specified initialToken

Parameters:

initialToken - Token Number which the sequencer starts distributing.

streamAddressSpaceMap - Per stream map of address space.

readyStateEpoch - Epoch at which the sequencer is ready and to stamp tokens.

bootstrapWithoutTailsUpdate - True, if this is a delta message and just updates an existing primary sequencer with the new epoch. False otherwise.

Returns:

A CompletableFuture which completes once the sequencer is reset.

bootstrap

public CompletableFuture<Boolean> bootstrap(Long initialToken,
                                            Map<UUID,StreamAddressSpace> streamAddressSpaceMap,
                                            Long readyStateEpoch)

Resets the sequencer with the specified initialToken. BootstrapWithoutTailsUpdate defaulted to false.

Parameters:

initialToken - Token Number which the sequencer starts distributing.

streamAddressSpaceMap - Per stream map of address space.

readyStateEpoch - Epoch at which the sequencer is ready and to stamp tokens.

Returns:

A CompletableFuture which completes once the sequencer is reset.

sendMessage

public void sendMessage(CorfuMsg msg)