maspack.concurrency

Class MultiThreadManager

java.lang.Object

maspack.concurrency.MultiThreadManager

All Implemented Interfaces:

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

public class MultiThreadManager
extends java.lang.Object
implements java.util.concurrent.ExecutorService

Manager of multiple threads, with primary and secondary thread pools. Tasks submitted to primary threads SHOULD NOT DEPEND ON EACH OTHER. This is the purpose of the secondary thread pool. Secondary threads should be reserved for tasks upon which primary threads depend on (e.g. monitoring).

Author:

Antonio

Constructor Summary

Constructors

Constructor and Description
MultiThreadManager(java.lang.String name, int nPrimaryThreads, int nSecondaryThreads, long timeoutMS) Creates primary and secondary thread pools

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<?>	awaitNextCompleted()
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
void	execute(java.util.concurrent.Callable<?> command)
void	execute(java.lang.Runnable command) Executes the supplied command at some time in the future.
java.util.concurrent.Future<?>	executeSecondary(java.lang.Runnable command)
java.util.concurrent.Future<?>	getNextCompleted()
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()
<T> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> task)
java.util.concurrent.Future<?>	submit(java.lang.Runnable task)
<T> java.util.concurrent.Future<T>	submit(java.lang.Runnable task, T result)
<T> java.util.concurrent.Future<T>	submitSecondary(java.util.concurrent.Callable<T> task)
java.util.concurrent.Future<?>	submitSecondary(java.lang.Runnable task)
<T> java.util.concurrent.Future<T>	submitSecondary(java.lang.Runnable task, T result)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiThreadManager

public MultiThreadManager(java.lang.String name,
                          int nPrimaryThreads,
                          int nSecondaryThreads,
                          long timeoutMS)

Creates primary and secondary thread pools

Parameters:

name - name of the thread manager

nPrimaryThreads - fixed number of threads in the primary pool

nSecondaryThreads - maximum number of threads in the secondary pool

timeoutMS - thread time-out

Method Detail

execute

public void execute(java.lang.Runnable command)

Executes the supplied command at some time in the future.

Specified by:

execute in interface java.util.concurrent.Executor

execute

public void execute(java.util.concurrent.Callable<?> command)

executeSecondary

public java.util.concurrent.Future<?> executeSecondary(java.lang.Runnable command)

submit

public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submitSecondary

public <T> java.util.concurrent.Future<T> submitSecondary(java.util.concurrent.Callable<T> task)

submit

public <T> java.util.concurrent.Future<T> submit(java.lang.Runnable task,
                                                 T result)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submitSecondary

public <T> java.util.concurrent.Future<T> submitSecondary(java.lang.Runnable task,
                                                          T result)

submit

public java.util.concurrent.Future<?> submit(java.lang.Runnable task)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submitSecondary

public java.util.concurrent.Future<?> submitSecondary(java.lang.Runnable task)

getNextCompleted

public java.util.concurrent.Future<?> getNextCompleted()

awaitNextCompleted

public java.util.concurrent.Future<?> awaitNextCompleted()

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

shutdownNow

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

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

awaitTermination

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

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAll

public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                                                             throws java.lang.InterruptedException

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAll

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

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                throws java.lang.InterruptedException,
                       java.util.concurrent.ExecutionException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

invokeAny

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

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException