agi.foundation.infrastructure.threading

(agi.foundation.core-2024r3.jar)

Class ThreadingPolicy

java.lang.Object

agi.foundation.infrastructure.threading.ThreadingPolicy

public final class ThreadingPolicy
extends Object

Specifies how a parallelizable operation should utilize multithreading. By default, the threading policy specifies that parallelizable operations should utilize one thread per logical processor on the system, and that the threads should be recruited from the ThreadPool.

Method Summary

Modifier and Type	Method and Description
static void	configureToUseAllLogicalProcessors() Configures the threading policy so that parallelizable operations use one thread for each logical processor on the system.
static void	configureToUseCurrentThreadOnly() Configures the threading policy so that parallelizable operations are executed using only the thread that invoked them.
static int	getNumberOfThreads() Gets the number of threads to use to execute parallelizable operations.
static ThreadSource	getThreadSource() Gets the source of new threads to be used to execute parallelizable operations.
static void	resetCurrentToDefault() Resets the current threading policy to the default.
static void	setNumberOfThreads(int value) Sets the number of threads to use to execute parallelizable operations.
static void	setThreadSource(ThreadSource value) Sets the source of new threads to be used to execute parallelizable operations.
static void	useCurrentAsDefault() Sets the current threading policy as the default policy to be used for new threads.

Methods inherited from class java.lang.Object

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

Method Detail

configureToUseAllLogicalProcessors

public static void configureToUseAllLogicalProcessors()

Configures the threading policy so that parallelizable operations use one thread for each logical processor on the system. In some partial-trust environments, in may not be possible to determine the number of logical processors. In that case, the threading policy will be configured to use two threads.

configureToUseCurrentThreadOnly

public static void configureToUseCurrentThreadOnly()

Configures the threading policy so that parallelizable operations are executed using only the thread that invoked them. No additional threads are created.

useCurrentAsDefault

public static void useCurrentAsDefault()

Sets the current threading policy as the default policy to be used for new threads.

resetCurrentToDefault

public static void resetCurrentToDefault()

Resets the current threading policy to the default.

getNumberOfThreads

public static int getNumberOfThreads()

Gets the number of threads to use to execute parallelizable operations.

setNumberOfThreads

public static void setNumberOfThreads(int value)

Sets the number of threads to use to execute parallelizable operations.

getThreadSource

@Nonnull
public static ThreadSource getThreadSource()

Gets the source of new threads to be used to execute parallelizable operations.

setThreadSource

public static void setThreadSource(@Nonnull
                                   ThreadSource value)

Sets the source of new threads to be used to execute parallelizable operations.