Modifier and Type	Class and Description
pack-priv static class	SingleScheduler.ScheduledWorker

Modifier and Type	Field and Description
pack-priv final AtomicReference<ScheduledExecutorService>	executor
private static final String	KEY_SINGLE_PRIORITY The name of the system property for setting the thread priority for this Scheduler.
pack-priv static final ScheduledExecutorService	SHUTDOWN
pack-priv static final RxThreadFactory	SINGLE_THREAD_FACTORY
private static final String	THREAD_NAME_PREFIX
pack-priv final ThreadFactory	threadFactory

Access	Constructor and Description
public	SingleScheduler()
public	SingleScheduler(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. threadFactory) Constructs a SingleScheduler with the given ThreadFactory and prepares the single scheduler thread.

Method Summary

Modifier and Type	Method and Description
pack-priv static ScheduledExecutorService	createExecutor(ThreadFactory threadFactory)
public Scheduler.Worker	createWorker() Implements abstract io.reactivex.Scheduler.createWorker. Retrieves or creates a new `Scheduler.Worker` that represents sequential execution of actions.
public Disposable	scheduleDirect(Runnable the task to schedule run, long the delay amount, non-positive values indicate non-delayed scheduling delay, TimeUnit the unit of measure of the delay amount unit) Overrides io.reactivex.Scheduler.scheduleDirect. Schedules the execution of the given task with the given time delay.
public Disposable	schedulePeriodicallyDirect(Runnable the task to schedule run, long the initial delay amount, non-positive values indicate non-delayed scheduling initialDelay, long the period at which the task should be re-executed period, TimeUnit the unit of measure of the delay amount unit) Overrides io.reactivex.Scheduler.schedulePeriodicallyDirect. Schedules a periodic execution of the given task with the given initial time delay and repeat period.
public void	shutdown() Overrides io.reactivex.Scheduler.shutdown. Instructs the Scheduler instance to stop threads, stop accepting tasks on any outstanding `Worker` instances and clean up any associated resources with this Scheduler.
public void	start() Overrides io.reactivex.Scheduler.start. Allows the Scheduler instance to start threads and accept tasks on them.

Inherited from io.reactivex.Scheduler:: clockDriftTolerance now scheduleDirect when

Field Detail

executor	back to summary
pack-priv final AtomicReference<ScheduledExecutorService> executor

KEY_SINGLE_PRIORITY	back to summary
private static final String KEY_SINGLE_PRIORITY The name of the system property for setting the thread priority for this Scheduler.

SHUTDOWN	back to summary
pack-priv static final ScheduledExecutorService SHUTDOWN

SINGLE_THREAD_FACTORY	back to summary
pack-priv static final RxThreadFactory SINGLE_THREAD_FACTORY

THREAD_NAME_PREFIX	back to summary
private static final String THREAD_NAME_PREFIX

threadFactory	back to summary
pack-priv final ThreadFactory threadFactory

Constructor Detail

SingleScheduler	back to summary
public SingleScheduler()

SingleScheduler	back to summary
public SingleScheduler(ThreadFactory threadFactory) Constructs a SingleScheduler with the given ThreadFactory and prepares the single scheduler thread. Parameters threadFactory: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.

SingleScheduler

back to summary

public SingleScheduler(ThreadFactory threadFactory)

Constructs a SingleScheduler with the given ThreadFactory and prepares the single scheduler thread.

Parameters

threadFactory: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 Detail

createExecutor	back to summary
pack-priv static ScheduledExecutorService createExecutor(ThreadFactory threadFactory)

createWorker back to summary

