Package com.arpnetworking.utility

Class InstrumentingPoolAdapter

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ForkJoinPool

com.arpnetworking.utility.InstrumentingPoolAdapter

All Implemented Interfaces:

Executor, ExecutorService

public abstract class InstrumentingPoolAdapter
extends ForkJoinPool

An adapter used to facilitate the instrumentation of work pools. Allows for the use of functions that measure the state of the pool, but will throw an exception on any methods that submit work units or query work units.

Author:

Brandon Arp (brandon dot arp at smartsheet dot com), Ville Koskela (ville dot koskela at inscopemetrics dot io)

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ForkJoinPool

ForkJoinPool.ForkJoinWorkerThreadFactory, ForkJoinPool.ManagedBlocker

Field Summary

Fields inherited from class java.util.concurrent.ForkJoinPool

defaultForkJoinWorkerThreadFactory

Constructor Summary

Constructors

Constructor	Description
InstrumentingPoolAdapter()

Method Summary

Modifier and Type	Method	Description
boolean	awaitQuiescence(long timeout, TimeUnit unit)
boolean	awaitTermination(long timeout, TimeUnit unit)
protected int	drainTasksTo(Collection<? super ForkJoinTask<?>> c)
void	execute(Runnable task)
void	execute(ForkJoinTask<?> task)
abstract int	getActiveThreadCount()
boolean	getAsyncMode()
ForkJoinPool.ForkJoinWorkerThreadFactory	getFactory()
abstract int	getParallelism()
abstract int	getPoolSize()
abstract int	getQueuedSubmissionCount()
abstract long	getQueuedTaskCount()
abstract int	getRunningThreadCount()
abstract long	getStealCount()
Thread.UncaughtExceptionHandler	getUncaughtExceptionHandler()
abstract boolean	hasQueuedSubmissions()
<T> T	invoke(ForkJoinTask<T> task)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
abstract boolean	isQuiescent()
boolean	isShutdown()
boolean	isTerminated()
boolean	isTerminating()
protected <T> RunnableFuture<T>	newTaskFor(Runnable runnable, T value)
protected <T> RunnableFuture<T>	newTaskFor(Callable<T> callable)
protected ForkJoinTask<?>	pollSubmission()
void	shutdown()
List<Runnable>	shutdownNow()
ForkJoinTask<?>	submit(Runnable task)
<T> ForkJoinTask<T>	submit(Runnable task, T result)
<T> ForkJoinTask<T>	submit(Callable<T> task)
<T> ForkJoinTask<T>	submit(ForkJoinTask<T> task)
abstract String	toString()

Methods inherited from class java.util.concurrent.ForkJoinPool

commonPool, getCommonPoolParallelism, managedBlock

Methods inherited from class java.lang.Object

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

Constructor Details

InstrumentingPoolAdapter

public InstrumentingPoolAdapter()

Method Details

invoke

public <T> T invoke(ForkJoinTask<T> task)

Overrides:

invoke in class ForkJoinPool

execute

public void execute(ForkJoinTask<?> task)

Overrides:

execute in class ForkJoinPool

execute

public void execute(Runnable task)

Specified by:

execute in interface Executor

Overrides:

execute in class ForkJoinPool

submit

public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task)

Overrides:

submit in class ForkJoinPool

submit

public <T> ForkJoinTask<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ForkJoinPool

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                throws InterruptedException,
ExecutionException

Specified by:

invokeAny in interface ExecutorService

Overrides:

invokeAny in class ForkJoinPool

Throws:

InterruptedException

ExecutionException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

invokeAny in interface ExecutorService

Overrides:

invokeAny in class ForkJoinPool

Throws:

InterruptedException

ExecutionException

TimeoutException

submit

public <T> ForkJoinTask<T> submit(Runnable task,
 T result)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ForkJoinPool

submit

public ForkJoinTask<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class ForkJoinPool

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)

Specified by:

invokeAll in interface ExecutorService

Overrides:

invokeAll in class ForkJoinPool

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Overrides:

invokeAll in class ForkJoinPool

Throws:

InterruptedException

getFactory

public ForkJoinPool.ForkJoinWorkerThreadFactory getFactory()

Overrides:

getFactory in class ForkJoinPool

getUncaughtExceptionHandler

public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

Overrides:

getUncaughtExceptionHandler in class ForkJoinPool

getAsyncMode

public boolean getAsyncMode()

Overrides:

getAsyncMode in class ForkJoinPool

shutdown

public void shutdown()

Specified by:

shutdown in interface ExecutorService

Overrides:

shutdown in class ForkJoinPool

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

Overrides:

shutdownNow in class ForkJoinPool

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface ExecutorService

Overrides:

isTerminated in class ForkJoinPool

isTerminating

public boolean isTerminating()

Overrides:

isTerminating in class ForkJoinPool

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ExecutorService

Overrides:

isShutdown in class ForkJoinPool

awaitTermination

public boolean awaitTermination(long timeout,
 TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface ExecutorService

Overrides:

awaitTermination in class ForkJoinPool

Throws:

InterruptedException

awaitQuiescence

public boolean awaitQuiescence(long timeout,
 TimeUnit unit)

Overrides:

awaitQuiescence in class ForkJoinPool

getParallelism

public abstract int getParallelism()

Overrides:

getParallelism in class ForkJoinPool

getPoolSize

public abstract int getPoolSize()

Overrides:

getPoolSize in class ForkJoinPool

getRunningThreadCount

public abstract int getRunningThreadCount()

Overrides:

getRunningThreadCount in class ForkJoinPool

getActiveThreadCount

public abstract int getActiveThreadCount()

Overrides:

getActiveThreadCount in class ForkJoinPool

isQuiescent

public abstract boolean isQuiescent()

Overrides:

isQuiescent in class ForkJoinPool

getStealCount

public abstract long getStealCount()

Overrides:

getStealCount in class ForkJoinPool

getQueuedTaskCount

public abstract long getQueuedTaskCount()

Overrides:

getQueuedTaskCount in class ForkJoinPool

getQueuedSubmissionCount

public abstract int getQueuedSubmissionCount()

Overrides:

getQueuedSubmissionCount in class ForkJoinPool

hasQueuedSubmissions

public abstract boolean hasQueuedSubmissions()

Overrides:

hasQueuedSubmissions in class ForkJoinPool

toString

public abstract String toString()

Overrides:

toString in class ForkJoinPool

pollSubmission

protected ForkJoinTask<?> pollSubmission()

Overrides:

pollSubmission in class ForkJoinPool

drainTasksTo

protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c)

Overrides:

drainTasksTo in class ForkJoinPool

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Runnable runnable,
 T value)

Overrides:

newTaskFor in class ForkJoinPool

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable)

Overrides:

newTaskFor in class ForkJoinPool