rxjava 1.3.8 · rx.Subscriber

Modifier and Type	Field and Description
private static final long	NOT_SET
private Producer	producer
private long	requested
private final Subscriber<?>	subscriber
private final SubscriptionList	subscriptions

Modifier and Type

Field and Description

private static final long

NOT_SET

private Producer

producer

private long

requested

private final Subscriber<?>

subscriber

private final SubscriptionList

subscriptions

Constructor Summary

Access	Constructor and Description
protected	Subscriber()
protected	Subscriber(Subscriber<?> the other Subscriber subscriber) Construct a Subscriber by using another Subscriber for backpressure and for holding the subscription list (when `this.add(sub)` is called this will in fact call `subscriber.add(sub)`).
protected	Subscriber(Subscriber<?> the other Subscriber subscriber, boolean `true` to share the subscription list in `subscriber` with this instance shareSubscriptions) Construct a Subscriber by using another Subscriber for backpressure and optionally for holding the subscription list (if `shareSubscriptions` is `true` then when `this.add(sub)` is called this will in fact call `subscriber.add(sub)`).

Method Summary

Modifier and Type	Method and Description
public final void	add(Subscription the `Subscription` to add s) Adds a `Subscription` to this Subscriber's list of subscriptions if this list is not marked as unsubscribed.
private void	addToRequested(long n)
public final boolean	Returns: `true` if this Subscriber has unsubscribed from its subscriptions, `false` otherwise isUnsubscribed() Implements rx.Subscription.isUnsubscribed. Indicates whether this Subscriber has unsubscribed from its list of subscriptions.
public void	onStart() This method is invoked when the Subscriber and Observable have been connected but the Observable has not yet begun to emit items or send notifications to the Subscriber.
protected final void	request(long the maximum number of items you want the Observable to emit to the Subscriber at this time, or `Long.MAX_VALUE` if you want the Observable to emit items at its own pace n) Request a certain maximum number of emitted items from the Observable this Subscriber is subscribed to.
public void	setProducer(Producer producer to be used by this subscriber or the other subscriber (or recursively its other subscriber) to make requests from p) If other subscriber is set (by calling constructor `Subscriber(Subscriber)` or `Subscriber(Subscriber, boolean)`) then this method calls `setProducer` on the other subscriber.
public final void	unsubscribe() Implements rx.Subscription.unsubscribe. Stops the receipt of notifications on the `Subscriber` that was registered when this Subscription was received.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

NOT_SET	back to summary
private static final long NOT_SET

producer	back to summary
private Producer producer

requested	back to summary
private long requested

subscriber	back to summary
private final Subscriber<?> subscriber

subscriptions	back to summary
private final SubscriptionList subscriptions

Constructor Detail

Subscriber	back to summary
protected Subscriber()

Subscriber back to summary

Subscriber	back to summary
protected Subscriber(Subscriber<?> subscriber) Construct a Subscriber by using another Subscriber for backpressure and for holding the subscription list (when `this.add(sub)` is called this will in fact call `subscriber.add(sub)`). Parameters subscriber:Subscriber<?> the other Subscriber

protected Subscriber(Subscriber<?> subscriber)

Construct a Subscriber by using another Subscriber for backpressure and for holding the subscription list (when this.add(sub) is called this will in fact call subscriber.add(sub)).

Parameters

subscriber:Subscriber<?>: the other Subscriber

Subscriber back to summary

Subscriber	back to summary
protected Subscriber(Subscriber<?> subscriber, boolean shareSubscriptions) Construct a Subscriber by using another Subscriber for backpressure and optionally for holding the subscription list (if `shareSubscriptions` is `true` then when `this.add(sub)` is called this will in fact call `subscriber.add(sub)`). To retain the chaining of subscribers when setting `shareSubscriptions` to `false`, add the created instance to `subscriber` via `add`. Parameters subscriber:Subscriber<?> the other Subscriber shareSubscriptions:boolean `true` to share the subscription list in `subscriber` with this instance Since 1.0.6

protected Subscriber(Subscriber<?> subscriber, boolean shareSubscriptions)

Construct a Subscriber by using another Subscriber for backpressure and optionally for holding the subscription list (if shareSubscriptions is true then when this.add(sub) is called this will in fact call subscriber.add(sub)).

To retain the chaining of subscribers when setting shareSubscriptions to false, add the created instance to subscriber via add.

Parameters

subscriber:Subscriber<?>: the other Subscriber
shareSubscriptions:boolean: true to share the subscription list in subscriber with this instance

Since

1.0.6

Method Detail

add back to summary

add	back to summary
public final void add(Subscription s) Adds a `Subscription` to this Subscriber's list of subscriptions if this list is not marked as unsubscribed. If the list is marked as unsubscribed, `add` will indicate this by explicitly unsubscribing the new `Subscription` as well. Parameters s:Subscription the `Subscription` to add

