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 org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
021
022/**
023 * Tracks the amount of time remaining for an operation.
024 */
025class RetryingTimeTracker {
026  private long globalStartTime = -1;
027
028  public RetryingTimeTracker start() {
029    if (this.globalStartTime < 0) {
030      this.globalStartTime = EnvironmentEdgeManager.currentTime();
031    }
032    return this;
033  }
034
035  public int getRemainingTime(int callTimeout) {
036    if (callTimeout <= 0) {
037      return 0;
038    } else {
039      if (callTimeout == Integer.MAX_VALUE) {
040        return Integer.MAX_VALUE;
041      }
042      long remaining = EnvironmentEdgeManager.currentTime() - this.globalStartTime;
043      long remainingTime = callTimeout - remaining;
044      if (remainingTime < 1) {
045        // If there is no time left, we're trying anyway. It's too late.
046        // 0 means no timeout, and it's not the intent here. So we secure both cases by
047        // resetting to the minimum.
048        remainingTime = 1;
049      }
050      if (remainingTime > Integer.MAX_VALUE) {
051        throw new RuntimeException(
052          "remainingTime=" + remainingTime + " which is > Integer.MAX_VALUE");
053      }
054      return (int) remainingTime;
055    }
056  }
057
058  public long getStartTime() {
059    return this.globalStartTime;
060  }
061}