io.reactivex

Interface FlowableEmitter<T>

Type Parameters:

T - the value type to emit

All Superinterfaces:

Emitter<T>

public interface FlowableEmitter<T>
extends 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(Cancellable c) Sets a Cancellable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.
void	setDisposable(Disposable s) Sets a Disposable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.
boolean	tryOnError(java.lang.Throwable t) Attempts to emit the specified Throwable error if the downstream hasn't cancelled the sequence or is otherwise terminated, returning false if the emission is not allowed to happen due to lifecycle restrictions.

Methods inherited from interface io.reactivex.Emitter

onComplete, onError, onNext

Method Detail

setDisposable

void setDisposable(@Nullable
                   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
                    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

tryOnError

boolean tryOnError(@NonNull
                   java.lang.Throwable t)

Attempts to emit the specified Throwable error if the downstream hasn't cancelled the sequence or is otherwise terminated, returning false if the emission is not allowed to happen due to lifecycle restrictions.

Unlike Emitter.onError(Throwable), the RxJavaPlugins.onError is not called if the error could not be delivered.

Parameters:

t - the throwable error to signal if possible

Returns:

true if successful, false if the downstream is not able to accept further events

Since:

2.1.1 - experimental