org.apache.ratis.util

Interface ConcurrentUtils

public interface ConcurrentUtils

Utilities related to concurrent programming.

Method Summary

Modifier and Type	Method and Description
static ExecutorService	newCachedThreadPool(int maximumPoolSize, ThreadFactory threadFactory) The same as Executors.newCachedThreadPool(ThreadFactory) except that this method takes a maximumPoolSize parameter.
static ThreadFactory	newThreadFactory(String namePrefix) Creates a ThreadFactory so that the threads created by the factory are named with the given name prefix.
static ExecutorService	newThreadPoolWithMax(boolean cached, int maximumPoolSize, String namePrefix) Create a new ExecutorService with a maximum pool size.
static <T> CompletableFuture<Void>	parallelForEachAsync(Collection<T> collection, Consumer<? super T> action, Executor executor) The same as collection.parallelStream().forEach(action) except that (1) this method is asynchronous, and (2) an executor can be passed to this method.
static void	shutdownAndWait(ExecutorService executor) Shutdown the given executor and wait for its termination.
static void	shutdownAndWait(TimeDuration waitTime, ExecutorService executor, Consumer<TimeDuration> timoutHandler)
static <E,THROWABLE extends Throwable> E	updateAndGet(AtomicReference<E> reference, CheckedFunction<E,E,THROWABLE> update) Similar to AtomicReference.updateAndGet(java.util.function.UnaryOperator) except that the update function is checked.

Method Detail

updateAndGet

static <E,THROWABLE extends Throwable> E updateAndGet(AtomicReference<E> reference,
                                                      CheckedFunction<E,E,THROWABLE> update)
                                               throws THROWABLE extends Throwable

Similar to AtomicReference.updateAndGet(java.util.function.UnaryOperator) except that the update function is checked.

Throws:

THROWABLE extends Throwable

newThreadFactory

static ThreadFactory newThreadFactory(String namePrefix)

Creates a ThreadFactory so that the threads created by the factory are named with the given name prefix.

Parameters:

namePrefix - the prefix used in the name of the threads created.

Returns:

a new ThreadFactory.

newCachedThreadPool

static ExecutorService newCachedThreadPool(int maximumPoolSize,
                                           ThreadFactory threadFactory)

The same as Executors.newCachedThreadPool(ThreadFactory) except that this method takes a maximumPoolSize parameter.

Parameters:

maximumPoolSize - the maximum number of threads to allow in the pool. When maximumPoolSize == 0, this method is the same as Executors.newCachedThreadPool(ThreadFactory).

Returns:

a new ExecutorService.

newThreadPoolWithMax

static ExecutorService newThreadPoolWithMax(boolean cached,
                                            int maximumPoolSize,
                                            String namePrefix)

Create a new ExecutorService with a maximum pool size. If it is cached, this method is similar to newCachedThreadPool(int, ThreadFactory). Otherwise, this method is similar to Executors.newFixedThreadPool(int).

Parameters:

cached - Use cached thread pool? If not, use a fixed thread pool.

maximumPoolSize - the maximum number of threads to allow in the pool.

namePrefix - the prefix used in the name of the threads created.

Returns:

a new ExecutorService.

shutdownAndWait

static void shutdownAndWait(ExecutorService executor)

Shutdown the given executor and wait for its termination.

Parameters:

executor - The executor to be shut down.

shutdownAndWait

static void shutdownAndWait(TimeDuration waitTime,
                            ExecutorService executor,
                            Consumer<TimeDuration> timoutHandler)

parallelForEachAsync

static <T> CompletableFuture<Void> parallelForEachAsync(Collection<T> collection,
                                                        Consumer<? super T> action,
                                                        Executor executor)

The same as collection.parallelStream().forEach(action) except that (1) this method is asynchronous, and (2) an executor can be passed to this method.

Type Parameters:

T - The element type.

Parameters:

collection - The given collection.

action - To act on each element in the collection.

executor - To execute the action.

Returns:

a CompletableFuture that is completed when the action is completed for each element in the collection.

See Also:

Collection.parallelStream(), Stream.forEach(Consumer)