org.onosproject.store.primitives.impl

Class CachingAsyncConsistentMap<K,V>

java.lang.Object

org.onosproject.store.primitives.impl.DelegatingAsyncConsistentMap<K,V>

org.onosproject.store.primitives.impl.CachingAsyncConsistentMap<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

org.onosproject.store.service.AsyncConsistentMap<K,V>, org.onosproject.store.service.DistributedPrimitive

public class CachingAsyncConsistentMap<K,V>
extends DelegatingAsyncConsistentMap<K,V>

AsyncConsistentMap that caches entries on read.

The cache entries are automatically invalidated when updates are detected either locally or remotely.

This implementation only attempts to serve cached entries for get calls. All other calls skip the cache and directly go the backing map.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

org.onosproject.store.service.DistributedPrimitive.Status, org.onosproject.store.service.DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
CachingAsyncConsistentMap(org.onosproject.store.service.AsyncConsistentMap<K,V> backingMap) Default constructor.
CachingAsyncConsistentMap(org.onosproject.store.service.AsyncConsistentMap<K,V> backingMap, int cacheSize) Constructor to configure cache size.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	clear()
CompletableFuture<org.onosproject.store.service.Versioned<V>>	computeIf(K key, Predicate<? super V> condition, BiFunction<? super K,? super V,? extends V> remappingFunction)
CompletableFuture<Void>	destroy()
CompletableFuture<org.onosproject.store.service.Versioned<V>>	get(K key)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	put(K key, V value)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	putAndGet(K key, V value)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	remove(K key)
CompletableFuture<Boolean>	remove(K key, long version)
CompletableFuture<Boolean>	remove(K key, V value)
CompletableFuture<Boolean>	replace(K key, long oldVersion, V newValue)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	replace(K key, V value)
CompletableFuture<Boolean>	replace(K key, V oldValue, V newValue)

Methods inherited from class org.onosproject.store.primitives.impl.DelegatingAsyncConsistentMap

addListener, addStatusChangeListener, applicationId, commit, containsKey, containsValue, entrySet, equals, hashCode, keySet, name, prepare, prepareAndCommit, putIfAbsent, removeListener, removeStatusChangeListener, rollback, size, statusChangeListeners, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onosproject.store.service.AsyncConsistentMap

addListener, asConsistentMap, asConsistentMap, compute, computeIfAbsent, computeIfPresent, isEmpty, primitiveType

Constructor Detail

CachingAsyncConsistentMap

public CachingAsyncConsistentMap(org.onosproject.store.service.AsyncConsistentMap<K,V> backingMap)

Default constructor.

Parameters:

backingMap - a distributed, strongly consistent map for backing

CachingAsyncConsistentMap

public CachingAsyncConsistentMap(org.onosproject.store.service.AsyncConsistentMap<K,V> backingMap,
                                 int cacheSize)

Constructor to configure cache size.

Parameters:

backingMap - a distributed, strongly consistent map for backing

cacheSize - the maximum size of the cache

Method Detail

destroy

public CompletableFuture<Void> destroy()

get

public CompletableFuture<org.onosproject.store.service.Versioned<V>> get(K key)

Specified by:

get in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

get in class DelegatingAsyncConsistentMap<K,V>

computeIf

public CompletableFuture<org.onosproject.store.service.Versioned<V>> computeIf(K key,
                                                                               Predicate<? super V> condition,
                                                                               BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

computeIf in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

computeIf in class DelegatingAsyncConsistentMap<K,V>

put

public CompletableFuture<org.onosproject.store.service.Versioned<V>> put(K key,
                                                                         V value)

Specified by:

put in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

put in class DelegatingAsyncConsistentMap<K,V>

putAndGet

public CompletableFuture<org.onosproject.store.service.Versioned<V>> putAndGet(K key,
                                                                               V value)

Specified by:

putAndGet in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

putAndGet in class DelegatingAsyncConsistentMap<K,V>

remove

public CompletableFuture<org.onosproject.store.service.Versioned<V>> remove(K key)

Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

remove in class DelegatingAsyncConsistentMap<K,V>

clear

public CompletableFuture<Void> clear()

Specified by:

clear in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

clear in class DelegatingAsyncConsistentMap<K,V>

remove

public CompletableFuture<Boolean> remove(K key,
                                         V value)

Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

remove in class DelegatingAsyncConsistentMap<K,V>

remove

public CompletableFuture<Boolean> remove(K key,
                                         long version)

Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

remove in class DelegatingAsyncConsistentMap<K,V>

replace

public CompletableFuture<org.onosproject.store.service.Versioned<V>> replace(K key,
                                                                             V value)

Specified by:

replace in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

replace in class DelegatingAsyncConsistentMap<K,V>

replace

public CompletableFuture<Boolean> replace(K key,
                                          V oldValue,
                                          V newValue)

Specified by:

replace in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

replace in class DelegatingAsyncConsistentMap<K,V>

replace

public CompletableFuture<Boolean> replace(K key,
                                          long oldVersion,
                                          V newValue)

Specified by:

replace in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

Overrides:

replace in class DelegatingAsyncConsistentMap<K,V>