public final void add(Subscription s)

Adds a Subscription to this Subscriber's list of subscriptions if this list is not marked as unsubscribed. If the list is marked as unsubscribed, add will indicate this by explicitly unsubscribing the new Subscription as well.

Parameters

s:Subscription: the Subscription to add

addToRequested	back to summary
private void addToRequested(long n)

isUnsubscribed back to summary

isUnsubscribed	back to summary
public final boolean isUnsubscribed() Implements rx.Subscription.isUnsubscribed. Indicates whether this Subscriber has unsubscribed from its list of subscriptions. Returns:boolean `true` if this Subscriber has unsubscribed from its subscriptions, `false` otherwise Annotations @Override

public final boolean isUnsubscribed()

Implements rx.Subscription.isUnsubscribed.

Indicates whether this Subscriber has unsubscribed from its list of subscriptions.

Returns:boolean

true if this Subscriber has unsubscribed from its subscriptions, false otherwise

Annotations

@Override

onStart	back to summary
public void onStart() This method is invoked when the Subscriber and Observable have been connected but the Observable has not yet begun to emit items or send notifications to the Subscriber. Override this method to add any useful initialization to your subscription, for instance to initiate backpressure.

request back to summary

request	back to summary
protected final void request(long n) Request a certain maximum number of emitted items from the Observable this Subscriber is subscribed to. This is a way of requesting backpressure. To disable backpressure, pass `Long.MAX_VALUE` to this method. Requests are additive but if a sequence of requests totals more than `Long.MAX_VALUE` then `Long.MAX_VALUE` requests will be actioned and the extras may be ignored. Arriving at `Long.MAX_VALUE` by addition of requests cannot be assumed to disable backpressure. For example, the code below may result in `Long.MAX_VALUE` requests being actioned only. request(100); request(Long.MAX_VALUE-1); Parameters n:long the maximum number of items you want the Observable to emit to the Subscriber at this time, or `Long.MAX_VALUE` if you want the Observable to emit items at its own pace Exceptions IllegalArgumentException: if `n` is negative

protected final void request(long n)

Request a certain maximum number of emitted items from the Observable this Subscriber is subscribed to. This is a way of requesting backpressure. To disable backpressure, pass Long.MAX_VALUE to this method.

Requests are additive but if a sequence of requests totals more than Long.MAX_VALUE then Long.MAX_VALUE requests will be actioned and the extras may be ignored. Arriving at Long.MAX_VALUE by addition of requests cannot be assumed to disable backpressure. For example, the code below may result in Long.MAX_VALUE requests being actioned only.

request(100);
request(Long.MAX_VALUE-1);

Parameters

n:long: the maximum number of items you want the Observable to emit to the Subscriber at this time, or Long.MAX_VALUE if you want the Observable to emit items at its own pace

Exceptions

IllegalArgumentException:: if n is negative

setProducer back to summary

setProducer	back to summary
public void setProducer(Producer p) If other subscriber is set (by calling constructor `Subscriber(Subscriber)` or `Subscriber(Subscriber, boolean)`) then this method calls `setProducer` on the other subscriber. If the other subscriber is not set and no requests have been made to this subscriber then `p.request(Long.MAX_VALUE)` is called. If the other subscriber is not set and some requests have been made to this subscriber then `p.request(n)` is called where n is the accumulated requests to this subscriber. Parameters p:Producer producer to be used by this subscriber or the other subscriber (or recursively its other subscriber) to make requests from

public void setProducer(Producer p)

If other subscriber is set (by calling constructor Subscriber(Subscriber) or Subscriber(Subscriber, boolean)) then this method calls setProducer on the other subscriber. If the other subscriber is not set and no requests have been made to this subscriber then p.request(Long.MAX_VALUE) is called. If the other subscriber is not set and some requests have been made to this subscriber then p.request(n) is called where n is the accumulated requests to this subscriber.

Parameters

p:Producer: producer to be used by this subscriber or the other subscriber (or recursively its other subscriber) to make requests from

unsubscribe back to summary

unsubscribe	back to summary
public final void unsubscribe() Implements rx.Subscription.unsubscribe. Doc from rx.Subscription.unsubscribe. Stops the receipt of notifications on the `Subscriber` that was registered when this Subscription was received. This allows deregistering an `Subscriber` before it has finished receiving all events (i.e. before onCompleted is called). Annotations @Override

public final void unsubscribe()

Implements rx.Subscription.unsubscribe.

Doc from rx.Subscription.unsubscribe.

Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

This allows deregistering an Subscriber before it has finished receiving all events (i.e. before onCompleted is called).

Annotations

@Override

public abstract Class Subscriber<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail