com.gfycat.framesequence

Class ConstrainedExecutorService

java.lang.Object

java.util.concurrent.AbstractExecutorService

com.gfycat.framesequence.ConstrainedExecutorService

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService

Direct Known Subclasses:

SerialExecutorService

public class ConstrainedExecutorService
extends java.util.concurrent.AbstractExecutorService

A ExecutorService that delegates to an existing Executor but constrains the number of concurrently executing tasks to a pre-configured value. Copy of ConstrainedExecutorService from com.facebook.fresco:fresco:0.8.1.

Constructor Summary

Constructors

Constructor and Description
ConstrainedExecutorService(java.lang.String name, int maxConcurrency, java.util.concurrent.Executor executor, java.util.concurrent.BlockingQueue<java.lang.Runnable> workQueue) Creates a new ConstrainedExecutorService.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
void	execute(java.lang.Runnable runnable) Submit a task to be executed in the future.
boolean	isIdle() Determine whether or not the queue is idle.
boolean	isShutdown()
boolean	isTerminated()
static ConstrainedExecutorService	newConstrainedExecutor(java.lang.String name, int maxConcurrency, int queueSize, java.util.concurrent.Executor executor) Factory method to create a new ConstrainedExecutorService with an unbounded LinkedBlockingQueue queue.
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor, submit, submit, submit

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstrainedExecutorService

public ConstrainedExecutorService(java.lang.String name,
                                  int maxConcurrency,
                                  java.util.concurrent.Executor executor,
                                  java.util.concurrent.BlockingQueue<java.lang.Runnable> workQueue)

Creates a new ConstrainedExecutorService.

Parameters:

name - Friendly name to identify the executor in logging and reporting.

maxConcurrency - Maximum number of tasks to execute in parallel on the delegate executor.

executor - Delegate executor for actually running tasks.

workQueue - Queue to hold Runnables for eventual execution.

Method Detail

newConstrainedExecutor

public static ConstrainedExecutorService newConstrainedExecutor(java.lang.String name,
                                                                int maxConcurrency,
                                                                int queueSize,
                                                                java.util.concurrent.Executor executor)

Factory method to create a new ConstrainedExecutorService with an unbounded LinkedBlockingQueue queue.

Parameters:

name - Friendly name to identify the executor in logging and reporting.

maxConcurrency - Maximum number of tasks to execute in parallel on the delegate executor.

queueSize - Number of items that can be queued before new submissions are rejected.

executor - Delegate executor for actually running tasks.

Returns:

new ConstrainedExecutorService instance.

isIdle

public boolean isIdle()

Determine whether or not the queue is idle.

Returns:

true if there is no work being executed and the work queue is empty, false otherwise.

execute

public void execute(java.lang.Runnable runnable)

Submit a task to be executed in the future.

Parameters:

runnable - The task to be executed.

shutdown

public void shutdown()

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

awaitTermination

public boolean awaitTermination(long timeout,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException