Package io.deephaven.kv.common

Class StateWatch<T>

java.lang.Object

io.deephaven.kv.common.StateWatch<T>

Type Parameters:

T - the stateful type

public class StateWatch<T>
extends Object

Implements a common pattern for implementing a stateful watch. Involves a delicate setup of requesting the current state, adapting the listener, publishing the initial state, and starting the watch from the appropriate revision.

Constructor Summary

Constructors

Constructor	Description
StateWatch(@NotNull KVClient kvClient, @NotNull WatchClient watchClient, @NotNull GetPrefixResponseParser<Optional<T>> parser, @NotNull KeyValuesCollectionListener keyValuesCollectionListener)	Translate the parser into a default GetPrefix and delegate to StateWatch(KVClient, WatchClient, GetPrefix, KeyValuesCollectionListener)
StateWatch(@NotNull KVClient kvClient, @NotNull WatchClient watchClient, @NotNull GetPrefixResponseParser<Optional<T>> parser, @NotNull WatchClient.StateListener<T> listener)
StateWatch(@NotNull KVClient kvClient, @NotNull WatchClient watchClient, @NotNull GetPrefix request, @NotNull KeyValuesCollectionListener keyValuesCollectionListener)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<WatchClient.Watch>	createWatch()	Returns a future that will create, but not start, the watch.

Methods inherited from class java.lang.Object

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

Constructor Details

StateWatch

public StateWatch(@NotNull
 @NotNull KVClient kvClient,
 @NotNull
 @NotNull WatchClient watchClient,
 @NotNull
 @NotNull GetPrefix request,
 @NotNull
 @NotNull KeyValuesCollectionListener keyValuesCollectionListener)

StateWatch

public StateWatch(@NotNull
 @NotNull KVClient kvClient,
 @NotNull
 @NotNull WatchClient watchClient,
 @NotNull
 @NotNull GetPrefixResponseParser<Optional<T>> parser,
 @NotNull
 @NotNull KeyValuesCollectionListener keyValuesCollectionListener)

Translate the parser into a default GetPrefix and delegate to StateWatch(KVClient, WatchClient, GetPrefix, KeyValuesCollectionListener)

StateWatch

public StateWatch(@NotNull
 @NotNull KVClient kvClient,
 @NotNull
 @NotNull WatchClient watchClient,
 @NotNull
 @NotNull GetPrefixResponseParser<Optional<T>> parser,
 @NotNull
 @NotNull WatchClient.StateListener<T> listener)

Method Details

createWatch

public CompletableFuture<WatchClient.Watch> createWatch()

Returns a future that will create, but not start, the watch.

Returns:

the future