com.yahoo.search.searchers

Class RateLimitingSearcher.AvailableCapacity

java.lang.Object

com.yahoo.search.searchers.RateLimitingSearcher.AvailableCapacity

Enclosing class:

RateLimitingSearcher

private static class RateLimitingSearcher.AvailableCapacity
extends Object

This keeps track of the current "capacity" (total cost) available to each client (rate id) across all threads. Capacity is supplied at the rate per second given by the clients quota. When all the capacity is spent, no further capacity will be handed out, leading to request rejection. Capacity has a max value it will never exceed to avoid clients saving capacity for future overspending.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,RateLimitingSearcher.CapacityAllocation>	available
private Clock	clock
private double	maxAvailableCapacity

Constructor Summary

Constructors

Constructor and Description
AvailableCapacity(double maxAvailableCapacity, Clock clock)

Method Summary

Modifier and Type	Method and Description
double	request(String id, double minimumRequested, double preferredRequested, double rate) Returns an amount of capacity between 0 and the requested amount based on availability for this id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

maxAvailableCapacity

private final double maxAvailableCapacity

clock

private final Clock clock

available

private final Map<String,RateLimitingSearcher.CapacityAllocation> available

Constructor Detail

AvailableCapacity

public AvailableCapacity(double maxAvailableCapacity,
                         Clock clock)

Method Detail

request

public double request(String id,
                      double minimumRequested,
                      double preferredRequested,
                      double rate)

Returns an amount of capacity between 0 and the requested amount based on availability for this id