View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    * http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.hadoop.hbase.client;
18  
19  import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
20  
21  /**
22   * Tracks the amount of time remaining for an operation.
23   */
24  class RetryingTimeTracker {
25  
26    private long globalStartTime = -1;
27  
28    public RetryingTimeTracker start() {
29      if (this.globalStartTime < 0) {
30        this.globalStartTime = EnvironmentEdgeManager.currentTime();
31      }
32      return this;
33    }
34  
35    public int getRemainingTime(int callTimeout) {
36      if (callTimeout <= 0) {
37        return 0;
38      } else {
39        if (callTimeout == Integer.MAX_VALUE) {
40          return Integer.MAX_VALUE;
41        }
42        int remainingTime = (int) (
43          callTimeout -
44          (EnvironmentEdgeManager.currentTime() - this.globalStartTime));
45        if (remainingTime < 1) {
46          // If there is no time left, we're trying anyway. It's too late.
47          // 0 means no timeout, and it's not the intent here. So we secure both cases by
48          // resetting to the minimum.
49          remainingTime = 1;
50        }
51        return remainingTime;
52      }
53    }
54  
55    public long getStartTime() {
56      return this.globalStartTime;
57    }
58  }