Record Class RateLimiter.RateLimitPolicy.TokenBucket

java.lang.Object
java.lang.Record
com.loomcache.server.network.RateLimiter.RateLimitPolicy.TokenBucket
Record Components:
tokensPerSecond - generation rate
burstCapacity - maximum tokens
All Implemented Interfaces:
RateLimiter.RateLimitPolicy
Enclosing interface:
RateLimiter.RateLimitPolicy
public static record RateLimiter.RateLimitPolicy.TokenBucket(double tokensPerSecond, double burstCapacity) extends Record implements RateLimiter.RateLimitPolicy
Token bucket policy: accumulate tokens at specified rate, burst capacity.
Since:
1.0

  • Constructor Details

    • TokenBucket

      public TokenBucket(double tokensPerSecond, double burstCapacity)
      Creates an instance of a TokenBucket record class.
      Parameters:
      tokensPerSecond - the value for the tokensPerSecond record component
      burstCapacity - the value for the burstCapacity record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • tokensPerSecond

      public double tokensPerSecond()
      Returns the value of the tokensPerSecond record component.
      Returns:
      the value of the tokensPerSecond record component

    • burstCapacity

      public double burstCapacity()
      Returns the value of the burstCapacity record component.
      Returns:
      the value of the burstCapacity record component