Interface CompletableEmitter
-
- All Known Implementing Classes:
CompletableCreate.Emitter
public interface CompletableEmitter
Abstraction over an RxJavaCompletableObserver
that allows associating a resource with it.All methods are safe to call from multiple threads, but note that there is no guarantee whose terminal event will win and get delivered to the downstream.
Calling
onComplete()
multiple times has no effect. CallingonError(Throwable)
multiple times or afteronComplete
will route the exception into the global error handler viaRxJavaPlugins.onError(Throwable)
.The emitter allows the registration of a single resource, in the form of a
Disposable
orCancellable
viasetDisposable(Disposable)
orsetCancellable(Cancellable)
respectively. The emitter implementations will dispose/cancel this instance when the downstream cancels the flow or after the event generator logic callsonError(Throwable)
,onComplete()
or whentryOnError(Throwable)
succeeds.Only one
Disposable
orCancellable
object can be associated with the emitter at a time. Calling eitherset
method will dispose/cancel any previous object. If there is a need for handling multiple resources, one can create aCompositeDisposable
and associate that with the emitter instead.The
Cancellable
is logically equivalent toDisposable
but allows using cleanup logic that can throw a checked exception (such as manyclose()
methods on Java IO components). Since the release of resources happens after the terminal events have been delivered or the sequence gets cancelled, exceptions throw withinCancellable
are routed to the global error handler viaRxJavaPlugins.onError(Throwable)
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
isDisposed()
Returns true if the downstream disposed the sequence or the emitter was terminated viaonError(Throwable)
,onComplete()
or a successfultryOnError(Throwable)
.void
onComplete()
Signal the completion.void
onError(@NonNull java.lang.Throwable t)
Signal an exception.void
setCancellable(@Nullable Cancellable c)
Sets a Cancellable on this emitter; any previousDisposable
orCancellable
will be disposed/cancelled.void
setDisposable(@Nullable Disposable d)
Sets a Disposable on this emitter; any previousDisposable
orCancellable
will be disposed/cancelled.boolean
tryOnError(@NonNull java.lang.Throwable t)
Attempts to emit the specifiedThrowable
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 @NonNull java.lang.Throwable t)
Signal an exception.- Parameters:
t
- the exception, not null
-
setDisposable
void setDisposable(@Nullable @Nullable Disposable d)
Sets a Disposable on this emitter; any previousDisposable
orCancellable
will be disposed/cancelled.- Parameters:
d
- the disposable, null is allowed
-
setCancellable
void setCancellable(@Nullable @Nullable Cancellable c)
Sets a Cancellable on this emitter; any previousDisposable
orCancellable
will be disposed/cancelled.- Parameters:
c
- the cancellable resource, null is allowed
-
isDisposed
boolean isDisposed()
Returns true if the downstream disposed the sequence or the emitter was terminated viaonError(Throwable)
,onComplete()
or a successfultryOnError(Throwable)
.This method is thread-safe.
- Returns:
- true if the downstream disposed the sequence or the emitter was terminated
-
tryOnError
boolean tryOnError(@NonNull @NonNull java.lang.Throwable t)
Attempts to emit the specifiedThrowable
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)
, theRxjavaPlugins.onError
is not called if the error could not be delivered.History: 2.1.1 - experimental
- 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.2
-
-