com.ifengxue.http.ratelimiter.RateLimiter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 https://www.ifengxue.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ifengxue.http.ratelimiter;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * rate limiter
 *
 * @see RateLimiterInterceptor
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
public @interface RateLimiter {

  /**
   * RateLimiter name 如果name相同则共享限制
   */
  String name();

  /**
   * 等待limit的最大超时时间（毫秒）
   */
  long timeoutForWaitLimit();

  /**
   * 刷新limit的周期（毫秒）
   */
  long limitRefreshPeriod();

  /**
   * 每周期允许的请求数量
   */
  int limitForPeriod();
}