io.reactivex

Interface CompletableEmitter

public interface CompletableEmitter

Abstraction over an RxJava CompletableObserver that allows associating a resource with it.

All methods are safe to call from multiple threads.

Calling onComplete or onError multiple times has no effect.

Method Summary

Modifier and Type	Method and Description
boolean	isDisposed() Returns true if the downstream disposed the sequence.
void	onComplete() Signal the completion.
void	onError(Throwable t) Signal an exception.
void	setCancellable(Cancellable c) Sets a Cancellable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.
void	setDisposable(Disposable d) Sets a Disposable on this emitter; any previous Disposable or Cancellation will be disposed/cancelled.
boolean	tryOnError(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.

Method Detail

onComplete

void onComplete()

Signal the completion.

onError

void onError(@NonNull
             Throwable t)

Signal an exception.

Parameters:

t - the exception, not null

setDisposable

void setDisposable(@Nullable
                   Disposable d)

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

Parameters:

d - 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

isDisposed

boolean isDisposed()

Returns true if the downstream disposed the sequence.

Returns:

true if the downstream disposed the sequence

tryOnError

boolean tryOnError(@NonNull
                   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 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