| 1 |
/* |
| 2 |
* Copyright (c) 2016-present, RxJava Contributors. |
| 3 |
* |
| 4 |
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in |
| 5 |
* compliance with the License. You may obtain a copy of the License at |
| 6 |
* |
| 7 |
* http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
* |
| 9 |
* Unless required by applicable law or agreed to in writing, software distributed under the License is |
| 10 |
* distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See |
| 11 |
* the License for the specific language governing permissions and limitations under the License. |
| 12 |
*/ |
| 13 |
|
| 14 |
package io.reactivex.rxjava3.operators; |
| 15 |
|
| 16 |
import io.reactivex.rxjava3.annotations.NonNull; |
| 17 |
import io.reactivex.rxjava3.core.FlowableSubscriber; |
| 18 |
|
| 19 |
/** |
| 20 |
* A {@link FlowableSubscriber} with an additional {@link #tryOnNext(Object)} method that |
| 21 |
* tells the caller the specified value has been accepted or not. |
| 22 |
* |
| 23 |
* <p>This allows certain queue-drain or source-drain operators |
| 24 |
* to avoid requesting 1 on behalf of a dropped value. |
| 25 |
* |
| 26 |
* @param <T> the value type |
| 27 |
* @since 3.1.1 |
| 28 |
*/ |
| 29 |
public interface ConditionalSubscriber<@NonNull T> extends FlowableSubscriber<T> { |
| 30 |
/** |
| 31 |
* Conditionally takes the value. |
| 32 |
* @param t the value to deliver |
| 33 |
* @return true if the value has been accepted, false if the value has been rejected |
| 34 |
* and the next value can be sent immediately |
| 35 |
*/ |
| 36 |
boolean tryOnNext(@NonNull T t); |
| 37 |
} |