001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.driver.restart;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.Unstable;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.wake.time.Time;
025
026/**
027 * The object used to notify the user that the Driver Restart process has been completed.
028 */
029@Public
030@Unstable
031@Provided
032public interface DriverRestartCompleted {
033
034  /**
035   * @return the completed time of Driver restart.
036   */
037  Time getCompletedTime();
038
039  /**
040   * @return True if Driver restart completion was triggered by a timeout. False if triggered due to all Evaluators
041   * reporting back.
042   */
043  boolean isTimedOut();
044}