net.datenwerke.async

Interface DwAsyncService

All Known Implementing Classes:

DwAsyncServiceImpl

public interface DwAsyncService

A service that allows to run asynchronous tasks. Via the service managed threadpools (see ExecutorService) can be created.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTerminationForPool(java.lang.String poolToken, long timeout, java.util.concurrent.TimeUnit unit) Blocks until all tasks have completed execution after a shutdown request for the given pool
int	getActiveCountAll() Returns the approximately number of active threads in all pools.
long	getCompletedTaskCountAll() Returns the approximate total number of tasks that have completed execution summed over all pools.
int	getNrOfPools() Returns the number of pools
DwAsyncPool	getPool(java.lang.String poolToken) Returns the pool identified by poolToken or null.
long	getTaskCountAll() Returns the approximate total number of tasks that have ever been scheduled for execution summed over all pools.
DwAsyncPool	initPool(java.lang.String poolToken, PoolConfiguration configuration) Initializes a new pool for the given configuration.
boolean	isShutdownPool(java.lang.String poolToken) Returns true if the pool was asked to shutdown.
boolean	isTerminatedPool(java.lang.String poolToken) Returns true if all tasks have completed following shut down.
boolean	poolExists(java.lang.String poolToken) Returns true if pool identified by poolToken exists
void	shutdownAll() Calls shutdown on all pools.
java.util.List<java.lang.Runnable>	shutdownAllNow() Calls shutdownNow on all pools.
java.util.List<java.lang.Runnable>	shutdownNowDefault() Terminates the default thread pool.
void	shutdownPool(java.lang.String poolToken) If pool exists, the pool is asked to orderly shutdown.
java.util.List<java.lang.Runnable>	shutdownPoolNow(java.lang.String poolToken) If pool exists, the pool is shutdown immediately.
void	submit(java.lang.Runnable task) Submits a task to be run on the default thread pool
void	suhtdownDefault() Shuts down the default thread pool

Method Detail

poolExists

boolean poolExists(java.lang.String poolToken)

Returns true if pool identified by poolToken exists

Parameters:

poolToken - The pool identifier

initPool

DwAsyncPool initPool(java.lang.String poolToken,
                     PoolConfiguration configuration)

Initializes a new pool for the given configuration. If a pool for poolToken already exists, the old pool is terminated.

Parameters:

poolToken -

configuration -

Returns:

The pool

getPool

DwAsyncPool getPool(java.lang.String poolToken)

Returns the pool identified by poolToken or null.

Parameters:

poolToken -

shutdownPool

void shutdownPool(java.lang.String poolToken)

If pool exists, the pool is asked to orderly shutdown.

Parameters:

poolToken -

See Also:

ExecutorService.shutdown()

shutdownPoolNow

java.util.List<java.lang.Runnable> shutdownPoolNow(java.lang.String poolToken)

If pool exists, the pool is shutdown immediately.

Parameters:

poolToken -

Returns:

list of tasks that never commenced execution

See Also:

ExecutorService.shutdownNow()

awaitTerminationForPool

boolean awaitTerminationForPool(java.lang.String poolToken,
                                long timeout,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Blocks until all tasks have completed execution after a shutdown request for the given pool

Parameters:

poolToken - The pool identifier

timeout -

unit -

Throws:

java.lang.InterruptedException

See Also:

ExecutorService.awaitTermination(long, TimeUnit)

isShutdownPool

boolean isShutdownPool(java.lang.String poolToken)

Returns true if the pool was asked to shutdown.

Parameters:

poolToken -

See Also:

ExecutorService.isShutdown()

isTerminatedPool

boolean isTerminatedPool(java.lang.String poolToken)

Returns true if all tasks have completed following shut down.

Parameters:

poolToken -

getNrOfPools

int getNrOfPools()

Returns the number of pools

Returns:

the number of pools

getActiveCountAll

int getActiveCountAll()

Returns the approximately number of active threads in all pools.

Returns:

the number of threads

getTaskCountAll

long getTaskCountAll()

Returns the approximate total number of tasks that have ever been scheduled for execution summed over all pools.

Returns:

The number of tasks

getCompletedTaskCountAll

long getCompletedTaskCountAll()

Returns the approximate total number of tasks that have completed execution summed over all pools.

Returns:

the number of tasks

shutdownAll

void shutdownAll()

Calls shutdown on all pools.

See Also:

DwAsyncPool.shutdown()

shutdownAllNow

java.util.List<java.lang.Runnable> shutdownAllNow()

Calls shutdownNow on all pools.

See Also:

DwAsyncPool.shutdownNow()

submit

void submit(java.lang.Runnable task)

Submits a task to be run on the default thread pool

Parameters:

task -

suhtdownDefault

void suhtdownDefault()

Shuts down the default thread pool

shutdownNowDefault

java.util.List<java.lang.Runnable> shutdownNowDefault()

Terminates the default thread pool.