CommandExecutor.java

// =================================================================================================
// Copyright 2011 Twitter, Inc.
// -------------------------------------------------------------------------------------------------
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this work except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file, or 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 com.twitter.common.util;

import com.twitter.common.base.ExceptionalCommand;
import com.twitter.common.quantity.Amount;
import com.twitter.common.quantity.Time;

/**
 * Asynchronous executor of enqueued tasks in a rate limited manner.
 *
 * @author Srinivasan Rajagopal
 */
public interface CommandExecutor {

  /**
   * Enqueue a task to be executed with retry semantics defined.
   *
   * @param name Human readable name for this task.
   * @param task task to execute.
   * @param exceptionClass Concrete exception type.
   * @param maxTries num of tries in case of failure.
   * @param retryDelay interval between retries in case of failure.
   */
  <E extends Exception> void execute(
      String name,
      ExceptionalCommand<E> task,
      Class<E> exceptionClass,
      int maxTries,
      Amount<Long, Time> retryDelay);
}