lang/java/reef-runtime-mock/src/main/java/org/apache/reef/mock/driver/MockRuntime.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.reef.mock.driver;

import org.apache.reef.annotations.Unstable;
import org.apache.reef.driver.context.ContextMessage;
import org.apache.reef.driver.restart.DriverRestartCompleted;

/**
 * Mock API used to drive the evaluation of ProcessRequest
 * events, which are triggered by the Application driver.
 * Clients used this to determine whether a particular ProcessRequest
 * event should succeed or fail.
 */
@Unstable
public interface MockRuntime extends MockFailure {

  /**
   * Initiate the start time event to the application driver.
   */
  void start();

  /**
   * Initiate the stop time event to the application driver.
   */
  void stop();

  /**
   * Initiate a driver restart.
   * @param restartContext contains the state of the driver at the time of failure
   * @param isTimeout used to fill in {@link DriverRestartCompleted#isTimedOut()}
   * @param duration recover time duration (added to start time)
   */
  void restart(MockDriverRestartContext restartContext, boolean isTimeout, long duration);

  /**
   * @return true if there is an outstanding ProcessRequest
   */
  boolean hasProcessRequest();

  /**
   * The client (caller) is responsible for determining what
   * to do with a ProcessRequest event. There are three options:
   * 1. Pass to the succeed method, which signals success to the driver.
   * 2. Pass to the fail method, signaling failure to the driver.
   * 3. Drop it on the floor (e.g., network failure).
   *
   * @return the next ProcessRequest object to be processed.
   */
  ProcessRequest getNextProcessRequest();

  /**
   * The driver will be informed that the operation corresponding
   * to the ProcessRequest succeeded, and will be given any relevant
   * data structures e.g., AllocatedEvaluator, RunningTask, etc.
   *
   * @param request to be processed successfully
   */
  void succeed(ProcessRequest request);

  /**
   * The driver will be informed that the operation corresponding
   * to the PRocessRequest failed, and will be given any relevant
   * data structures e.g., FailedEvaluator, FailedTask, etc.
   *
   * @param request to be failed.
   */
  void fail(ProcessRequest request);

  /**
   * Publish a context message to the application event handlers.
   * @param contextMessage to be published
   */
  void publish(ContextMessage contextMessage);
}