net.openhft.chronicle.hash.replication

Class ThrottlingConfig

java.lang.Object

net.openhft.chronicle.hash.replication.ThrottlingConfig

All Implemented Interfaces:

Serializable

public final class ThrottlingConfig
extends Object
implements Serializable

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ThrottlingConfig	bucketInterval(long throttleBucketInterval, TimeUnit unit) Returns a copy of this config with the specified bucketing interval.
long	bucketInterval(TimeUnit unit) Returns the throttle bucketing interval in the given time units.
boolean	equals(Object o)
int	hashCode()
static ThrottlingConfig	noThrottling() Returns a config which prescribe that a replicator shouldn't throttle.
static ThrottlingConfig	throttle(long maxBits, TimeUnit perUnit) Returns a config which throttle the specified max bits per the given time unit with default bucketing interval.
long	throttling(TimeUnit perUnit) Returns maximum bits per the given time unit, i.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

noThrottling

public static ThrottlingConfig noThrottling()

Returns a config which prescribe that a replicator shouldn't throttle.

Returns:

a config which prescribe that a replicator shouldn't throttle

throttle

public static ThrottlingConfig throttle(long maxBits,
                        TimeUnit perUnit)

Returns a config which throttle the specified max bits per the given time unit with default bucketing interval.

Parameters:

maxBits - the preferred maximum bits

perUnit - the time unit per which maximum bits specified

Returns:

a config which throttle the specified max bits per the given time unit

Throws:

IllegalArgumentException - if the specified maxBits is non-positive value

throttling

public final long throttling(TimeUnit perUnit)

Returns maximum bits per the given time unit, i. e. the throttling. 0 (zero) designates there is no throttling.

Parameters:

perUnit - maximum bits is returned per this time unit

Returns:

maximum bits per the given time unit, or 0 if there is no throttling

bucketInterval

public long bucketInterval(TimeUnit unit)

Returns the throttle bucketing interval in the given time units.

Default throttle bucketing interval is 100 millis.

Parameters:

unit - the time unit of the interval

Returns:

the bucketing interval for throttling in the given time units

bucketInterval

public ThrottlingConfig bucketInterval(long throttleBucketInterval,
                              TimeUnit unit)

Returns a copy of this config with the specified bucketing interval.

Parameters:

throttleBucketInterval - the bucketing interval for throttling

unit - the time unit of the interval

Returns:

a copy of this config with the specified bucketing interval

Throws:

IllegalArgumentException - if the given bucketing interval is non-positive

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object