org.dromara.hutool.core.thread.ratelimiter

Interface RateLimiter

All Known Implementing Classes:

SemaphoreRateLimiter, TokenBucketRateLimiter

public interface RateLimiter

限流接口
通过实现此接口以实现不同的限流策略，如令牌桶、分布式限流等

Since:

6.0.0

Author:

Looly

Method Summary

Modifier and Type	Method and Description
default void	acquire() 获取许可，阻塞方法，如果没有足够的许可，则阻塞等待
void	acquire(int permits) 获取许可，阻塞方法，如果没有足够的许可，则阻塞等待
default boolean	tryAcquire() 尝试获取许可，非阻塞方法
boolean	tryAcquire(int permits) 尝试获取许可，非阻塞方法

Method Detail

tryAcquire

default boolean tryAcquire()

尝试获取许可，非阻塞方法

Returns:

true表示成功获取，false表示无足够的许可可获取，此时需要等待给定的时间

tryAcquire

boolean tryAcquire(int permits)

尝试获取许可，非阻塞方法

Parameters:

permits - 需要的许可数

Returns:

true表示成功获取，false表示无足够的许可可获取，此时需要等待给定的时间

acquire

default void acquire()

获取许可，阻塞方法，如果没有足够的许可，则阻塞等待

acquire

void acquire(int permits)

获取许可，阻塞方法，如果没有足够的许可，则阻塞等待

Parameters:

permits - 需要的许可数