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, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client.backoff;
019
020import org.apache.hadoop.hbase.ServerName;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Configurable policy for the amount of time a client should wait for a new request to the
025 * server when given the server load statistics.
026 * <p>
027 * Must have a single-argument constructor that takes a {@link org.apache.hadoop.conf.Configuration}
028 * </p>
029 */
030@InterfaceAudience.Public
031public interface ClientBackoffPolicy {
032
033  public static final String BACKOFF_POLICY_CLASS =
034      "hbase.client.statistics.backoff-policy";
035
036  /**
037   * @return the number of ms to wait on the client based on the
038   */
039  public long getBackoffTime(ServerName serverName, byte[] region, ServerStatistics stats);
040}