createWorker	back to summary
public Scheduler.Worker createWorker() Implements abstract io.reactivex.Scheduler.createWorker. Doc from io.reactivex.Scheduler.createWorker. 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 `Scheduler.Worker#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. Returns:Scheduler.Worker a Worker representing a serial queue of actions to be executed Annotations @NonNull @Override

public Scheduler.Worker createWorker()

Implements abstract io.reactivex.Scheduler.createWorker.

Doc from io.reactivex.Scheduler.createWorker.

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 Scheduler.Worker#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.

Returns:Scheduler.Worker

a Worker representing a serial queue of actions to be executed

Annotations

@NonNull
@Override

scheduleDirect	back to summary
public Disposable scheduleDirect(Runnable run, long delay, TimeUnit unit) Overrides io.reactivex.Scheduler.scheduleDirect. Doc from io.reactivex.Scheduler.scheduleDirect. Schedules the execution of the given task with the given time delay. This method is safe to be called from multiple threads but there are no ordering guarantees between tasks. Parameters run:Runnable the task to schedule delay:long the delay amount, non-positive values indicate non-delayed scheduling unit:TimeUnit the unit of measure of the delay amount Returns:Disposable the Disposable that let's one cancel this particular delayed task. Annotations @NonNull @Override

scheduleDirect

back to summary

public Disposable scheduleDirect(Runnable run, long delay, TimeUnit unit)

Overrides io.reactivex.Scheduler.scheduleDirect.

Doc from io.reactivex.Scheduler.scheduleDirect.

Schedules the execution of the given task with the given time delay.

This method is safe to be called from multiple threads but there are no ordering guarantees between tasks.

Parameters

run:Runnable: the task to schedule
delay:long: the delay amount, non-positive values indicate non-delayed scheduling
unit:TimeUnit: the unit of measure of the delay amount

Returns:Disposable

the Disposable that let's one cancel this particular delayed task.

Annotations

@NonNull
@Override

schedulePeriodicallyDirect back to summary

schedulePeriodicallyDirect	back to summary
public Disposable schedulePeriodicallyDirect(Runnable run, long initialDelay, long period, TimeUnit unit) Overrides io.reactivex.Scheduler.schedulePeriodicallyDirect. Doc from io.reactivex.Scheduler.schedulePeriodicallyDirect. Schedules a periodic execution of the given task with the given initial time delay and repeat period. This method is safe to be called from multiple threads but there are no ordering guarantees between tasks. The periodic execution is at a fixed rate, that is, the first execution will be after the `initialDelay`, the second after `initialDelay + period`, the third after `initialDelay + 2 * period`, and so on. Parameters run:Runnable the task to schedule initialDelay:long the initial delay amount, non-positive values indicate non-delayed scheduling period:long the period at which the task should be re-executed unit:TimeUnit the unit of measure of the delay amount Returns:Disposable the Disposable that let's one cancel this particular delayed task. Annotations @NonNull @Override

public Disposable schedulePeriodicallyDirect(Runnable run, long initialDelay, long period, TimeUnit unit)

Overrides io.reactivex.Scheduler.schedulePeriodicallyDirect.

Doc from io.reactivex.Scheduler.schedulePeriodicallyDirect.

Schedules a periodic execution of the given task with the given initial time delay and repeat period.

This method is safe to be called from multiple threads but there are no ordering guarantees between tasks.

The periodic execution is at a fixed rate, that is, the first execution will be after the initialDelay, the second after initialDelay + period, the third after initialDelay + 2 * period, and so on.

Parameters

run:Runnable: the task to schedule
initialDelay:long: the initial delay amount, non-positive values indicate non-delayed scheduling
period:long: the period at which the task should be re-executed
unit:TimeUnit: the unit of measure of the delay amount

Returns:Disposable

the Disposable that let's one cancel this particular delayed task.

Annotations

@NonNull
@Override

shutdown back to summary

shutdown	back to summary
public void shutdown() Overrides io.reactivex.Scheduler.shutdown. Doc from io.reactivex.Scheduler.shutdown. Instructs the Scheduler instance to stop threads, stop accepting tasks on any outstanding `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. Annotations @Override

public void shutdown()

Overrides io.reactivex.Scheduler.shutdown.

Doc from io.reactivex.Scheduler.shutdown.

Instructs the Scheduler instance to stop threads, stop accepting tasks on any outstanding 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.

Annotations

@Override

start back to summary

start	back to summary
public void start() Overrides io.reactivex.Scheduler.start. Doc from io.reactivex.Scheduler.start. 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. Annotations @Override

public void start()

Overrides io.reactivex.Scheduler.start.

Doc from io.reactivex.Scheduler.start.

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.

Annotations

@Override

io.reactivex.internal.schedulers back to summary

