com.comapi.chat.internal

Class CallLimiter

java.lang.Object

com.comapi.chat.internal.CallLimiter

public class CallLimiter
extends java.lang.Object

Controls number of calls allowed in a set timescale.

Since:

1.0.1

Constructor Summary

Constructors

Constructor and Description
CallLimiter(int largeTimeFrame, int largeCallsLimit, java.util.concurrent.TimeUnit largeTimeUnit, int smallTimeFrame, int smallCallLimit, java.util.concurrent.TimeUnit smallTimeUnit, long shutdownPeriodInMinutes) Recommended constructor.

Method Summary

Modifier and Type	Method and Description
boolean	checkAndIncrease() Check if next call is allowed and increase the counts.

Methods inherited from class java.lang.Object

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

Constructor Detail

CallLimiter

public CallLimiter(int largeTimeFrame,
                   int largeCallsLimit,
                   java.util.concurrent.TimeUnit largeTimeUnit,
                   int smallTimeFrame,
                   int smallCallLimit,
                   java.util.concurrent.TimeUnit smallTimeUnit,
                   long shutdownPeriodInMinutes)

Recommended constructor.

Parameters:

largeTimeFrame - Time frame for large call limit.

largeCallsLimit - Number of calls allowed in large timescale. Calling more times will result in a shutdown scenario.

largeTimeUnit - Time units in which the large time frame is provided.

smallTimeFrame - Time frame for small call limit.

smallCallLimit - Number of calls allowed in small timescale.

smallTimeUnit - Time units in which the small time frame is provided.

shutdownPeriodInMinutes - For how long the calls will be blocked after reaching large limit.

Method Detail

checkAndIncrease

public boolean checkAndIncrease()

Check if next call is allowed and increase the counts.

Returns:

True if a next call is allowed.