Package rx.observers

Class SerializedObserver<T>

java.lang.Object

rx.observers.SerializedObserver<T>

Type Parameters:

T - the type of items expected to be observed by the Observer

All Implemented Interfaces:

Observer<T>

public class SerializedObserver<T>
extends Object
implements Observer<T>

Enforces single-threaded, serialized, ordered execution of onNext(T), onCompleted(), and onError(java.lang.Throwable).

When multiple threads are emitting and/or notifying they will be serialized by:

• Allowing only one thread at a time to emit
• Adding notifications to a queue if another thread is already emitting
• Not holding any locks or blocking any threads while emitting

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	SerializedObserver.FastList

Field Summary

Fields

Modifier and Type	Field	Description
private final Observer<? super T>	actual
private boolean	emitting
private final NotificationLite<T>	nl
private SerializedObserver.FastList	queue	If not null, it indicates more work.
private boolean	terminated	Set to true if a terminal event was received.

Constructor Summary

Constructors

Constructor	Description
SerializedObserver(Observer<? super T> s)

Method Summary

Modifier and Type	Method	Description
void	onCompleted()	Notifies the Observer that the Observable has finished sending push-based notifications.
void	onError(Throwable e)	Notifies the Observer that the Observable has experienced an error condition.
void	onNext(T t)	Provides the Observer with a new item to observe.

Methods inherited from class java.lang.Object

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

Field Details

actual

private final Observer<? super T> actual

emitting

private boolean emitting

terminated

private volatile boolean terminated

Set to true if a terminal event was received.

queue

private SerializedObserver.FastList queue

If not null, it indicates more work.

nl

private final NotificationLite<T> nl

Constructor Details

SerializedObserver

public SerializedObserver(Observer<? super T> s)

Method Details

onNext

public void onNext(T t)

Description copied from interface: Observer

Provides the Observer with a new item to observe.

The Observable may call this method 0 or more times.

The Observable will not call this method again after it calls either Observer.onCompleted() or Observer.onError(java.lang.Throwable).

Specified by:

onNext in interface Observer<T>

Parameters:

t - the item emitted by the Observable

onError

public void onError(Throwable e)

Description copied from interface: Observer

Notifies the Observer that the Observable has experienced an error condition.

If the Observable calls this method, it will not thereafter call Observer.onNext(T) or Observer.onCompleted().

Specified by:

onError in interface Observer<T>

Parameters:

e - the exception encountered by the Observable

onCompleted

public void onCompleted()

Description copied from interface: Observer

Notifies the Observer that the Observable has finished sending push-based notifications.

The Observable will not call this method if it calls Observer.onError(java.lang.Throwable).

Specified by:

onCompleted in interface Observer<T>