org.apache.flink.runtime.io.network.partition.PartitionTracker 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 org.apache.flink.runtime.clusterframework.types.ResourceID;
import org.apache.flink.runtime.deployment.ResultPartitionDeploymentDescriptor;
import java.util.Collection;
/**
* Utility for tracking partitions and issuing release calls to task executors and shuffle masters.
*/
public interface PartitionTracker {
/**
* Starts the tracking of the given partition for the given task executor ID.
*
* @param producingTaskExecutorId ID of task executor on which the partition is produced
* @param resultPartitionDeploymentDescriptor deployment descriptor of the partition
*/
void startTrackingPartition(ResourceID producingTaskExecutorId, ResultPartitionDeploymentDescriptor resultPartitionDeploymentDescriptor);
/**
* Stops the tracking of all partitions for the given task executor ID, without issuing any release calls.
*/
void stopTrackingPartitionsFor(ResourceID producingTaskExecutorId);
/**
* Releases the given partitions and stop the tracking of partitions that were released.
*/
void stopTrackingAndReleasePartitions(Collection resultPartitionIds);
/**
* Stops the tracking of the given partitions.
*/
void stopTrackingPartitions(Collection resultPartitionIds);
/**
* Releases all partitions for the given task executor ID, and stop the tracking of partitions that were released.
*/
void stopTrackingAndReleasePartitionsFor(ResourceID producingTaskExecutorId);
/**
* Returns whether any partition is being tracked for the given task executor ID.
*/
boolean isTrackingPartitionsFor(ResourceID producingTaskExecutorId);
/**
* Returns whether the given partition is being tracked.
*/
boolean isPartitionTracked(ResultPartitionID resultPartitionID);
}