org.apache.flink.runtime.io.network.partition.ReconnectableSubpartition 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.runtime.io.network.partition;
import javax.annotation.Nullable;
/**
* A subpartition that supports reconnecting.
*/
interface ReconnectableSubpartition {
/**
* The enumeration of subpartition State.
*/
enum State {
/**
* Initialized state.
*/
INITIALIZED,
/**
* Suspended state.
*/
SUSPENDED,
/**
* Consuming state.
*/
CONSUMING
}
/**
* Suspend consuming.
*
* @param view the view which causes this suspending, null value means forcibly suspending
*/
void suspend(@Nullable ResultSubpartitionView view);
/**
* Allow the view to consume this subpartition.
*
* @param view the read view allowed consuming
*/
void allowConsuming(ResultSubpartitionView view);
/**
* Gets state of subpartition.
*
* @return the state
*/
State getState();
}