org.apache.gobblin.util.request_allocation

Class ConcurrentBoundedPriorityIterable<T>

java.lang.Object

org.apache.gobblin.util.request_allocation.ConcurrentBoundedPriorityIterable<T>

All Implemented Interfaces:

Iterable<AllocatedRequestsIteratorBase.RequestWithResourceRequirement<T>>

public class ConcurrentBoundedPriorityIterable<T>
extends Object
implements Iterable<AllocatedRequestsIteratorBase.RequestWithResourceRequirement<T>>

A concurrent bounded priority Iterable. Given a ResourcePool, a ResourceEstimator, and a Comparator as a prioritizer, user can attempt to add elements to this container. The container stores a subset of the offered elements such that their ResourceRequirement is within the bounds of the ResourcePool, preferentially storing high priority elements. This functionality is achieved by automatic eviction of low priority items when space for a higher priority item is needed. A call to iterator() returns an iterator over the current elements in the container in order from high priority to low priority. Note after calling iterator(), no more requests can be added (will throw RuntimeException). Note: as with a priority queue, e1 < e2 means that e1 is higher priority than e2.

Constructor Summary

Constructors

Constructor and Description
ConcurrentBoundedPriorityIterable(Comparator<? super T> prioritizer, ResourceEstimator<T> resourceEstimator, String storeRejectedRequestsSetting, ResourcePool pool)

Method Summary

Modifier and Type	Method and Description
boolean	add(T t) Offer an element to the container.
boolean	hasRejectedElement()
boolean	isFull()
Iterator<AllocatedRequestsIteratorBase.RequestWithResourceRequirement<T>>	iterator()
void	logStatistics(com.google.common.base.Optional<org.slf4j.Logger> logger) Log statistics about this ConcurrentBoundedPriorityIterable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ConcurrentBoundedPriorityIterable

public ConcurrentBoundedPriorityIterable(Comparator<? super T> prioritizer,
                                         ResourceEstimator<T> resourceEstimator,
                                         String storeRejectedRequestsSetting,
                                         ResourcePool pool)

Method Detail

add

public boolean add(T t)

Offer an element to the container.

Returns:

true if the element was added, false if there was no space and we could not evict any elements to make it fit. Note that the element may get evicted by future offers, so a return of true is not a guarantee that the element will be present at any time in the future.

hasRejectedElement

public boolean hasRejectedElement()

Returns:

Whether any calls to add(T) have returned false, i.e. some element has been rejected due to strict capacity issues.

isFull

public boolean isFull()

Returns:

Whether the list has reached its soft bound.

logStatistics

public void logStatistics(com.google.common.base.Optional<org.slf4j.Logger> logger)

Log statistics about this ConcurrentBoundedPriorityIterable.

iterator

public Iterator<AllocatedRequestsIteratorBase.RequestWithResourceRequirement<T>> iterator()

Specified by:

iterator in interface Iterable<AllocatedRequestsIteratorBase.RequestWithResourceRequirement<T>>