Package com.azure.core.util

Class SharedExecutorService

java.lang.Object

com.azure.core.util.SharedExecutorService

All Implemented Interfaces:

AutoCloseable, Executor, ExecutorService, ScheduledExecutorService

public final class SharedExecutorService
extends Object
implements ScheduledExecutorService

An ScheduledExecutorService that is shared by multiple consumers.

If setExecutorService(ScheduledExecutorService) isn't called a default shared executor service is created using the following configuration settings:

• azure.sdk.shared.threadpool.maxpoolsize system property or AZURE_SDK_SHARED_THREADPOOL_MAXPOOLSIZE environment variable - The maximum pool size of the shared executor service. If not set, it defaults to 10 times the number of available processors.
• azure.sdk.shared.threadpool.keepalivemillis system property or {code AZURE_SDK_SHARED_THREADPOOL_KEEPALIVEMILLIS} environment variable - The keep alive time in millis for threads in the shared executor service. If not set, it defaults to 60 seconds. Limited to integer size.
• azure.sdk.shared.threadpool.usevirtualthreads system property or AZURE_SDK_SHARED_THREADPOOL_USEVIRTUALTHREADS environment variable - A boolean flag to indicate if the shared executor service should use virtual threads. If not set, it defaults to true. Ignored if virtual threads are not available in the runtime.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)	Shutdown isn't supported for this executor service as it is shared by multiple consumers.
void	execute(Runnable command)
ScheduledExecutorService	getExecutorService()	Gets the backing executor service for the shared instance.
static SharedExecutorService	getInstance()	Gets the shared instance of the executor service.
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
boolean	isShutdown()	Checks if the executor service is shutdown.
boolean	isTerminated()	Checks if the executor service is terminated.
void	reset()	Resets the state of the getInstance() to an uninitialized state.
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
void	setExecutorService(ScheduledExecutorService executorService)	Sets the backing executor service for the shared instance.
void	shutdown()	Shutdown isn't supported for this executor service as it is shared by multiple consumers.
List<Runnable>	shutdownNow()	Shutdown isn't supported for this executor service as it is shared by multiple consumers.
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

close

Method Details

getInstance

public static SharedExecutorService getInstance()

Gets the shared instance of the executor service.

Returns:

The shared instance of the executor service.

getExecutorService

public ScheduledExecutorService getExecutorService()

Gets the backing executor service for the shared instance.

This returns the executor service for all users of the shared instance. Meaning, if another area in code already had a reference to the shared instance.

This may return null if the shared instance has not been set yet.

Returns:

The executor service that is set as the shared instance, may be null if a shared instance hasn't been set.

setExecutorService

public void setExecutorService(ScheduledExecutorService executorService)

Sets the backing executor service for the shared instance.

This updates the executor service for all users of the shared instance. Meaning, if another area in code already had a reference to the shared instance, it will now use the passed executor service to execute tasks.

If the executor service is already set, this will replace it with the new executor service. If the replaced executor service was created by this class, it will be shut down.

If the passed executor service is null, this will throw a NullPointerException. If the passed executor service is shutdown or terminated, this will throw an IllegalStateException.

Parameters:

executorService - The executor service to set as the shared instance.

Throws:

NullPointerException - If the passed executor service is null.

IllegalStateException - If the passed executor service is shutdown or terminated.

reset

public void reset()

Resets the state of the getInstance() to an uninitialized state.

This will shut down the executor service if it was created by this class.

shutdown

public void shutdown()

Shutdown isn't supported for this executor service as it is shared by multiple consumers.

Calling this method will result in an UnsupportedOperationException being thrown.

Specified by:

shutdown in interface ExecutorService

Throws:

UnsupportedOperationException - This method will always throw an exception.

shutdownNow

public List<Runnable> shutdownNow()

Shutdown isn't supported for this executor service as it is shared by multiple consumers.

Calling this method will result in an UnsupportedOperationException being thrown.

Specified by:

shutdownNow in interface ExecutorService

Returns:

Nothing will be returned as an exception will always be thrown.

Throws:

UnsupportedOperationException - This method will always throw an exception.

isShutdown

public boolean isShutdown()

Checks if the executor service is shutdown.

Will always return false as the shared executor service cannot be shut down.

Specified by:

isShutdown in interface ExecutorService

Returns:

False, as the shared executor service cannot be shut down.

isTerminated

public boolean isTerminated()

Checks if the executor service is terminated.

Will always return false as the shared executor service cannot be terminated.

Specified by:

isTerminated in interface ExecutorService

Returns:

False, as the shared executor service cannot be terminated.

awaitTermination

public boolean awaitTermination(long timeout,
 TimeUnit unit)

Shutdown isn't supported for this executor service as it is shared by multiple consumers.

Calling this method will result in an UnsupportedOperationException being thrown.

Specified by:

awaitTermination in interface ExecutorService

Parameters:

timeout - The amount of time to wait for the executor service to shutdown.

unit - The unit of time for the timeout.

Returns:

Nothing will be returned as an exception will always be thrown.

Throws:

UnsupportedOperationException - This method will always throw an exception.

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

submit

public <T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

submit

public <T> Future<T> submit(Runnable task,
 T result)

Specified by:

submit in interface ExecutorService

submit

public Future<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAll

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

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                throws InterruptedException,
ExecutionException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

invokeAny

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

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

TimeoutException

schedule

public ScheduledFuture<?> schedule(Runnable command,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

schedule

public <V> ScheduledFuture<V> schedule(Callable<V> callable,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
 long initialDelay,
 long period,
 TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
 long initialDelay,
 long delay,
 TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService