org.onosproject.store.primitives

Interface DistributedPrimitiveCreator

public interface DistributedPrimitiveCreator

Interface for entity that can create instances of different distributed primitives.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAsyncAtomicCounterNames() Returns the names of all created AsyncAtomicCounter instances.
Set<String>	getAsyncConsistentMapNames() Returns the names of all created AsyncConsistentMap instances.
Set<String>	getWorkQueueNames() Returns the names of all created WorkQueue instances.
<K> AsyncAtomicCounterMap<K>	newAsyncAtomicCounterMap(AtomicCounterMapOptions options) Creates a new AsyncAtomicCounterMap.
<V> AsyncAtomicValue<V>	newAsyncAtomicValue(AtomicValueOptions options) Creates a new AsyncAtomicValue.
<K,V> AsyncConsistentMap<K,V>	newAsyncConsistentMap(ConsistentMapOptions options) Creates a new AsyncConsistentMap.
<K,V> AsyncConsistentMultimap<K,V>	newAsyncConsistentSetMultimap(ConsistentMultimapOptions options) Creates a new set backed AsyncConsistentMultimap.
<V> AsyncConsistentTreeMap<V>	newAsyncConsistentTreeMap(ConsistentTreeMapOptions options) Creates a new AsyncConsistentTreeMap.
AsyncAtomicCounter	newAsyncCounter(AtomicCounterOptions options) Creates a new AsyncAtomicCounter.
AsyncDistributedLock	newAsyncDistributedLock(DistributedLockOptions options) Creates a new AsyncDistributedLock.
<E> AsyncDistributedSet<E>	newAsyncDistributedSet(DistributedSetOptions options) Creates a new AsyncDistributedSet.
<V> AsyncDocumentTree<V>	newAsyncDocumentTree(DocumentTreeOptions options) Creates a new AsyncDocumentTree.
AsyncAtomicIdGenerator	newAsyncIdGenerator(AtomicIdGeneratorOptions options) Creates a new AsyncAtomixIdGenerator.
AsyncLeaderElector	newAsyncLeaderElector(LeaderElectorOptions options) Creates a new AsyncLeaderElector.
<E> WorkQueue<E>	newWorkQueue(WorkQueueOptions options) Creates a new WorkQueue.

Method Detail

newAsyncConsistentMap

<K,V> AsyncConsistentMap<K,V> newAsyncConsistentMap(ConsistentMapOptions options)

Creates a new AsyncConsistentMap.

Type Parameters:

K - key type

V - value type

Parameters:

options - map options

Returns:

map

newAsyncConsistentTreeMap

<V> AsyncConsistentTreeMap<V> newAsyncConsistentTreeMap(ConsistentTreeMapOptions options)

Creates a new AsyncConsistentTreeMap.

Type Parameters:

V - value type

Parameters:

options - tree map options

Returns:

distributedTreeMap

newAsyncConsistentSetMultimap

<K,V> AsyncConsistentMultimap<K,V> newAsyncConsistentSetMultimap(ConsistentMultimapOptions options)

Creates a new set backed AsyncConsistentMultimap.

Type Parameters:

K - key type

V - value type

Parameters:

options - multimap options

Returns:

set backed distributedMultimap

newAsyncAtomicCounterMap

<K> AsyncAtomicCounterMap<K> newAsyncAtomicCounterMap(AtomicCounterMapOptions options)

Creates a new AsyncAtomicCounterMap.

Type Parameters:

K - key type

Parameters:

options - counter map options

Returns:

atomic counter map

newAsyncCounter

AsyncAtomicCounter newAsyncCounter(AtomicCounterOptions options)

Creates a new AsyncAtomicCounter.

Parameters:

options - counter options

Returns:

counter

newAsyncIdGenerator

AsyncAtomicIdGenerator newAsyncIdGenerator(AtomicIdGeneratorOptions options)

Creates a new AsyncAtomixIdGenerator.

Parameters:

options - ID generator options

Returns:

ID generator

newAsyncAtomicValue

<V> AsyncAtomicValue<V> newAsyncAtomicValue(AtomicValueOptions options)

Creates a new AsyncAtomicValue.

Type Parameters:

V - value type

Parameters:

options - value options

Returns:

value

newAsyncDistributedSet

<E> AsyncDistributedSet<E> newAsyncDistributedSet(DistributedSetOptions options)

Creates a new AsyncDistributedSet.

Type Parameters:

E - set entry type

Parameters:

options - set options

Returns:

set

newAsyncDistributedLock

AsyncDistributedLock newAsyncDistributedLock(DistributedLockOptions options)

Creates a new AsyncDistributedLock.

Parameters:

options - lock options

Returns:

lock

newAsyncLeaderElector

AsyncLeaderElector newAsyncLeaderElector(LeaderElectorOptions options)

Creates a new AsyncLeaderElector.

Parameters:

options - leader elector options

Returns:

leader elector

newWorkQueue

<E> WorkQueue<E> newWorkQueue(WorkQueueOptions options)

Creates a new WorkQueue.

Type Parameters:

E - work element type

Parameters:

options - work queue options

Returns:

work queue

newAsyncDocumentTree

<V> AsyncDocumentTree<V> newAsyncDocumentTree(DocumentTreeOptions options)

Creates a new AsyncDocumentTree.

Type Parameters:

V - document tree node value type

Parameters:

options - tree options

Returns:

document tree

getAsyncConsistentMapNames

Set<String> getAsyncConsistentMapNames()

Returns the names of all created AsyncConsistentMap instances.

Returns:

set of AsyncConsistentMap names

getAsyncAtomicCounterNames

Set<String> getAsyncAtomicCounterNames()

Returns the names of all created AsyncAtomicCounter instances.

Returns:

set of AsyncAtomicCounter names

getWorkQueueNames

Set<String> getWorkQueueNames()

Returns the names of all created WorkQueue instances.

Returns:

set of WorkQueue names