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;
019
020import java.io.IOException;
021import org.apache.yetus.audience.InterfaceAudience;
022
023@InterfaceAudience.Public
024public interface RpcRetryingCaller<T> {
025  void cancel();
026
027  /**
028   * Retries if invocation fails.
029   * @param callTimeout Timeout for this call
030   * @param callable    The {@link RetryingCallable} to run.
031   * @return an object of type T
032   * @throws IOException      if a remote or network exception occurs
033   * @throws RuntimeException other unspecified error
034   */
035  T callWithRetries(RetryingCallable<T> callable, int callTimeout)
036    throws IOException, RuntimeException;
037
038  /**
039   * Call the server once only. {@link RetryingCallable} has a strange shape so we can do retries.
040   * Use this invocation if you want to do a single call only (A call to
041   * {@link RetryingCallable#call(int)} will not likely succeed).
042   * @return an object of type T
043   * @throws IOException      if a remote or network exception occurs
044   * @throws RuntimeException other unspecified error
045   */
046  T callWithoutRetries(RetryingCallable<T> callable, int callTimeout)
047    throws IOException, RuntimeException;
048}