Package rx.observables

Class AsyncOnSubscribe.AsyncOnSubscribeImpl<S,T>

java.lang.Object

rx.observables.AsyncOnSubscribe<S,T>

rx.observables.AsyncOnSubscribe.AsyncOnSubscribeImpl<S,T>

Type Parameters:

S - the type of the user-defined state

T - the type of compatible Subscribers

All Implemented Interfaces:

Action, Action1<Subscriber<? super T>>, Function, Observable.OnSubscribe<T>

Enclosing class:

AsyncOnSubscribe<S,T>

static final class AsyncOnSubscribe.AsyncOnSubscribeImpl<S,T>
extends AsyncOnSubscribe<S,T>

An implementation of AsyncOnSubscribe that delegates AsyncOnSubscribe.next(Object, long, Observer), AsyncOnSubscribe.generateState(), and AsyncOnSubscribe.onUnsubscribe(Object) to provided functions/closures.

Nested Class Summary

Nested classes/interfaces inherited from class rx.observables.AsyncOnSubscribe

AsyncOnSubscribe.AsyncOnSubscribeImpl<S,T>, AsyncOnSubscribe.AsyncOuterManager<S,T>, AsyncOnSubscribe.UnicastSubject<T>

Field Summary

Fields

Modifier and Type	Field	Description
private Func0<? extends S>	generator
private Func3<? super S,java.lang.Long,? super Observer<Observable<? extends T>>,? extends S>	next
private Action1<? super S>	onUnsubscribe

Constructor Summary

Constructors

Constructor	Description
AsyncOnSubscribeImpl(Func0<? extends S> generator, Func3<? super S,java.lang.Long,? super Observer<Observable<? extends T>>,? extends S> next)
AsyncOnSubscribeImpl(Func0<? extends S> generator, Func3<? super S,java.lang.Long,? super Observer<Observable<? extends T>>,? extends S> next, Action1<? super S> onUnsubscribe)
AsyncOnSubscribeImpl(Func3<S,java.lang.Long,Observer<Observable<? extends T>>,S> nextFunc)
AsyncOnSubscribeImpl(Func3<S,java.lang.Long,Observer<Observable<? extends T>>,S> next, Action1<? super S> onUnsubscribe)

Method Summary

Modifier and Type	Method	Description
protected S	generateState()	Executed once when subscribed to by a subscriber (via AsyncOnSubscribe.call(Subscriber)) to produce a state value.
protected S	next(S state, long requested, Observer<Observable<? extends T>> observer)	Called to produce data to the downstream subscribers.
protected void	onUnsubscribe(S state)	Clean up behavior that is executed after the downstream subscriber's subscription is unsubscribed.

Methods inherited from class rx.observables.AsyncOnSubscribe

call, createSingleState, createSingleState, createStateful, createStateful, createStateless, createStateless

Methods inherited from class java.lang.Object

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

Field Detail

generator

private final Func0<? extends S> generator

next

private final Func3<? super S,java.lang.Long,? super Observer<Observable<? extends T>>,? extends S> next

onUnsubscribe

private final Action1<? super S> onUnsubscribe

Constructor Detail

AsyncOnSubscribeImpl

AsyncOnSubscribeImpl(Func0<? extends S> generator,
                     Func3<? super S,java.lang.Long,? super Observer<Observable<? extends T>>,? extends S> next,
                     Action1<? super S> onUnsubscribe)

AsyncOnSubscribeImpl

public AsyncOnSubscribeImpl(Func0<? extends S> generator,
                            Func3<? super S,java.lang.Long,? super Observer<Observable<? extends T>>,? extends S> next)

AsyncOnSubscribeImpl

public AsyncOnSubscribeImpl(Func3<S,java.lang.Long,Observer<Observable<? extends T>>,S> next,
                            Action1<? super S> onUnsubscribe)

AsyncOnSubscribeImpl

public AsyncOnSubscribeImpl(Func3<S,java.lang.Long,Observer<Observable<? extends T>>,S> nextFunc)

Method Detail

generateState

protected S generateState()

Description copied from class: AsyncOnSubscribe

Executed once when subscribed to by a subscriber (via AsyncOnSubscribe.call(Subscriber)) to produce a state value. This value is passed into next(S state, Observer observer) on the first iteration. Subsequent iterations of next will receive the state returned by the previous invocation of next.

Specified by:

generateState in class AsyncOnSubscribe<S,T>

Returns:

the initial state value

next

protected S next(S state,
                 long requested,
                 Observer<Observable<? extends T>> observer)

Description copied from class: AsyncOnSubscribe

Called to produce data to the downstream subscribers. To emit data to a downstream subscriber call observer.onNext(t). To signal an error condition call observer.onError(throwable) or throw an Exception. To signal the end of a data stream call observer.onCompleted(). Implementations of this method must follow the following rules.

• Must not call observer.onNext(t) more than 1 time per invocation.
• Must not call observer.onNext(t) concurrently.

The value returned from an invocation of this method will be passed in as the state argument of the next invocation of this method.

Specified by:

next in class AsyncOnSubscribe<S,T>

Parameters:

state - the state value (from AsyncOnSubscribe.generateState() on the first invocation or the previous invocation of this method.

requested - the amount of data requested. An observable emitted to the observer should not exceed this amount.

observer - the observer of data emitted by

Returns:

the next iteration's state value

onUnsubscribe

protected void onUnsubscribe(S state)

Description copied from class: AsyncOnSubscribe

Clean up behavior that is executed after the downstream subscriber's subscription is unsubscribed. This method will be invoked exactly once.

Overrides:

onUnsubscribe in class AsyncOnSubscribe<S,T>

Parameters:

state - the last state value returned from next(S, Long, Observer) or generateState() at the time when a terminal event is emitted from AsyncOnSubscribe.next(Object, long, Observer) or unsubscribing.