rx

Class Scheduler

java.lang.Object

rx.Scheduler

Direct Known Subclasses:

ImmediateScheduler, NewThreadScheduler, TestScheduler, TrampolineScheduler

public abstract class Scheduler
extends java.lang.Object

Represents an object that schedules units of work.

Common implementations can be found in Schedulers.

Why is this an abstract class instead of an interface?

1. Java doesn't support extension methods and there are many overload methods needing default implementations.
2. Virtual extension methods aren't available until Java8 which RxJava will not set as a minimum target for a long time.
3. If only an interface were used Scheduler implementations would then need to extend from an AbstractScheduler pair that gives all of the functionality unless they intend on copy/pasting the functionality.
4. Without virtual extension methods even additive changes are breaking and thus severely impede library maintenance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scheduler.Worker Sequential Scheduler for executing actions on a single thread or event loop.

Constructor Summary

Constructors

Constructor and Description
Scheduler()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Scheduler.Worker	createWorker() Retrieves or creates a new Scheduler.Worker that represents serial execution of actions.
long	now() Gets the current time, in milliseconds, according to this Scheduler.
int	parallelism() Indicates the parallelism available to this Scheduler.

Methods inherited from class java.lang.Object

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

Constructor Detail

Scheduler

public Scheduler()

Method Detail

createWorker

public abstract Scheduler.Worker createWorker()

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

When work is completed it should be unsubscribed using Subscription.unsubscribe().

Work on a Scheduler.Worker is guaranteed to be sequential.

Returns:

a Worker representing a serial queue of actions to be executed

parallelism

public int parallelism()

Indicates the parallelism available to this Scheduler.

This defaults to Runtime.getRuntime().availableProcessors() but can be overridden for use cases such as scheduling work on a computer cluster.

Returns:

the scheduler's available degree of parallelism

now

public long now()

Gets the current time, in milliseconds, according to this Scheduler.

Returns:

the scheduler's notion of current absolute time in milliseconds