org.apache.giraph.utils

Class ProgressableUtils

java.lang.Object

org.apache.giraph.utils.ProgressableUtils

public class ProgressableUtils
extends Object

Functions for waiting on some events to happen while reporting progress

Method Summary

Modifier and Type	Method and Description
static void	awaitChannelFuture(io.netty.channel.ChannelFuture future, org.apache.hadoop.util.Progressable progressable) Wait for ChannelFuture to finish, while periodically reporting progress.
static void	awaitChannelGroupFuture(io.netty.channel.group.ChannelGroupFuture future, org.apache.hadoop.util.Progressable progressable) Wait for ChannelGroupFuture to finish, while periodically reporting progress.
static void	awaitExecutorTermination(ExecutorService executor, org.apache.hadoop.util.Progressable progressable) Wait for executor tasks to terminate, while periodically reporting progress.
static void	awaitExecutorTermination(ExecutorService executor, org.apache.hadoop.util.Progressable progressable, int msecsPeriod) Wait for executor tasks to terminate, while periodically reporting progress.
static void	awaitSemaphorePermits(Semaphore semaphore, int permits, org.apache.hadoop.util.Progressable progressable) Wait to acquire enough permits from Semaphore, while periodically reporting progress.
static void	awaitTerminationFuture(io.netty.util.concurrent.EventExecutorGroup group, org.apache.hadoop.util.Progressable progressable) Wait for executorgroup to terminate, while periodically reporting progress
static <T> T	getFutureResult(Future<T> future, org.apache.hadoop.util.Progressable progressable) Wait for the result of the future to be ready, while periodically reporting progress.
static <R> List<R>	getResultsWithNCallables(CallableFactory<R> callableFactory, int numThreads, String threadNameFormat, org.apache.hadoop.util.Progressable progressable) Create {#link numThreads} callables from {#link callableFactory}, execute them and gather results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

awaitExecutorTermination

public static void awaitExecutorTermination(ExecutorService executor,
                                            org.apache.hadoop.util.Progressable progressable,
                                            int msecsPeriod)

Wait for executor tasks to terminate, while periodically reporting progress.

Parameters:

executor - Executor which we are waiting for

progressable - Progressable for reporting progress (Job context)

msecsPeriod - How often to report progress

awaitExecutorTermination

public static void awaitExecutorTermination(ExecutorService executor,
                                            org.apache.hadoop.util.Progressable progressable)

Wait for executor tasks to terminate, while periodically reporting progress.

Parameters:

executor - Executor which we are waiting for

progressable - Progressable for reporting progress (Job context)

awaitTerminationFuture

public static void awaitTerminationFuture(io.netty.util.concurrent.EventExecutorGroup group,
                                          org.apache.hadoop.util.Progressable progressable)

Wait for executorgroup to terminate, while periodically reporting progress

Parameters:

group - ExecutorGroup whose termination we are awaiting

progressable - Progressable for reporting progress (Job context)

getFutureResult

public static <T> T getFutureResult(Future<T> future,
                                    org.apache.hadoop.util.Progressable progressable)

Wait for the result of the future to be ready, while periodically reporting progress.

Type Parameters:

T - Type of the return value of the future

Parameters:

future - Future

progressable - Progressable for reporting progress (Job context)

Returns:

Computed result of the future.

awaitChannelGroupFuture

public static void awaitChannelGroupFuture(io.netty.channel.group.ChannelGroupFuture future,
                                           org.apache.hadoop.util.Progressable progressable)

Wait for ChannelGroupFuture to finish, while periodically reporting progress.

Parameters:

future - ChannelGroupFuture

progressable - Progressable for reporting progress (Job context)

awaitChannelFuture

public static void awaitChannelFuture(io.netty.channel.ChannelFuture future,
                                      org.apache.hadoop.util.Progressable progressable)

Wait for ChannelFuture to finish, while periodically reporting progress.

Parameters:

future - ChannelFuture

progressable - Progressable for reporting progress (Job context)

awaitSemaphorePermits

public static void awaitSemaphorePermits(Semaphore semaphore,
                                         int permits,
                                         org.apache.hadoop.util.Progressable progressable)

Wait to acquire enough permits from Semaphore, while periodically reporting progress.

Parameters:

semaphore - Semaphore

permits - How many permits to acquire

progressable - Progressable for reporting progress (Job context)

getResultsWithNCallables

public static <R> List<R> getResultsWithNCallables(CallableFactory<R> callableFactory,
                                                   int numThreads,
                                                   String threadNameFormat,
                                                   org.apache.hadoop.util.Progressable progressable)

Create {#link numThreads} callables from {#link callableFactory}, execute them and gather results.

Type Parameters:

R - Type of Callable's results

Parameters:

callableFactory - Factory for Callables

numThreads - Number of threads to use

threadNameFormat - Format for thread name

progressable - Progressable for reporting progress

Returns:

List of results from Callables