All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.reactivex.rxjava3.subjects.CompletableSubject Maven / Gradle / Ivy

Go to download

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2
Show newest version
/*
 * Copyright (c) 2016-present, RxJava Contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
 * the License for the specific language governing permissions and limitations under the License.
 */

package io.reactivex.rxjava3.subjects;

import java.util.concurrent.atomic.*;

import io.reactivex.rxjava3.annotations.*;
import io.reactivex.rxjava3.core.*;
import io.reactivex.rxjava3.disposables.Disposable;
import io.reactivex.rxjava3.internal.util.ExceptionHelper;
import io.reactivex.rxjava3.plugins.RxJavaPlugins;

/**
 * Represents a hot Completable-like source and consumer of events similar to Subjects.
 * 

* *

* This subject does not have a public constructor by design; a new non-terminated instance of this * {@code CompletableSubject} can be created via the {@link #create()} method. *

* Since the {@code CompletableSubject} is conceptionally derived from the {@code Processor} type in the Reactive Streams specification, * {@code null}s are not allowed (Rule 2.13) * as parameters to {@link #onError(Throwable)}. *

* Even though {@code CompletableSubject} implements the {@code CompletableObserver} interface, calling * {@code onSubscribe} is not required (Rule 2.12) * if the subject is used as a standalone source. However, calling {@code onSubscribe} * after the {@code CompletableSubject} reached its terminal state will result in the * given {@code Disposable} being disposed immediately. *

* All methods are thread safe. Calling {@link #onComplete()} multiple * times has no effect. Calling {@link #onError(Throwable)} multiple times relays the {@code Throwable} to * the {@link io.reactivex.rxjava3.plugins.RxJavaPlugins#onError(Throwable)} global error handler. *

* This {@code CompletableSubject} supports the standard state-peeking methods {@link #hasComplete()}, * {@link #hasThrowable()}, {@link #getThrowable()} and {@link #hasObservers()}. *

*
Scheduler:
*
{@code CompletableSubject} does not operate by default on a particular {@link io.reactivex.rxjava3.core.Scheduler} and * the {@code CompletableObserver}s get notified on the thread where the terminating {@code onError} or {@code onComplete} * methods were invoked.
*
Error handling:
*
When the {@link #onError(Throwable)} is called, the {@code CompletableSubject} enters into a terminal state * and emits the same {@code Throwable} instance to the last set of {@code CompletableObserver}s. During this emission, * if one or more {@code CompletableObserver}s dispose their respective {@code Disposable}s, the * {@code Throwable} is delivered to the global error handler via * {@link io.reactivex.rxjava3.plugins.RxJavaPlugins#onError(Throwable)} (multiple times if multiple {@code CompletableObserver}s * cancel at once). * If there were no {@code CompletableObserver}s subscribed to this {@code CompletableSubject} when the {@code onError()} * was called, the global error handler is not invoked. *
*
*

* Example usage: *


 * CompletableSubject subject = CompletableSubject.create();
 *
 * TestObserver<Void> to1 = subject.test();
 *
 * // a fresh CompletableSubject is empty
 * to1.assertEmpty();
 *
 * subject.onComplete();
 *
 * // a CompletableSubject is always void of items
 * to1.assertResult();
 *
 * TestObserver<Void> to2 = subject.test()
 *
 * // late CompletableObservers receive the terminal event
 * to2.assertResult();
 * 
*

History: 2.0.5 - experimental * @since 2.1 */ public final class CompletableSubject extends Completable implements CompletableObserver { final AtomicReference observers; static final CompletableDisposable[] EMPTY = new CompletableDisposable[0]; static final CompletableDisposable[] TERMINATED = new CompletableDisposable[0]; final AtomicBoolean once; Throwable error; /** * Creates a fresh CompletableSubject. * @return the new CompletableSubject instance */ @CheckReturnValue @NonNull public static CompletableSubject create() { return new CompletableSubject(); } CompletableSubject() { once = new AtomicBoolean(); observers = new AtomicReference<>(EMPTY); } @Override public void onSubscribe(Disposable d) { if (observers.get() == TERMINATED) { d.dispose(); } } @Override public void onError(Throwable e) { ExceptionHelper.nullCheck(e, "onError called with a null Throwable."); if (once.compareAndSet(false, true)) { this.error = e; for (CompletableDisposable md : observers.getAndSet(TERMINATED)) { md.downstream.onError(e); } } else { RxJavaPlugins.onError(e); } } @Override public void onComplete() { if (once.compareAndSet(false, true)) { for (CompletableDisposable md : observers.getAndSet(TERMINATED)) { md.downstream.onComplete(); } } } @Override protected void subscribeActual(CompletableObserver observer) { CompletableDisposable md = new CompletableDisposable(observer, this); observer.onSubscribe(md); if (add(md)) { if (md.isDisposed()) { remove(md); } } else { Throwable ex = error; if (ex != null) { observer.onError(ex); } else { observer.onComplete(); } } } boolean add(CompletableDisposable inner) { for (;;) { CompletableDisposable[] a = observers.get(); if (a == TERMINATED) { return false; } int n = a.length; CompletableDisposable[] b = new CompletableDisposable[n + 1]; System.arraycopy(a, 0, b, 0, n); b[n] = inner; if (observers.compareAndSet(a, b)) { return true; } } } void remove(CompletableDisposable inner) { for (;;) { CompletableDisposable[] a = observers.get(); int n = a.length; if (n == 0) { return; } int j = -1; for (int i = 0; i < n; i++) { if (a[i] == inner) { j = i; break; } } if (j < 0) { return; } CompletableDisposable[] b; if (n == 1) { b = EMPTY; } else { b = new CompletableDisposable[n - 1]; System.arraycopy(a, 0, b, 0, j); System.arraycopy(a, j + 1, b, j, n - j - 1); } if (observers.compareAndSet(a, b)) { return; } } } /** * Returns the terminal error if this CompletableSubject has been terminated with an error, null otherwise. * @return the terminal error or null if not terminated or not with an error */ @Nullable public Throwable getThrowable() { if (observers.get() == TERMINATED) { return error; } return null; } /** * Returns true if this CompletableSubject has been terminated with an error. * @return true if this CompletableSubject has been terminated with an error */ public boolean hasThrowable() { return observers.get() == TERMINATED && error != null; } /** * Returns true if this CompletableSubject has been completed. * @return true if this CompletableSubject has been completed */ public boolean hasComplete() { return observers.get() == TERMINATED && error == null; } /** * Returns true if this CompletableSubject has observers. * @return true if this CompletableSubject has observers */ public boolean hasObservers() { return observers.get().length != 0; } /** * Returns the number of current observers. * @return the number of current observers */ /* test */ int observerCount() { return observers.get().length; } static final class CompletableDisposable extends AtomicReference implements Disposable { private static final long serialVersionUID = -7650903191002190468L; final CompletableObserver downstream; CompletableDisposable(CompletableObserver actual, CompletableSubject parent) { this.downstream = actual; lazySet(parent); } @Override public void dispose() { CompletableSubject parent = getAndSet(null); if (parent != null) { parent.remove(this); } } @Override public boolean isDisposed() { return get() == null; } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy