Package io.deephaven.kv

Interface WatchClient

All Known Implementing Classes:

WatchClientEtcd

public interface WatchClient

A watch client allows the creation and management of watch-based requests against a KV store. A watch is against a specific key, or a specific key prefix, where the server will send asynchronous push notification whenever the relevant key(s) change (in response to puts or delete key or delete keys).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WatchClient.Listener	Interface for receiving WatchResponses.
static interface	WatchClient.SingleKeyPathListener	A simplified interface simplifying WatchClient.Listener for single key path watches.
static interface	WatchClient.StateListener<T>	A watch listener style interface for a stateful type T.
static interface	WatchClient.UnitListener	A simplified "deltas" interface for WatchClient.Listener.
static interface	WatchClient.Watch	Represents the watch.
static enum	WatchClient.WatchState	The states of a WatchClient.Watch.

Method Summary

Modifier and Type	Method	Description
WatchClient.Watch	watch(WatchKeyPrefix request, WatchClient.Listener listener)	Creates a watch against a specific key prefix.
default WatchClient.Watch	watch(WatchKeyPrefix request, WatchClient.UnitListener listener)	Creates a watch against a specific key prefix.
WatchClient.Watch	watch(WatchKey request, WatchClient.Listener listener)	Creates a watch against a specific key.
default WatchClient.Watch	watch(WatchKey request, WatchClient.SingleKeyPathListener listener)	Creates a watch against a specific key.
default WatchClient.Watch	watch(WatchKey request, WatchClient.UnitListener listener)	Creates a watch against a specific key.

Method Details

watch

WatchClient.Watch watch(WatchKey request,
 WatchClient.Listener listener)

Creates a watch against a specific key.

Parameters:

request - the watch key request

listener - the listener

Returns:

the watch

watch

WatchClient.Watch watch(WatchKeyPrefix request,
 WatchClient.Listener listener)

Creates a watch against a specific key prefix.

Parameters:

request - the watch key prefix request

listener - the listener

Returns:

the watch

watch

default WatchClient.Watch watch(WatchKey request,
 WatchClient.UnitListener listener)

Creates a watch against a specific key.

Parameters:

request - the watch key request

listener - the listener

Returns:

the watch

watch

default WatchClient.Watch watch(WatchKeyPrefix request,
 WatchClient.UnitListener listener)

Creates a watch against a specific key prefix.

Parameters:

request - the watch key prefix request

listener - the listener

Returns:

the watch

watch

default WatchClient.Watch watch(WatchKey request,
 WatchClient.SingleKeyPathListener listener)

Creates a watch against a specific key.

Parameters:

request - the watch key request

listener - the listener

Returns:

the watch