/* * 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.processors; import org.reactivestreams.Processor; import io.reactivex.rxjava3.annotations.*; import io.reactivex.rxjava3.core.*; /** * Represents a Subscriber and a Flowable (Publisher) at the same time, allowing * multicasting events from a single source to multiple child Subscribers. *

All methods except the onSubscribe, onNext, onError and onComplete are thread-safe. * Use {@link #toSerialized()} to make these methods thread-safe as well. * * @param the item value type */ public abstract class FlowableProcessor<@NonNull T> extends Flowable implements Processor, FlowableSubscriber { /** * Returns true if the FlowableProcessor has subscribers. *

The method is thread-safe. * @return true if the FlowableProcessor has subscribers */ @CheckReturnValue public abstract boolean hasSubscribers(); /** * Returns true if the FlowableProcessor has reached a terminal state through an error event. *

The method is thread-safe. * @return true if the FlowableProcessor has reached a terminal state through an error event * @see #getThrowable() * @see #hasComplete() */ @CheckReturnValue public abstract boolean hasThrowable(); /** * Returns true if the FlowableProcessor has reached a terminal state through a complete event. *

The method is thread-safe. * @return true if the FlowableProcessor has reached a terminal state through a complete event * @see #hasThrowable() */ @CheckReturnValue public abstract boolean hasComplete(); /** * Returns the error that caused the FlowableProcessor to terminate or null if the FlowableProcessor * hasn't terminated yet. *

The method is thread-safe. * @return the error that caused the FlowableProcessor to terminate or null if the FlowableProcessor * hasn't terminated yet */ @Nullable @CheckReturnValue public abstract Throwable getThrowable(); /** * Wraps this FlowableProcessor and serializes the calls to the onSubscribe, onNext, onError and * onComplete methods, making them thread-safe. *

The method is thread-safe. * @return the wrapped and serialized FlowableProcessor */ @NonNull @CheckReturnValue public final FlowableProcessor toSerialized() { if (this instanceof SerializedProcessor) { return this; } return new SerializedProcessor<>(this); } }