org.apache.flink.streaming.runtime.io.StreamTaskExternallyInducedSourceInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-streaming-java Show documentation
There is a newer version: 2.0-preview1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.streaming.runtime.io;

import org.apache.flink.api.connector.source.ExternallyInducedSourceReader;
import org.apache.flink.streaming.api.operators.SourceOperator;

import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;

/** A subclass of {@link StreamTaskSourceInput} for {@link ExternallyInducedSourceReader}. */
public class StreamTaskExternallyInducedSourceInput extends StreamTaskSourceInput {
    private final Consumer checkpointTriggeringHook;
    private final ExternallyInducedSourceReader sourceReader;
    private CompletableFuture blockFuture;

    @SuppressWarnings("unchecked")
    public StreamTaskExternallyInducedSourceInput(
            SourceOperator operator,
            Consumer checkpointTriggeringHook,
            int inputGateIndex,
            int inputIndex) {
        super(operator, inputGateIndex, inputIndex);
        this.checkpointTriggeringHook = checkpointTriggeringHook;
        this.sourceReader = (ExternallyInducedSourceReader) operator.getSourceReader();
    }

    public void blockUntil(CompletableFuture blockFuture) {
        this.blockFuture = blockFuture;
        // assume that the future is completed in mailbox thread
        blockFuture.whenComplete((v, e) -> unblock());
    }

    private void unblock() {
        this.blockFuture = null;
    }

    @Override
    public DataInputStatus emitNext(DataOutput output) throws Exception {
        if (blockFuture != null) {
            return DataInputStatus.NOTHING_AVAILABLE;
        }

        DataInputStatus status = super.emitNext(output);
        if (status == DataInputStatus.NOTHING_AVAILABLE) {
            sourceReader.shouldTriggerCheckpoint().ifPresent(checkpointTriggeringHook);
        }
        return status;
    }

    @Override
    public CompletableFuture getAvailableFuture() {
        if (blockFuture != null) {
            return blockFuture;
        }
        return super.getAvailableFuture();
    }
}