net.lecousin.framework.concurrent

Class Threading

java.lang.Object

net.lecousin.framework.concurrent.Threading

public final class Threading
extends Object

Utility class to initialize and stop multi-threading, and utiliy methods for multi-threading.

Field Summary

Fields

Modifier and Type	Field and Description
static Object	CPU
static boolean	debugSynchronization
static boolean	traceBlockingTasks
static boolean	traceTaskDone
static boolean	traceTasksNotDone
static boolean	traceTaskTime
static Object	UNMANAGED

Method Summary

Modifier and Type	Method and Description
static String	debug() Return a string containing multi-threading status for debugging purposes.
static TaskManager	get(Object resource) Get the task manager for the given resource.
static List<TaskManager>	getAllTaskManagers() Return all current TaskManager.
static BlockedThreadHandler	getBlockedThreadHandler(Thread thread) Return the object handling a case of a blocked thread for the given thread.
static TaskManager	getCPUTaskManager()
static DrivesTaskManager	getDrivesTaskManager()
static ThreadPoolTaskManager	getUnmanagedTaskManager()
static void	init(ThreadFactory threadFactory, Class<? extends TaskPriorityManager> taskPriorityManager, int nbCPUThreads, DrivesTaskManager.DrivesProvider drivesProvider, int nbUnmanagedThreads) Initialize multi-threading.
static boolean	isInitialized()
static String	printStats() Print statistics.
static void	registerBlockedThreadHandler(BlockedThreadHandler handler, Thread thread) Rregister the given thread.
static void	registerResource(Object resource, TaskManager tm) Register a resource.
static void	unregisterBlockedThreadHandler(Thread thread) Unregister the given thread.
static TaskManager	unregisterResource(Object resource) Unregister a resource.
static <TError extends Exception> void	waitFinished(Collection<? extends Task<?,TError>> tasks) Wait for the given tasks to be done.
static void	waitOneFinished(List<? extends Task<?,?>> tasks) Wait for one of the given task to be done.
static <TError extends Exception> void	waitUnblockedWithError(Collection<AsyncSupplier<?,TError>> tasks) Wait for the given tasks to finish, if one has an error this error is immediately thrown without waiting for other tasks.

Methods inherited from class java.lang.Object

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

Field Detail

traceBlockingTasks

public static boolean traceBlockingTasks

traceTaskTime

public static boolean traceTaskTime

debugSynchronization

public static boolean debugSynchronization

traceTaskDone

public static boolean traceTaskDone

traceTasksNotDone

public static boolean traceTasksNotDone

CPU

public static final Object CPU

UNMANAGED

public static final Object UNMANAGED

Method Detail

init

public static void init(ThreadFactory threadFactory,
                        Class<? extends TaskPriorityManager> taskPriorityManager,
                        int nbCPUThreads,
                        DrivesTaskManager.DrivesProvider drivesProvider,
                        int nbUnmanagedThreads)

Initialize multi-threading. This method is called by the LCCore.Environment instance on initialization.

Parameters:

threadFactory - factory to use when creating threads

taskPriorityManager - the class to use to manage priority of tasks

nbCPUThreads - number of threads to use for CPU tasks, 0 or negative value means the number of available processors returned by Runtime.availableProcessors()

drivesProvider - provides physical drives and associated mount points. If null, File.listRoots() is used and each returned root is considered as a physical drive. This may be changed later on by calling DrivesTaskManager.setDrivesProvider(DrivesProvider).

nbUnmanagedThreads - number of threads to use for unmanaged tasks. If 0 or negative, maximum 100 threads will be used.

isInitialized

public static boolean isInitialized()

getCPUTaskManager

public static TaskManager getCPUTaskManager()

getDrivesTaskManager

public static DrivesTaskManager getDrivesTaskManager()

getUnmanagedTaskManager

public static ThreadPoolTaskManager getUnmanagedTaskManager()

registerResource

public static void registerResource(Object resource,
                                    TaskManager tm)

Register a resource.

unregisterResource

public static TaskManager unregisterResource(Object resource)

Unregister a resource.

get

public static TaskManager get(Object resource)

Get the task manager for the given resource.

getAllTaskManagers

public static List<TaskManager> getAllTaskManagers()

Return all current TaskManager.

registerBlockedThreadHandler

public static void registerBlockedThreadHandler(BlockedThreadHandler handler,
                                                Thread thread)

Rregister the given thread.

unregisterBlockedThreadHandler

public static void unregisterBlockedThreadHandler(Thread thread)

Unregister the given thread.

getBlockedThreadHandler

public static BlockedThreadHandler getBlockedThreadHandler(Thread thread)

Return the object handling a case of a blocked thread for the given thread.

waitFinished

public static <TError extends Exception> void waitFinished(Collection<? extends Task<?,TError>> tasks)
                                                    throws TError extends Exception,
                                                           CancelException

Wait for the given tasks to be done.

Throws:

TError extends Exception

CancelException

waitUnblockedWithError

public static <TError extends Exception> void waitUnblockedWithError(Collection<AsyncSupplier<?,TError>> tasks)
                                                              throws TError extends Exception,
                                                                     CancelException

Wait for the given tasks to finish, if one has an error this error is immediately thrown without waiting for other tasks.

Throws:

TError extends Exception

CancelException

waitOneFinished

public static void waitOneFinished(List<? extends Task<?,?>> tasks)

Wait for one of the given task to be done.

debug

public static String debug()

Return a string containing multi-threading status for debugging purposes.

printStats

public static String printStats()

Print statistics.