Package org.apache.pulsar.broker.qos

Class DynamicRateAsyncTokenBucket

java.lang.Object

org.apache.pulsar.broker.qos.AsyncTokenBucket

org.apache.pulsar.broker.qos.DynamicRateAsyncTokenBucket

public class DynamicRateAsyncTokenBucket
extends AsyncTokenBucket

A subclass of AsyncTokenBucket that represents a token bucket with a dynamic rate. The rate and capacity of the token bucket can change over time based on the rate function and capacity factor.

Field Summary

Fields inherited from class org.apache.pulsar.broker.qos.AsyncTokenBucket

DEFAULT_SNAPSHOT_CLOCK, resolutionNanos, tokens

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DynamicRateAsyncTokenBucket(double capacityFactor, LongSupplier rateFunction, MonotonicSnapshotClock clockSource, LongSupplier ratePeriodNanosFunction, long resolutionNanos, double initialTokensFactor, double targetFillFactorAfterThrottling)

Method Summary

Modifier and Type	Method	Description
long	getCapacity()
long	getRate()
protected long	getRatePeriodNanos()
protected long	getTargetAmountOfTokensAfterThrottling()

Methods inherited from class org.apache.pulsar.broker.qos.AsyncTokenBucket

builder, builderForDynamicRate, calculateThrottlingDuration, consumeTokens, consumeTokensAndCheckIfContainsTokens, containsTokens, containsTokens, getTokens, resetToDefaultEventualConsistentTokensView, switchToConsistentTokensView, tokens

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicRateAsyncTokenBucket

protected DynamicRateAsyncTokenBucket(double capacityFactor,
 LongSupplier rateFunction,
 MonotonicSnapshotClock clockSource,
 LongSupplier ratePeriodNanosFunction,
 long resolutionNanos,
 double initialTokensFactor,
 double targetFillFactorAfterThrottling)

Method Details

getRatePeriodNanos

protected long getRatePeriodNanos()

Specified by:

getRatePeriodNanos in class AsyncTokenBucket

getTargetAmountOfTokensAfterThrottling

protected long getTargetAmountOfTokensAfterThrottling()

Specified by:

getTargetAmountOfTokensAfterThrottling in class AsyncTokenBucket

getCapacity

public long getCapacity()

Specified by:

getCapacity in class AsyncTokenBucket

getRate

public long getRate()

Specified by:

getRate in class AsyncTokenBucket