Record Class RateLimiter.RateLimiterStats

java.lang.Object

java.lang.Record

com.loomcache.server.network.RateLimiter.RateLimiterStats

Enclosing class:

RateLimiter

public static record RateLimiter.RateLimiterStats(long totalRequests, long totalAllowed, long totalDenied, int activeClients, Map<String, RateLimiter.ClientStats> perClientStats)
extends Record

Immutable snapshot of rate limiter metrics.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
RateLimiterStats(long totalRequests, long totalAllowed, long totalDenied, int activeClients, Map<String, RateLimiter.ClientStats> perClientStats)	Creates an instance of a RateLimiterStats record class.

Method Summary

Modifier and Type	Method	Description
int	activeClients()	Returns the value of the activeClients record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<String, RateLimiter.ClientStats>	perClientStats()	Returns the value of the perClientStats record component.
final String	toString()	Returns a string representation of this record class.
long	totalAllowed()	Returns the value of the totalAllowed record component.
long	totalDenied()	Returns the value of the totalDenied record component.
long	totalRequests()	Returns the value of the totalRequests record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RateLimiterStats

public RateLimiterStats(long totalRequests,
 long totalAllowed,
 long totalDenied,
 int activeClients,
 Map<String, RateLimiter.ClientStats> perClientStats)

Creates an instance of a RateLimiterStats record class.

Parameters:

totalRequests - the value for the totalRequests record component

totalAllowed - the value for the totalAllowed record component

totalDenied - the value for the totalDenied record component

activeClients - the value for the activeClients record component

perClientStats - the value for the perClientStats 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

totalRequests

public long totalRequests()

Returns the value of the totalRequests record component.

Returns:

the value of the totalRequests record component

totalAllowed

public long totalAllowed()

Returns the value of the totalAllowed record component.

Returns:

the value of the totalAllowed record component

totalDenied

public long totalDenied()

Returns the value of the totalDenied record component.

Returns:

the value of the totalDenied record component

activeClients

public int activeClients()

Returns the value of the activeClients record component.

Returns:

the value of the activeClients record component

perClientStats

public Map<String, RateLimiter.ClientStats> perClientStats()

Returns the value of the perClientStats record component.

Returns:

the value of the perClientStats record component