org.apache.flink.runtime.util

Class KeyedBudgetManager<K>

java.lang.Object

org.apache.flink.runtime.util.KeyedBudgetManager<K>

Type Parameters:

K - type of the budget key

@ThreadSafe
public class KeyedBudgetManager<K>
extends Object

Manages long available budget per key (allocation/release).

This manager gets a certain maximum long budget per key. Users can acquire some budget for some key and release it later. The manager keeps track of acquired/released budget and prevents from over-allocating.

There is also a paged type of allocation where a certain number of pages can be acquired from a set of keys. The page has its budget size. The manager acquires randomly from all keys of a given set. At the end, sum of pages acquired from each key is either requested number of pages or none. Only integer number of pages are acquired from each key respecting its available budget (no page spans two or more keys) or nothing is acquired reporting the maximum number of pages which could be acquired per each given key at the moment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyedBudgetManager.AcquisitionResult<K> Result of budget acquisition to return from acquisition functions.

Constructor Summary

Constructors

Constructor and Description
KeyedBudgetManager(Map<K,Long> maxBudgetByKey, long defaultPageSize)

Method Summary

Modifier and Type	Method and Description
long	acquireBudgetForKey(K key, long size) Tries to acquire budget for a given key.
KeyedBudgetManager.AcquisitionResult<K>	acquirePagedBudget(Iterable<K> keys, long numberOfPages) Tries to acquire budget for given keys which equals to the number of pages times default page size.
long	availableBudgetForKey(K key)
long	getDefaultPageSize()
long	maxTotalBudget()
long	maxTotalBudgetForKey(K key)
long	maxTotalNumberOfPages()
void	releaseAll()
void	releaseBudgetForKey(K key, long size)
void	releaseBudgetForKeys(Map<K,Long> sizeByKey)
void	releasePageForKey(K key)
long	totalAvailableBudget()

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyedBudgetManager

public KeyedBudgetManager(Map<K,Long> maxBudgetByKey,
                          long defaultPageSize)

Method Detail

getDefaultPageSize

public long getDefaultPageSize()

acquireBudgetForKey

public long acquireBudgetForKey(K key,
                                long size)

Tries to acquire budget for a given key.

No budget is acquired if it was not possible to fully acquire the requested budget.

Parameters:

key - the key to acquire budget from

size - the size of budget to acquire from the given key

Returns:

the fully acquired budget for the key or max possible budget to acquire if it was not possible to acquire the requested budget.

acquirePagedBudget

public KeyedBudgetManager.AcquisitionResult<K> acquirePagedBudget(Iterable<K> keys,
                                                                  long numberOfPages)

Tries to acquire budget for given keys which equals to the number of pages times default page size.

See also acquirePagedBudgetForKeys(Iterable, long, long)

releasePageForKey

public void releasePageForKey(K key)

releaseBudgetForKey

public void releaseBudgetForKey(K key,
                                long size)

releaseBudgetForKeys

public void releaseBudgetForKeys(Map<K,Long> sizeByKey)

releaseAll

public void releaseAll()

maxTotalBudget

public long maxTotalBudget()

maxTotalNumberOfPages

public long maxTotalNumberOfPages()

maxTotalBudgetForKey

public long maxTotalBudgetForKey(K key)

totalAvailableBudget

public long totalAvailableBudget()

availableBudgetForKey

public long availableBudgetForKey(K key)