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.
default <K> AsyncAtomicCounterMap<K>	newAsyncAtomicCounterMap(String name, Serializer serializer) Creates a new AsyncAtomicCounterMap.
<K> AsyncAtomicCounterMap<K>	newAsyncAtomicCounterMap(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new AsyncAtomicCounterMap.
default <V> AsyncAtomicValue<V>	newAsyncAtomicValue(String name, Serializer serializer) Creates a new AsyncAtomicValue.
<V> AsyncAtomicValue<V>	newAsyncAtomicValue(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new AsyncAtomicValue.
default <K,V> AsyncConsistentMap<K,V>	newAsyncConsistentMap(String name, Serializer serializer) Creates a new AsyncConsistentMap.
<K,V> AsyncConsistentMap<K,V>	newAsyncConsistentMap(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new AsyncConsistentMap.
default <K,V> AsyncConsistentMultimap<K,V>	newAsyncConsistentSetMultimap(String name, Serializer serializer) Creates a new set backed AsyncConsistentMultimap.
<K,V> AsyncConsistentMultimap<K,V>	newAsyncConsistentSetMultimap(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new set backed AsyncConsistentMultimap.
default <V> AsyncConsistentTreeMap<V>	newAsyncConsistentTreeMap(String name, Serializer serializer) Creates a new AsyncConsistentTreeMap.
<V> AsyncConsistentTreeMap<V>	newAsyncConsistentTreeMap(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new AsyncConsistentTreeMap.
default AsyncAtomicCounter	newAsyncCounter(String name) Creates a new AsyncAtomicCounter.
AsyncAtomicCounter	newAsyncCounter(String name, Supplier<Executor> executorSupplier) Creates a new AsyncAtomicCounter.
default <E> AsyncDistributedSet<E>	newAsyncDistributedSet(String name, Serializer serializer) Creates a new AsyncDistributedSet.
<E> AsyncDistributedSet<E>	newAsyncDistributedSet(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new AsyncDistributedSet.
default <V> AsyncDocumentTree<V>	newAsyncDocumentTree(String name, Serializer serializer) Creates a new AsyncDocumentTree.
<V> AsyncDocumentTree<V>	newAsyncDocumentTree(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new AsyncDocumentTree.
default AsyncAtomicIdGenerator	newAsyncIdGenerator(String name) Creates a new AsyncAtomixIdGenerator.
AsyncAtomicIdGenerator	newAsyncIdGenerator(String name, Supplier<Executor> executorSupplier) Creates a new AsyncAtomixIdGenerator.
default AsyncLeaderElector	newAsyncLeaderElector(String name) Creates a new AsyncLeaderElector.
AsyncLeaderElector	newAsyncLeaderElector(String name, Supplier<Executor> executorSupplier) Creates a new AsyncLeaderElector.
default <E> WorkQueue<E>	newWorkQueue(String name, Serializer serializer) Creates a new WorkQueue.
<E> WorkQueue<E>	newWorkQueue(String name, Serializer serializer, Supplier<Executor> executorSupplier) Creates a new WorkQueue.

Method Detail

newAsyncConsistentMap

default <K,V> AsyncConsistentMap<K,V> newAsyncConsistentMap(String name,
                                                            Serializer serializer)

Creates a new AsyncConsistentMap.

Type Parameters:

K - key type

V - value type

Parameters:

name - map name

serializer - serializer to use for serializing/deserializing map entries

Returns:

map

newAsyncConsistentMap

<K,V> AsyncConsistentMap<K,V> newAsyncConsistentMap(String name,
                                                    Serializer serializer,
                                                    Supplier<Executor> executorSupplier)

Creates a new AsyncConsistentMap.

Type Parameters:

K - key type

V - value type

Parameters:

name - map name

serializer - serializer to use for serializing/deserializing map entries

executorSupplier - a callback that returns an executor to be used for each partition

Returns:

map

newAsyncConsistentTreeMap

default <V> AsyncConsistentTreeMap<V> newAsyncConsistentTreeMap(String name,
                                                                Serializer serializer)

Creates a new AsyncConsistentTreeMap.

Type Parameters:

V - value type

Parameters:

name - tree name

serializer - serializer to use for serializing/deserializing map entries

Returns:

distributedTreeMap

newAsyncConsistentTreeMap

<V> AsyncConsistentTreeMap<V> newAsyncConsistentTreeMap(String name,
                                                        Serializer serializer,
                                                        Supplier<Executor> executorSupplier)

Creates a new AsyncConsistentTreeMap.

Type Parameters:

V - value type

Parameters:

name - tree name

serializer - serializer to use for serializing/deserializing map entries

executorSupplier - a callback that returns an executor to be used for each partition

Returns:

distributedTreeMap

newAsyncConsistentSetMultimap

default <K,V> AsyncConsistentMultimap<K,V> newAsyncConsistentSetMultimap(String name,
                                                                         Serializer serializer)

Creates a new set backed AsyncConsistentMultimap.

Type Parameters:

K - key type

V - value type

Parameters:

name - multimap name

serializer - serializer to use for serializing/deserializing

Returns:

set backed distributedMultimap

newAsyncConsistentSetMultimap

<K,V> AsyncConsistentMultimap<K,V> newAsyncConsistentSetMultimap(String name,
                                                                 Serializer serializer,
                                                                 Supplier<Executor> executorSupplier)

Creates a new set backed AsyncConsistentMultimap.

Type Parameters:

K - key type

V - value type

Parameters:

name - multimap name

serializer - serializer to use for serializing/deserializing

executorSupplier - a callback that returns an executor to be used for each partition

Returns:

set backed distributedMultimap

newAsyncAtomicCounterMap

default <K> AsyncAtomicCounterMap<K> newAsyncAtomicCounterMap(String name,
                                                              Serializer serializer)

Creates a new AsyncAtomicCounterMap.

Type Parameters:

K - key type

Parameters:

name - counter map name

serializer - serializer to use for serializing/deserializing keys

Returns:

atomic counter map

newAsyncAtomicCounterMap

<K> AsyncAtomicCounterMap<K> newAsyncAtomicCounterMap(String name,
                                                      Serializer serializer,
                                                      Supplier<Executor> executorSupplier)

Creates a new AsyncAtomicCounterMap.

Type Parameters:

K - key type

Parameters:

name - counter map name

serializer - serializer to use for serializing/deserializing keys

executorSupplier - a callback that returns an executor to be used for each partition

Returns:

atomic counter map

newAsyncCounter

default AsyncAtomicCounter newAsyncCounter(String name)

Creates a new AsyncAtomicCounter.

Parameters:

name - counter name

Returns:

counter

newAsyncCounter

AsyncAtomicCounter newAsyncCounter(String name,
                                   Supplier<Executor> executorSupplier)

Creates a new AsyncAtomicCounter.

Parameters:

name - counter name

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

Returns:

counter

newAsyncIdGenerator

default AsyncAtomicIdGenerator newAsyncIdGenerator(String name)

Creates a new AsyncAtomixIdGenerator.

Parameters:

name - ID generator name

Returns:

ID generator

newAsyncIdGenerator

AsyncAtomicIdGenerator newAsyncIdGenerator(String name,
                                           Supplier<Executor> executorSupplier)

Creates a new AsyncAtomixIdGenerator.

Parameters:

name - ID generator name

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

Returns:

ID generator

newAsyncAtomicValue

default <V> AsyncAtomicValue<V> newAsyncAtomicValue(String name,
                                                    Serializer serializer)

Creates a new AsyncAtomicValue.

Type Parameters:

V - value type

Parameters:

name - value name

serializer - serializer to use for serializing/deserializing value type

Returns:

value

newAsyncAtomicValue

<V> AsyncAtomicValue<V> newAsyncAtomicValue(String name,
                                            Serializer serializer,
                                            Supplier<Executor> executorSupplier)

Creates a new AsyncAtomicValue.

Type Parameters:

V - value type

Parameters:

name - value name

serializer - serializer to use for serializing/deserializing value type

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

Returns:

value

newAsyncDistributedSet

default <E> AsyncDistributedSet<E> newAsyncDistributedSet(String name,
                                                          Serializer serializer)

Creates a new AsyncDistributedSet.

Type Parameters:

E - set entry type

Parameters:

name - set name

serializer - serializer to use for serializing/deserializing set entries

Returns:

set

newAsyncDistributedSet

<E> AsyncDistributedSet<E> newAsyncDistributedSet(String name,
                                                  Serializer serializer,
                                                  Supplier<Executor> executorSupplier)

Creates a new AsyncDistributedSet.

Type Parameters:

E - set entry type

Parameters:

name - set name

serializer - serializer to use for serializing/deserializing set entries

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

Returns:

set

newAsyncLeaderElector

default AsyncLeaderElector newAsyncLeaderElector(String name)

Creates a new AsyncLeaderElector.

Parameters:

name - leader elector name

Returns:

leader elector

newAsyncLeaderElector

AsyncLeaderElector newAsyncLeaderElector(String name,
                                         Supplier<Executor> executorSupplier)

Creates a new AsyncLeaderElector.

Parameters:

name - leader elector name

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

Returns:

leader elector

newWorkQueue

default <E> WorkQueue<E> newWorkQueue(String name,
                                      Serializer serializer)

Creates a new WorkQueue.

Type Parameters:

E - work element type

Parameters:

name - work queue name

serializer - serializer

Returns:

work queue

newWorkQueue

<E> WorkQueue<E> newWorkQueue(String name,
                              Serializer serializer,
                              Supplier<Executor> executorSupplier)

Creates a new WorkQueue.

Type Parameters:

E - work element type

Parameters:

name - work queue name

serializer - serializer

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

Returns:

work queue

newAsyncDocumentTree

default <V> AsyncDocumentTree<V> newAsyncDocumentTree(String name,
                                                      Serializer serializer)

Creates a new AsyncDocumentTree.

Type Parameters:

V - document tree node value type

Parameters:

name - tree name

serializer - serializer

Returns:

document tree

newAsyncDocumentTree

<V> AsyncDocumentTree<V> newAsyncDocumentTree(String name,
                                              Serializer serializer,
                                              Supplier<Executor> executorSupplier)

Creates a new AsyncDocumentTree.

Type Parameters:

V - document tree node value type

Parameters:

name - tree name

serializer - serializer

executorSupplier - a callback that returns an executor to be used asynchronous callbacks

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