org.dromara.hutool.core.thread.ratelimiter

Class RateLimiterConfig

java.lang.Object

org.dromara.hutool.core.thread.ratelimiter.RateLimiterConfig

public class RateLimiterConfig
extends Object

限流通用配置

Since:

6.0.0

Author:

Looly

Constructor Summary

Constructors

Constructor and Description
RateLimiterConfig()

Method Summary

Modifier and Type	Method and Description
int	getCapacity() 容量，可以是总容量，或者每个周期的容量
int	getMaxReleaseCount() 在刷新周期内释放的最大数量，不能超过capacity
Duration	getRefreshPeriod() 刷新周期，即每多少时间刷新一次
Duration	getTimeout() 超时时间，即超过这个时间没有获取到许可，则返回false
static RateLimiterConfig	of() 创建限流配置
RateLimiterConfig	setCapacity(int capacity) 设置容量，可以是总容量，或者每个周期的容量
RateLimiterConfig	setMaxReleaseCount(int maxReleaseCount) 设置在刷新周期内释放的最大数量，不能超过capacity
RateLimiterConfig	setRefreshPeriod(Duration refreshPeriod) 设置刷新周期，即每多少时间刷新一次，单位毫秒
RateLimiterConfig	setTimeout(Duration timeout) 设置超时时间，即超过这个时间没有获取到许可，则返回false

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiterConfig

public RateLimiterConfig()

Method Detail

of

public static RateLimiterConfig of()

创建限流配置

Returns:

RateLimiterConfig

getTimeout

public Duration getTimeout()

超时时间，即超过这个时间没有获取到许可，则返回false

Returns:

超时时间

setTimeout

public RateLimiterConfig setTimeout(Duration timeout)

设置超时时间，即超过这个时间没有获取到许可，则返回false

Parameters:

timeout - 超时时间

Returns:

this

getRefreshPeriod

public Duration getRefreshPeriod()

刷新周期，即每多少时间刷新一次

Returns:

刷新周期

setRefreshPeriod

public RateLimiterConfig setRefreshPeriod(Duration refreshPeriod)

设置刷新周期，即每多少时间刷新一次，单位毫秒

Parameters:

refreshPeriod - 刷新周期

Returns:

this

getCapacity

public int getCapacity()

容量，可以是总容量，或者每个周期的容量

Returns:

容量

setCapacity

public RateLimiterConfig setCapacity(int capacity)

设置容量，可以是总容量，或者每个周期的容量

Parameters:

capacity - 容量

Returns:

this

getMaxReleaseCount

public int getMaxReleaseCount()

在刷新周期内释放的最大数量，不能超过capacity

Returns:

在刷新周期内释放的最大数量

setMaxReleaseCount

public RateLimiterConfig setMaxReleaseCount(int maxReleaseCount)

设置在刷新周期内释放的最大数量，不能超过capacity

Parameters:

maxReleaseCount - 在刷新周期内释放的最大数量

Returns:

this