SlidingWeightedAverageBandwidthStatistic

Kotlin |Java

@UnstableApi
public class SlidingWeightedAverageBandwidthStatistic implements BandwidthStatistic

A BandwidthStatistic that calculates estimates based on a sliding window weighted average.

Summary

Nested types
`public class SlidingWeightedAverageBandwidthStatistic.Sample` Represents a bandwidth sample.
`public interface SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction` An interface to decide if samples need to be evicted from the estimator.

Constants
`static final int`	`DEFAULT_MAX_SAMPLES_COUNT = 10` The default maximum number of samples.

Public constructors
`SlidingWeightedAverageBandwidthStatistic()` Creates an instance that keeps up to `DEFAULT_MAX_SAMPLES_COUNT` samples.
`SlidingWeightedAverageBandwidthStatistic( SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction sampleEvictionFunction )` Creates an instance.

Public methods
`void`	`addSample(long bytes, long durationUs)` Adds a transfer sample to the statistic.
`static SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction`	`getAgeBasedEvictionFunction(long maxAgeMs)` Gets a `SampleEvictionFunction` that maintains samples up to `maxAgeMs`.
`long`	`getBandwidthEstimate()` Returns the bandwidth estimate in bits per second, or `ESTIMATE_NOT_AVAILABLE` if there is no estimate available yet.
`static SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction`	`getMaxCountEvictionFunction(long maxSamplesCount)` Gets a `SampleEvictionFunction` that maintains up to `maxSamplesCount` samples.
`void`	`reset()` Resets the statistic.

public static final int DEFAULT_MAX_SAMPLES_COUNT = 10

The default maximum number of samples.

public SlidingWeightedAverageBandwidthStatistic()

Creates an instance that keeps up to DEFAULT_MAX_SAMPLES_COUNT samples.

public SlidingWeightedAverageBandwidthStatistic(
    SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction sampleEvictionFunction
)

Creates an instance.

Parameters
`SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction sampleEvictionFunction`	The `SampleEvictionFunction` deciding whether to drop samples when new samples are added.

public void addSample(long bytes, long durationUs)

Adds a transfer sample to the statistic.

Parameters
`long bytes`	The number of bytes transferred.
`long durationUs`	The duration of the transfer, in microseconds.

public static SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction getAgeBasedEvictionFunction(long maxAgeMs)

Gets a SampleEvictionFunction that maintains samples up to maxAgeMs.

public long getBandwidthEstimate()

Returns the bandwidth estimate in bits per second, or ESTIMATE_NOT_AVAILABLE if there is no estimate available yet.

public static SlidingWeightedAverageBandwidthStatistic.SampleEvictionFunction getMaxCountEvictionFunction(long maxSamplesCount)

Gets a SampleEvictionFunction that maintains up to maxSamplesCount samples.

public void reset()

Resets the statistic. The statistic should drop all samples and reset to its initial state, similar to right after construction.