client/src/main/java/org/apache/nemo/client/DriverEndpoint.java

/*
 * 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.nemo.client;

import org.apache.nemo.runtime.common.state.PlanState;
import org.apache.nemo.runtime.master.PlanStateManager;

import java.util.concurrent.TimeUnit;

/**
 * A request endpoint in driver side of a plan.
 */
public final class DriverEndpoint {

  /**
   * The {@link PlanStateManager} of the running plan.
   */
  private final PlanStateManager planStateManager;

  /**
   * The {@link ClientEndpoint} of the plan.
   */
  private final ClientEndpoint clientEndpoint;

  /**
   * Construct an endpoint in driver side.
   * This method will be called by {@link ClientEndpoint}.
   *
   * @param planStateManager of running plan.
   * @param clientEndpoint   of running plan.
   */
  public DriverEndpoint(final PlanStateManager planStateManager,
                        final ClientEndpoint clientEndpoint) {
    this.planStateManager = planStateManager;
    this.clientEndpoint = clientEndpoint;
    clientEndpoint.connectDriver(this);
  }

  /**
   * Get the current state of the running plan.
   * This method will be called by {@link ClientEndpoint}.
   *
   * @return the current state of the running plan.
   */
  PlanState.State getState() {
    return planStateManager.getPlanState();
  }

  /**
   * Wait for this plan to be finished and return the final state.
   * It wait for at most the given time.
   * This method will be called by {@link ClientEndpoint}.
   *
   * @param timeout of waiting.
   * @param unit    of the timeout.
   * @return the final state of this plan.
   */
  PlanState.State waitUntilFinish(final long timeout,
                                  final TimeUnit unit) {
    return planStateManager.waitUntilFinish(timeout, unit);
  }

  /**
   * Wait for this plan to be finished and return the final state.
   * This method will be called by {@link ClientEndpoint}.
   *
   * @return the final state of this plan.
   */
  PlanState.State waitUntilFinish() {
    return planStateManager.waitUntilFinish();
  }
}