com.ibm.etcd.client.utils

Class RangeCache

java.lang.Object

com.ibm.etcd.client.utils.RangeCache

All Implemented Interfaces:

AutoCloseable, Iterable<KeyValue>

public class RangeCache
extends Object
implements AutoCloseable, Iterable<KeyValue>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RangeCache.Listener
static class	RangeCache.PutResult

Field Summary

Fields

Modifier and Type	Field and Description
protected Executor	listenerExecutor
protected List<RangeCache.Listener>	listeners
protected static org.slf4j.Logger	logger
static long	TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
RangeCache(EtcdClient client, com.google.protobuf.ByteString prefix)
RangeCache(EtcdClient client, com.google.protobuf.ByteString prefix, boolean sorted)
RangeCache(EtcdClient client, com.google.protobuf.ByteString fromKey, com.google.protobuf.ByteString toKey, boolean sorted)

Method Summary

Modifier and Type	Method and Description
void	addListener(RangeCache.Listener listener)
void	close()
boolean	delete(com.google.protobuf.ByteString key)
boolean	delete(com.google.protobuf.ByteString key, long modRev)
void	forEach(Consumer<? super KeyValue> action)
protected com.google.common.util.concurrent.ListenableFuture<Boolean>	fullRefreshCache()
KeyValue	get(com.google.protobuf.ByteString key)
KeyValue	getFirst()
KeyValue	getRemote(com.google.protobuf.ByteString key)
protected KeyValue	getRemote(com.google.protobuf.ByteString key, boolean weak)
KeyValue	getRemoteWeak(com.google.protobuf.ByteString key)
boolean	isClosed()
protected static boolean	isDeleted(KeyValue kv)
Iterator<KeyValue>	iterator()
boolean	keyExists(com.google.protobuf.ByteString key)
boolean	keyExistsRemote(com.google.protobuf.ByteString key)
Set<com.google.protobuf.ByteString>	keySet()
protected static KeyValue	kvOrNullIfDeleted(KeyValue fromCache)
protected static Compare.Builder	modRevCompare(com.google.protobuf.ByteString key, long modRev)
protected void	notifyListeners(RangeCache.Listener.EventType type, KeyValue keyValue, boolean inListenerExecutor)
protected KeyValue	offerDelete(com.google.protobuf.ByteString key, long modRevision)
protected KeyValue	offerExpiry(com.google.protobuf.ByteString key) Deprecated.
protected KeyValue	offerUpdate(KeyValue keyValue, boolean watchThread)
long	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
RangeCache.PutResult	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long modRev)
RangeCache.PutResult	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long lease, CompareOrBuilder... conditions)
RangeCache.PutResult	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long leaseId, long modRev)
long	putNoGet(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long modRev)
long	putNoGet(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long lease, CompareOrBuilder... conditions)
long	putNoGet(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long leaseId, long modRev)
protected TxnRequest	putTxn(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, boolean getOnFail, long lease, CompareOrBuilder... conditions)
boolean	removeListener(RangeCache.Listener listener)
protected void	revisionUpdate(long upToRev)
int	size()
com.google.common.util.concurrent.ListenableFuture<Boolean>	start()
Iterator<KeyValue>	strongIterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

spliterator

Field Detail

logger

protected static final org.slf4j.Logger logger

TIMEOUT_MS

public static final long TIMEOUT_MS

listeners

protected final List<RangeCache.Listener> listeners

listenerExecutor

protected final Executor listenerExecutor

Constructor Detail

RangeCache

public RangeCache(EtcdClient client,
                  com.google.protobuf.ByteString prefix)

RangeCache

public RangeCache(EtcdClient client,
                  com.google.protobuf.ByteString prefix,
                  boolean sorted)

RangeCache

public RangeCache(EtcdClient client,
                  com.google.protobuf.ByteString fromKey,
                  com.google.protobuf.ByteString toKey,
                  boolean sorted)

Method Detail

start

public com.google.common.util.concurrent.ListenableFuture<Boolean> start()

fullRefreshCache

protected com.google.common.util.concurrent.ListenableFuture<Boolean> fullRefreshCache()

revisionUpdate

protected void revisionUpdate(long upToRev)

addListener

public void addListener(RangeCache.Listener listener)

removeListener

public boolean removeListener(RangeCache.Listener listener)

notifyListeners

protected void notifyListeners(RangeCache.Listener.EventType type,
                               KeyValue keyValue,
                               boolean inListenerExecutor)

offerExpiry

protected KeyValue offerExpiry(com.google.protobuf.ByteString key)

Deprecated. this method now has no effect

offerDelete

protected KeyValue offerDelete(com.google.protobuf.ByteString key,
                               long modRevision)

offerUpdate

protected KeyValue offerUpdate(KeyValue keyValue,
                               boolean watchThread)

kvOrNullIfDeleted

protected static KeyValue kvOrNullIfDeleted(KeyValue fromCache)

isDeleted

protected static boolean isDeleted(KeyValue kv)

get

public KeyValue get(com.google.protobuf.ByteString key)

getFirst

public KeyValue getFirst()

getRemote

protected KeyValue getRemote(com.google.protobuf.ByteString key,
                             boolean weak)

getRemote

public KeyValue getRemote(com.google.protobuf.ByteString key)

getRemoteWeak

public KeyValue getRemoteWeak(com.google.protobuf.ByteString key)

size

public int size()

keyExists

public boolean keyExists(com.google.protobuf.ByteString key)

keyExistsRemote

public boolean keyExistsRemote(com.google.protobuf.ByteString key)

put

public long put(com.google.protobuf.ByteString key,
                com.google.protobuf.ByteString value)

put

public RangeCache.PutResult put(com.google.protobuf.ByteString key,
                                com.google.protobuf.ByteString value,
                                long lease,
                                CompareOrBuilder... conditions)

put

public RangeCache.PutResult put(com.google.protobuf.ByteString key,
                                com.google.protobuf.ByteString value,
                                long modRev)

put

public RangeCache.PutResult put(com.google.protobuf.ByteString key,
                                com.google.protobuf.ByteString value,
                                long leaseId,
                                long modRev)

putNoGet

public long putNoGet(com.google.protobuf.ByteString key,
                     com.google.protobuf.ByteString value,
                     long lease,
                     CompareOrBuilder... conditions)

putNoGet

public long putNoGet(com.google.protobuf.ByteString key,
                     com.google.protobuf.ByteString value,
                     long modRev)

putNoGet

public long putNoGet(com.google.protobuf.ByteString key,
                     com.google.protobuf.ByteString value,
                     long leaseId,
                     long modRev)

modRevCompare

protected static Compare.Builder modRevCompare(com.google.protobuf.ByteString key,
                                               long modRev)

putTxn

protected TxnRequest putTxn(com.google.protobuf.ByteString key,
                            com.google.protobuf.ByteString value,
                            boolean getOnFail,
                            long lease,
                            CompareOrBuilder... conditions)

delete

public boolean delete(com.google.protobuf.ByteString key)

delete

public boolean delete(com.google.protobuf.ByteString key,
                      long modRev)

keySet

public Set<com.google.protobuf.ByteString> keySet()

iterator

public Iterator<KeyValue> iterator()

forEach

public void forEach(Consumer<? super KeyValue> action)

strongIterator

public Iterator<KeyValue> strongIterator()

close

public void close()

isClosed

public boolean isClosed()