org.infinispan.reactive.publisher.impl

Interface ClusterPublisherManager<K,V>

Type Parameters:

K - The key type for the underlying cache

V - the value type for the underlying cache

All Known Implementing Classes:

ClusterPublisherManagerImpl, LocalClusterPublisherManagerImpl, PartitionAwareClusterPublisherManager

public interface ClusterPublisherManager<K,V>

Manages distribution of various publisher operations that are ran locally and/or sent to remote nodes.

Since:

10.0

Author:

wburns

Method Summary

Modifier and Type	Method and Description
<R> SegmentCompletionPublisher<R>	entryPublisher(IntSet segments, Set<K> keysToInclude, InvocationContext invocationContext, boolean includeLoader, DeliveryGuarantee deliveryGuarantee, int batchSize, Function<? super org.reactivestreams.Publisher<CacheEntry<K,V>>,? extends org.reactivestreams.Publisher<R>> transformer) Performs the given transformer on data in the cache, resulting in multiple values.
<R> CompletionStage<R>	entryReduction(boolean parallelPublisher, IntSet segments, Set<K> keysToInclude, InvocationContext invocationContext, boolean includeLoader, DeliveryGuarantee deliveryGuarantee, Function<? super org.reactivestreams.Publisher<CacheEntry<K,V>>,? extends CompletionStage<R>> transformer, Function<? super org.reactivestreams.Publisher<R>,? extends CompletionStage<R>> finalizer) Performs the given transformer and finalizer on data in the cache, resulting in a single value.
<R> SegmentCompletionPublisher<R>	keyPublisher(IntSet segments, Set<K> keysToInclude, InvocationContext invocationContext, boolean includeLoader, DeliveryGuarantee deliveryGuarantee, int batchSize, Function<? super org.reactivestreams.Publisher<K>,? extends org.reactivestreams.Publisher<R>> transformer) Same as entryPublisher(IntSet, Set, InvocationContext, boolean, DeliveryGuarantee, int, Function) except that the source publisher provided to the transformer is made up of keys only.
<R> CompletionStage<R>	keyReduction(boolean parallelPublisher, IntSet segments, Set<K> keysToInclude, InvocationContext invocationContext, boolean includeLoader, DeliveryGuarantee deliveryGuarantee, Function<? super org.reactivestreams.Publisher<K>,? extends CompletionStage<R>> transformer, Function<? super org.reactivestreams.Publisher<R>,? extends CompletionStage<R>> finalizer) Same as entryReduction(boolean, IntSet, Set, InvocationContext, boolean, DeliveryGuarantee, Function, Function) except that the source publisher provided to the transformer is made up of keys only.

Method Detail

keyReduction

<R> CompletionStage<R> keyReduction(boolean parallelPublisher,
                                    IntSet segments,
                                    Set<K> keysToInclude,
                                    InvocationContext invocationContext,
                                    boolean includeLoader,
                                    DeliveryGuarantee deliveryGuarantee,
                                    Function<? super org.reactivestreams.Publisher<K>,? extends CompletionStage<R>> transformer,
                                    Function<? super org.reactivestreams.Publisher<R>,? extends CompletionStage<R>> finalizer)

Same as entryReduction(boolean, IntSet, Set, InvocationContext, boolean, DeliveryGuarantee, Function, Function) except that the source publisher provided to the transformer is made up of keys only.

Type Parameters:

R - return value type

Returns:

CompletionStage that contains the resulting value when complete

entryReduction

<R> CompletionStage<R> entryReduction(boolean parallelPublisher,
                                      IntSet segments,
                                      Set<K> keysToInclude,
                                      InvocationContext invocationContext,
                                      boolean includeLoader,
                                      DeliveryGuarantee deliveryGuarantee,
                                      Function<? super org.reactivestreams.Publisher<CacheEntry<K,V>>,? extends CompletionStage<R>> transformer,
                                      Function<? super org.reactivestreams.Publisher<R>,? extends CompletionStage<R>> finalizer)

Performs the given transformer and finalizer on data in the cache, resulting in a single value. Depending on the deliveryGuarantee the transformer may be invoked 1..numSegments times. It could be that the transformer is invoked for every segment and produces a result. All of these results are then fed into the finalizer to produce a final result. If publisher is parallel the finalizer will be invoked on each node to ensure there is only a single result per node.

Type Parameters:

R - return value type

Parameters:

parallelPublisher - Whether on each node the publisher should be parallelized remotely and locally

segments - determines what entries should be evaluated by only using ones that map to the given segments (if null assumes all segments)

keysToInclude - set of keys that should only be used (if null all entries for the given segments will be evaluated)

invocationContext - context of the invoking operation, context entries override the values in the cache (may be null)

includeLoader - whether to include entries from the underlying cache loader if any

deliveryGuarantee - delivery guarantee for given entries

transformer - reduces the given publisher of data eventually into a single value. Must not be null.

finalizer - reduces all of the single values produced by the transformer or this finalizer into one final value. Must not be null.

Returns:

CompletionStage that contains the resulting value when complete

keyPublisher

<R> SegmentCompletionPublisher<R> keyPublisher(IntSet segments,
                                               Set<K> keysToInclude,
                                               InvocationContext invocationContext,
                                               boolean includeLoader,
                                               DeliveryGuarantee deliveryGuarantee,
                                               int batchSize,
                                               Function<? super org.reactivestreams.Publisher<K>,? extends org.reactivestreams.Publisher<R>> transformer)

Same as entryPublisher(IntSet, Set, InvocationContext, boolean, DeliveryGuarantee, int, Function) except that the source publisher provided to the transformer is made up of keys only.

Type Parameters:

R - return value type

Returns:

Publisher that when subscribed to will return the results and notify of segment completion if necessary

entryPublisher

<R> SegmentCompletionPublisher<R> entryPublisher(IntSet segments,
                                                 Set<K> keysToInclude,
                                                 InvocationContext invocationContext,
                                                 boolean includeLoader,
                                                 DeliveryGuarantee deliveryGuarantee,
                                                 int batchSize,
                                                 Function<? super org.reactivestreams.Publisher<CacheEntry<K,V>>,? extends org.reactivestreams.Publisher<R>> transformer)

Performs the given transformer on data in the cache, resulting in multiple values. If a single value is desired, the user should use entryReduction(boolean, IntSet, Set, InvocationContext, boolean, DeliveryGuarantee, Function, Function) instead as it can optimize some things. Depending on the deliveryGuarantee the transformer may be invoked 1..numSegments times per node. Results from a given node will retrieve values up to batchSize values until some are consumed.

Type Parameters:

R - return value type

Parameters:

segments - determines what entries should be evaluated by only using ones that map to the given segments (if null assumes all segments)

keysToInclude - set of keys that should only be used (if null all entries for the given segments will be evaluated)

invocationContext - context of the invoking operation, context entries override the values in the cache (may be null)

includeLoader - whether to include entries from the underlying cache loader if any

deliveryGuarantee - delivery guarantee for given entries

batchSize - how many entries to be returned at a given time

transformer - transform the given stream of data into something else (requires non null)

Returns:

Publisher that when subscribed to will return the results and notify of segment completion if necessary