com.github.akurilov.commons.concurrent.Throttle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-commons Show documentation

Common functionality Java library

There is a newer version: 2.3.6

package com.github.akurilov.commons.concurrent;

/**
 Throttle can make a decision about the specified thing to pass or to wait.
 The throttle calls are not blocking so the caller should block if the throttle tells so.
 */
public interface Throttle {

	/**
	 Request a permit about a thing
	 @param thing the subject of the permit
	 @return true if the thing should be passed, false otherwise
	 */
	boolean tryAcquire(final X thing);

	/**
	 Request permits about a set of things
	 @param thing the subject of the permits
	 @param times how many permits is requested
	 @return how many permits are got
	 */
	int tryAcquire(final X thing, int times);
}