Class IoScheduler

java.lang.Object

io.reactivex.rxjava3.core.Scheduler

io.reactivex.rxjava3.internal.schedulers.IoScheduler

public final class IoScheduler
extends Scheduler

Scheduler that creates and caches a set of thread pools and reuses them if possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	IoScheduler.CachedWorkerPool
(package private) static final class	IoScheduler.EventLoopWorker
(package private) static final class	IoScheduler.ThreadWorker

Nested classes/interfaces inherited from class Scheduler

Scheduler.Worker

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final RxThreadFactory	EVICTOR_THREAD_FACTORY
private static final String	EVICTOR_THREAD_NAME_PREFIX
private static final long	KEEP_ALIVE_TIME
static final long	KEEP_ALIVE_TIME_DEFAULT
private static final TimeUnit	KEEP_ALIVE_UNIT
private static final String	KEY_IO_PRIORITY	The name of the system property for setting the thread priority for this Scheduler.
private static final String	KEY_KEEP_ALIVE_TIME	The name of the system property for setting the keep-alive time (in seconds) for this Scheduler workers.
private static final String	KEY_SCHEDULED_RELEASE	The name of the system property for setting the release behaviour for this Scheduler.
(package private) static final IoScheduler.CachedWorkerPool	NONE
(package private) final AtomicReference<IoScheduler.CachedWorkerPool>	pool
(package private) static final IoScheduler.ThreadWorker	SHUTDOWN_THREAD_WORKER
(package private) final ThreadFactory	threadFactory
(package private) static boolean	USE_SCHEDULED_RELEASE
(package private) static final RxThreadFactory	WORKER_THREAD_FACTORY
private static final String	WORKER_THREAD_NAME_PREFIX

Constructor Summary

Constructors

Constructor	Description
IoScheduler()
IoScheduler(ThreadFactory threadFactory)	Constructs an IoScheduler with the given thread factory and starts the pool of workers.

Method Summary

Modifier and Type	Method	Description
@NonNull Scheduler.Worker	createWorker()	Retrieves or creates a new Scheduler.Worker that represents sequential execution of actions.
void	shutdown()	Instructs the Scheduler instance to stop threads, stop accepting tasks on any outstanding Scheduler.Worker instances and clean up any associated resources with this Scheduler.
int	size()
void	start()	Allows the Scheduler instance to start threads and accept tasks on them.

Methods inherited from class Scheduler

clockDriftTolerance, now, scheduleDirect, scheduleDirect, schedulePeriodicallyDirect, when

Methods inherited from class Object

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

Field Details

WORKER_THREAD_NAME_PREFIX

private static final String WORKER_THREAD_NAME_PREFIX

See Also:

• Constant Field Values

WORKER_THREAD_FACTORY

static final RxThreadFactory WORKER_THREAD_FACTORY

EVICTOR_THREAD_NAME_PREFIX

private static final String EVICTOR_THREAD_NAME_PREFIX

See Also:

• Constant Field Values

EVICTOR_THREAD_FACTORY

static final RxThreadFactory EVICTOR_THREAD_FACTORY

KEY_KEEP_ALIVE_TIME

private static final String KEY_KEEP_ALIVE_TIME

The name of the system property for setting the keep-alive time (in seconds) for this Scheduler workers.

See Also:

• Constant Field Values

KEEP_ALIVE_TIME_DEFAULT

public static final long KEEP_ALIVE_TIME_DEFAULT

See Also:

• Constant Field Values

KEEP_ALIVE_TIME

private static final long KEEP_ALIVE_TIME

KEEP_ALIVE_UNIT

private static final TimeUnit KEEP_ALIVE_UNIT

SHUTDOWN_THREAD_WORKER

static final IoScheduler.ThreadWorker SHUTDOWN_THREAD_WORKER

threadFactory

final ThreadFactory threadFactory

pool

final AtomicReference<IoScheduler.CachedWorkerPool> pool

KEY_IO_PRIORITY

private static final String KEY_IO_PRIORITY

The name of the system property for setting the thread priority for this Scheduler.

See Also:

• Constant Field Values

KEY_SCHEDULED_RELEASE

private static final String KEY_SCHEDULED_RELEASE

The name of the system property for setting the release behaviour for this Scheduler.

See Also:

• Constant Field Values

USE_SCHEDULED_RELEASE

static boolean USE_SCHEDULED_RELEASE

NONE

static final IoScheduler.CachedWorkerPool NONE

Constructor Details

IoScheduler

public IoScheduler()

IoScheduler

public IoScheduler(ThreadFactory threadFactory)

Constructs an IoScheduler with the given thread factory and starts the pool of workers.

Parameters:

threadFactory - thread factory to use for creating worker threads. Note that this takes precedence over any system properties for configuring new thread creation. Cannot be null.

Method Details

start

public void start()

Description copied from class: Scheduler

Allows the Scheduler instance to start threads and accept tasks on them.

Implementations should make sure the call is idempotent, thread-safe and should not throw any RuntimeException if it doesn't support this functionality.

Overrides:

start in class Scheduler

shutdown

public void shutdown()

Description copied from class: Scheduler

Instructs the Scheduler instance to stop threads, stop accepting tasks on any outstanding Scheduler.Worker instances and clean up any associated resources with this Scheduler.

Implementations should make sure the call is idempotent, thread-safe and should not throw any RuntimeException if it doesn't support this functionality.

Overrides:

shutdown in class Scheduler

createWorker

@NonNull
public @NonNull Scheduler.Worker createWorker()

Description copied from class: Scheduler

Retrieves or creates a new Scheduler.Worker that represents sequential execution of actions.

When work is completed, the Worker instance should be released by calling Disposable.dispose() to avoid potential resource leaks in the underlying task-execution scheme.

Work on a Scheduler.Worker is guaranteed to be sequential and non-overlapping.

Specified by:

createWorker in class Scheduler

Returns:

a Worker representing a serial queue of actions to be executed

size

public int size()