org.apache.flink.runtime.scheduler.OperatorCoordinatorHandler 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.scheduler;
import org.apache.flink.runtime.concurrent.ComponentMainThreadExecutor;
import org.apache.flink.runtime.executiongraph.ExecutionAttemptID;
import org.apache.flink.runtime.jobgraph.OperatorID;
import org.apache.flink.runtime.operators.coordination.CoordinationRequest;
import org.apache.flink.runtime.operators.coordination.CoordinationResponse;
import org.apache.flink.runtime.operators.coordination.OperatorCoordinator;
import org.apache.flink.runtime.operators.coordination.OperatorCoordinatorHolder;
import org.apache.flink.runtime.operators.coordination.OperatorEvent;
import org.apache.flink.util.FlinkException;
import java.util.Collection;
import java.util.concurrent.CompletableFuture;
/** Handler for the {@link OperatorCoordinator OperatorCoordinators}. */
public interface OperatorCoordinatorHandler {
/**
* Initialize operator coordinators.
*
* @param mainThreadExecutor Executor for submitting work to the main thread.
*/
void initializeOperatorCoordinators(ComponentMainThreadExecutor mainThreadExecutor);
/** Start all operator coordinators. */
void startAllOperatorCoordinators();
/** Dispose all operator coordinators. */
void disposeAllOperatorCoordinators();
/**
* Delivers an OperatorEvent to a {@link OperatorCoordinator}.
*
* @param taskExecutionId Execution attempt id of the originating task.
* @param operatorId OperatorId of the target OperatorCoordinator.
* @param event Event to deliver to the OperatorCoordinator.
* @throws FlinkException If no coordinator is registered for operator.
*/
void deliverOperatorEventToCoordinator(
ExecutionAttemptID taskExecutionId, OperatorID operatorId, OperatorEvent event)
throws FlinkException;
/**
* Deliver coordination request from the client to the coordinator.
*
* @param operator Id of target operator.
* @param request request for the operator.
* @return Future with the response.
* @throws FlinkException If the coordinator doesn't exist or if it can not handle the request.
*/
CompletableFuture deliverCoordinationRequestToCoordinator(
OperatorID operator, CoordinationRequest request) throws FlinkException;
/**
* Register and start new operator coordinators.
*
* @param coordinators the operator coordinator to be registered.
* @param mainThreadExecutor Executor for submitting work to the main thread.
*/
void registerAndStartNewCoordinators(
Collection coordinators,
ComponentMainThreadExecutor mainThreadExecutor);
}