Index (Armeria 1.25.2 API reference)

A

accept(ServiceRequestContext, T) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategy: Registers a request with the bucket.

BandwidthLimit - Class in com.linecorp.armeria.server.throttling.bucket4j: Stores configurations of a single Token-Bucket bandwidth limit.
build() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder: Returns a newly-created TokenBucket based on the set of limits configured for this builder.
build() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder: Returns a newly-created TokenBucketThrottlingStrategy based on the properties of this builder.
builder() - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket: Returns a newly created TokenBucketBuilder.
builder(TokenBucket) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategy: Returns a newly created TokenBucketThrottlingStrategyBuilder.

com.linecorp.armeria.common.throttling - package com.linecorp.armeria.common.throttling: Common throttling artifacts used by throttling implementation.
com.linecorp.armeria.server.throttling.bucket4j - package com.linecorp.armeria.server.throttling.bucket4j: Rate-limiting throttling implementation based on Token-Bucket algorithm and Bucket4j library.

headersScheme(ThrottlingHeaders) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder: Optional ThrottlingHeaders to define specific RateLimit Header Scheme for HTTP.
headersScheme(ThrottlingHeaders, boolean) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder: Optional ThrottlingHeaders to define specific RateLimit Header Scheme for HTTP.

initialSize() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns the number of initial available tokens available to this bandwidth limit.

limit() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns the bucket size, which defines the count of tokens which can be held by the bucket and defines the speed at which tokens are regenerated in the bucket.
limit(long, long, long, Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder: Adds new BandwidthLimit.
limit(long, long, Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder: Adds new BandwidthLimit.
limit(long, Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder: Adds new BandwidthLimit.
limitHeader() - Method in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders: Returns the name of the "limit" throttling header for the given scheme, like "X-RateLimit-Limit".
limits() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket: Returns multiple limits applied to the bucket.
limits(BandwidthLimit...) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder: Adds a number of BandwidthLimit.
limits(Iterable<BandwidthLimit>) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketBuilder: Adds a number of BandwidthLimit.

minimumBackoff(Duration) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder: Optional Duration that defines a minimum backoff period for throttled requests.

name(String) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategyBuilder: Optional name of the strategy.

of(long, long, long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns a newly created BandwidthLimit.
of(long, long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns a newly created BandwidthLimit.
of(long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns a newly created simple BandwidthLimit.
of(long, Duration) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket: Returns a newly created TokenBucket with a single simple BandwidthLimit.
of(String) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns a newly created BandwidthLimit.
of(String) - Static method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket: Returns a newly created TokenBucket.
overdraftLimit() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns the maximum overdraft count of tokens which can be held by the bucket.

period() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit: Returns the time window, during which the tokens will be regenerated for the given bandwidth limit.

RATELIMIT - Static variable in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders: Describes RateLimit Header Fields for HTTP.
reconfigure(TokenBucket) - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucketThrottlingStrategy: Resets the Token-Bucket configuration at runtime by providing a new set of limits.
remainingHeader() - Method in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders: Returns the name of the "remaining" throttling header for the given scheme, like "X-RateLimit-Remaining".
resetHeader() - Method in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders: Returns the name of the "reset" throttling header for the given scheme, like "X-RateLimit-Reset".

ThrottlingHeaders - Interface in com.linecorp.armeria.common.throttling: A RateLimit Header Scheme for HTTP.
TokenBucket - Class in com.linecorp.armeria.server.throttling.bucket4j: Stores configuration of the Token-Bucket algorithm, comprised of multiple limits.
TokenBucketBuilder - Class in com.linecorp.armeria.server.throttling.bucket4j: Builds a TokenBucket instance.
TokenBucketThrottlingStrategy<T extends com.linecorp.armeria.common.Request> - Class in com.linecorp.armeria.server.throttling.bucket4j: A ThrottlingStrategy that provides a throttling strategy based on Token-Bucket algorithm.
TokenBucketThrottlingStrategyBuilder<T extends com.linecorp.armeria.common.Request> - Class in com.linecorp.armeria.server.throttling.bucket4j: Builds TokenBucketThrottlingStrategy.
toString() - Method in class com.linecorp.armeria.server.throttling.bucket4j.BandwidthLimit
toString() - Method in class com.linecorp.armeria.server.throttling.bucket4j.TokenBucket

X_RATE_LIMIT - Static variable in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders: Describes another alternative RateLimit Header Scheme for HTTP, used by Twitter.
X_RATELIMIT - Static variable in interface com.linecorp.armeria.common.throttling.ThrottlingHeaders: Describes an alternative RateLimit Header Scheme for HTTP, used by Github and Vimeo.