pack-priv final Class SingleScheduler.ScheduledWorker

Class Inheritance

extends Worker

java.lang.Object
io.reactivex.Scheduler.Worker
io.reactivex.internal.schedulers.SingleScheduler.ScheduledWorker

Field Summary

Modifier and Type	Field and Description
pack-priv volatile boolean	disposed
pack-priv final ScheduledExecutorService	executor
pack-priv final CompositeDisposable	tasks

Constructor Summary

Access	Constructor and Description
pack-priv	ScheduledWorker(ScheduledExecutorService executor)

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements io.reactivex.disposables.Disposable.dispose. Dispose the resource, the operation should be idempotent.
public boolean	isDisposed() Implements io.reactivex.disposables.Disposable.isDisposed. Returns true if this resource has been disposed.
public Disposable	schedule(Runnable the Runnable to schedule run, long time to "wait" before executing the action; non-positive values indicate an non-delayed schedule delay, TimeUnit the time unit of `delayTime` unit) Implements abstract io.reactivex.Scheduler.Worker.schedule. Schedules an Runnable for execution at some point in the future specified by a time delay relative to the current time.

Inherited from io.reactivex.Scheduler.Worker:: now schedule schedulePeriodically

Field Detail

disposed	back to summary
pack-priv volatile boolean disposed

executor	back to summary
pack-priv final ScheduledExecutorService executor

tasks	back to summary
pack-priv final CompositeDisposable tasks

Constructor Detail

ScheduledWorker	back to summary
pack-priv ScheduledWorker(ScheduledExecutorService executor)

Method Detail

dispose	back to summary
public void dispose() Implements io.reactivex.disposables.Disposable.dispose. Doc from io.reactivex.disposables.Disposable.dispose. Dispose the resource, the operation should be idempotent. Annotations @Override

dispose

back to summary

public void dispose()

Implements io.reactivex.disposables.Disposable.dispose.

Doc from io.reactivex.disposables.Disposable.dispose.

Dispose the resource, the operation should be idempotent.

Annotations

@Override

isDisposed	back to summary
public boolean isDisposed() Implements io.reactivex.disposables.Disposable.isDisposed. Doc from io.reactivex.disposables.Disposable.isDisposed. Returns true if this resource has been disposed. Returns:boolean true if this resource has been disposed Annotations @Override

isDisposed

back to summary

public boolean isDisposed()

Implements io.reactivex.disposables.Disposable.isDisposed.

Doc from io.reactivex.disposables.Disposable.isDisposed.

Returns true if this resource has been disposed.

Returns:boolean

true if this resource has been disposed

Annotations

@Override

schedule back to summary

schedule	back to summary
public Disposable schedule(Runnable run, long delay, TimeUnit unit) Implements abstract io.reactivex.Scheduler.Worker.schedule. Doc from io.reactivex.Scheduler.Worker.schedule. Schedules an Runnable for execution at some point in the future specified by a time delay relative to the current time. Note to implementors: non-positive `delayTime` should be regarded as non-delayed schedule, i.e., as if the `schedule(Runnable)` was called. Parameters run:Runnable the Runnable to schedule delay:long time to "wait" before executing the action; non-positive values indicate an non-delayed schedule unit:TimeUnit the time unit of `delayTime` Returns:Disposable a Disposable to be able to unsubscribe the action (cancel it if not executed) Annotations @NonNull @Override

public Disposable schedule(Runnable run, long delay, TimeUnit unit)

Implements abstract io.reactivex.Scheduler.Worker.schedule.

Doc from io.reactivex.Scheduler.Worker.schedule.

Schedules an Runnable for execution at some point in the future specified by a time delay relative to the current time.

Note to implementors: non-positive delayTime should be regarded as non-delayed schedule, i.e., as if the schedule(Runnable) was called.

Parameters

run:Runnable: the Runnable to schedule
delay:long: time to "wait" before executing the action; non-positive values indicate an non-delayed schedule
unit:TimeUnit: the time unit of delayTime

Returns:Disposable

a Disposable to be able to unsubscribe the action (cancel it if not executed)

Annotations

@NonNull
@Override

public final Class SingleScheduler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class SingleScheduler.ScheduledWorker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail