org.apache.flink.streaming.api.operators.BoundedMultiInput Maven / Gradle / Ivy
/*
* 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.api.operators;
import org.apache.flink.annotation.PublicEvolving;
/**
* Interface for multi-input operators that need to be notified about the logical/semantical end of
* input.
*
* NOTE: Classes should not implement both {@link BoundedOneInput} and {@link
* BoundedMultiInput} at the same time!
*
* @see BoundedOneInput
*/
@PublicEvolving
public interface BoundedMultiInput {
/**
* It is notified that no more data will arrive from the input identified by the {@code
* inputId}. The {@code inputId} is numbered starting from 1, and `1` indicates the first input.
*
*
WARNING: It is not safe to use this method to commit any transactions or other side
* effects! You can use this method to e.g. flush data buffered for the given input or implement
* an ordered reading from multiple inputs via {@link InputSelectable}.
*/
void endInput(int inputId) throws Exception;
}