com.spotify.styx.util.CounterSnapshot Maven / Gradle / Ivy

Go to download
/*-
 * -\-\-
 * Spotify Styx Common
 * --
 * Copyright (C) 2016 - 2018 Spotify AB
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License 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.spotify.styx.util;

import java.util.Map;
import java.util.Optional;

/**
 * An interface for counter snapshots
 */
public interface CounterSnapshot {

  Map getShards();

  int pickShardWithSpareCapacity(long delta);

  long shardCapacity(int shardIndex);

  long getLimit();

  long getTotalUsage();

  Optional pickShardWithExcessUsage(long delta);
}