org.hkijena.jipipe.api

Class JIPipeFixedThreadPool

java.lang.Object

org.hkijena.jipipe.api.JIPipeFixedThreadPool

All Implemented Interfaces:

AutoCloseable

public class JIPipeFixedThreadPool
extends Object
implements AutoCloseable

Contains a fixed thread pool. Unfortunately, the one provided by SciJava is cached (unbounded)

Constructor Summary

Constructors

Constructor and Description
JIPipeFixedThreadPool(int maxThreads) Initializes a pool with the specified amount of threads.

Method Summary

Modifier and Type	Method and Description
void	close()
ExecutorService	getExecutorService() Returns the ExecutorService or null.
int	getMaxThreads()
Future<Exception>	schedule(Runnable runnable) Schedules a runnable
List<Future<Exception>>	scheduleBatches(List<Runnable> tasks, int batchSize) Schedules multiple tasks at once, split into batches.
void	shutdown() Forces the thread pool to shut down

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeFixedThreadPool

public JIPipeFixedThreadPool(int maxThreads)

Initializes a pool with the specified amount of threads. If maxThreads less than 2, no ExecutorService is created and all workloads are run in single-threaded mode

Parameters:

maxThreads - number of threads. must be larger or equal to 1

Method Detail

schedule

public Future<Exception> schedule(Runnable runnable)

Schedules a runnable

Parameters:

runnable - the function

Returns:

a future returning null if successful or an exception if there was an error

scheduleBatches

public List<Future<Exception>> scheduleBatches(List<Runnable> tasks,
                                               int batchSize)

Schedules multiple tasks at once, split into batches. In each batch, the tasks are run single-threaded

Parameters:

tasks - the tasks to run

batchSize - the number of tasks per batch

Returns:

a futures returning null if successful or an exception if there was an error

getMaxThreads

public int getMaxThreads()

getExecutorService

public ExecutorService getExecutorService()

Returns the ExecutorService or null. This will return null if getMaxThreads() is less than 1

Returns:

the ExecutorService or null

shutdown

public void shutdown()

Forces the thread pool to shut down

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception