alluxio-master-2.x/core/common/src/main/java/alluxio/heartbeat/HeartbeatExecutor.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.heartbeat;

import java.io.Closeable;

/**
 * An interface for a heartbeat execution. The {@link HeartbeatThread} calls the
 * {@link #heartbeat(long)} method.
 */
public interface HeartbeatExecutor extends Closeable {

  /**
   * Implements the heartbeat logic.
   *
   * @param timeLimitMs time limit in milliseconds this heartbeat should not exceed when running
   * @throws InterruptedException if the thread is interrupted
   */
  void heartbeat(long timeLimitMs) throws InterruptedException;

  /**
   * Cleans up any resources used by the heartbeat executor.
   */
  @Override
  void close();
}
