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.parameters;
020
021import org.apache.reef.annotations.Unstable;
022import org.apache.reef.tang.annotations.Name;
023import org.apache.reef.tang.annotations.NamedParameter;
024
025/**
026 * Represents the amount of time in seconds that the driver restart waits for evaluators to report back.
027 * Defaults to 3 minutes. If the value is set to Integer.MAX_VALUE, the driver will wait forever until all
028 * expected evaluators report back or fail.
029 */
030@Unstable
031@NamedParameter(doc = "The amount of time in seconds that the driver restart waits for" +
032    " evaluators to report back. Defaults to 3 minutes. If the value is set to Integer.MAX_VALUE, " +
033    "the driver will wait forever until all expected evaluators report back or fail.",
034    default_value = DriverRestartEvaluatorRecoverySeconds.DEFAULT)
035public final class DriverRestartEvaluatorRecoverySeconds implements Name<Integer> {
036
037  /**
038   * The driver waits forever until all expected evaluators report back or fail.
039   */
040  public static final String INFINITE = Long.toString(Integer.MAX_VALUE);
041
042  /**
043   * Default restart wait for the driver is 3 minutes.
044   */
045  public static final String DEFAULT = "180";
046
047  private DriverRestartEvaluatorRecoverySeconds(){
048  }
049}