io.reactivex.flowable

Interface FlowableEmitter<T>

Type Parameters:

T - the value type to emit

All Superinterfaces:

io.reactivex.common.Emitter<T>

public interface FlowableEmitter<T>
extends io.reactivex.common.Emitter<T>

Abstraction over a Reactive Streams Subscriber that allows associating a resource with it and exposes the current number of downstream requested amount.

The onNext, onError and onComplete methods should be called in a sequential manner, just like the Subscriber's methods. Use serialize() if you want to ensure this. The other methods are thread-safe.

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Returns true if the downstream cancelled the sequence.
long	requested() The current outstanding request amount.
FlowableEmitter<T>	serialize() Ensures that calls to onNext, onError and onComplete are properly serialized.
void	setCancellable(io.reactivex.common.functions.Cancellable c) Sets a Cancellable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.
void	setDisposable(io.reactivex.common.Disposable s) Sets a Disposable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.

Methods inherited from interface io.reactivex.common.Emitter

onComplete, onError, onNext

Method Detail

setDisposable

void setDisposable(@Nullable
                   io.reactivex.common.Disposable s)

Sets a Disposable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.

Parameters:

s - the disposable, null is allowed

setCancellable

void setCancellable(@Nullable
                    io.reactivex.common.functions.Cancellable c)

Sets a Cancellable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.

Parameters:

c - the cancellable resource, null is allowed

requested

long requested()

The current outstanding request amount.

This method is thread-safe.

Returns:

the current outstanding request amount

isCancelled

boolean isCancelled()

Returns true if the downstream cancelled the sequence.

This method is thread-safe.

Returns:

true if the downstream cancelled the sequence

serialize

@NonNull
FlowableEmitter<T> serialize()

Ensures that calls to onNext, onError and onComplete are properly serialized.

Returns:

the serialized FlowableEmitter