io.r2dbc.postgresql.util.Operators Maven / Gradle / Ivy
/*
* Copyright 2019 the original author or authors.
*
* 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
*
* https://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.r2dbc.postgresql.util;
import org.reactivestreams.Subscription;
import reactor.core.publisher.Flux;
/**
* Operator utility.
*
* @since 0.8.1
*/
public final class Operators {
private Operators() {
}
/**
* Replay signals from {@link Flux the source} until cancellation. Drains the source for data signals if the subscriber cancels the subscription.
*
* Draining data is required to complete a particular request/response window and clear the protocol state as client code expects to start a request/response conversation without leaving
* previous frames on the stack.
*
* @param source the source to decorate.
* @param The type of values in both source and output sequences.
* @return decorated {@link Flux}.
*/
public static Flux discardOnCancel(Flux source) {
return new FluxDiscardOnCancel<>(source, () -> {
});
}
/**
* Replay signals from {@link Flux the source} until cancellation. Drains the source for data signals if the subscriber cancels the subscription.
*
* Draining data is required to complete a particular request/response window and clear the protocol state as client code expects to start a request/response conversation without leaving
* previous frames on the stack.
*
Propagate the {@link Subscription#cancel()} signal to a {@link Runnable consumer}.
*
* @param source the source to decorate.
* @param cancelConsumer {@link Runnable} notified when the resulting {@link Flux} receives a {@link Subscription#cancel() cancel} signal.
* @param The type of values in both source and output sequences.
* @return decorated {@link Flux}.
*/
public static Flux discardOnCancel(Flux source, Runnable cancelConsumer) {
return new FluxDiscardOnCancel<>(source, cancelConsumer);
}
}