SlidingPercentileBandwidthStatistic

Kotlin |Java

@UnstableApi
class SlidingPercentileBandwidthStatistic : BandwidthStatistic

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

Summary

Constants
`const Int`	`DEFAULT_MAX_SAMPLES_COUNT = 10` The default maximum number of samples.
`const Double`	`DEFAULT_PERCENTILE = 0.5` The default percentile to return.

Public constructors
`SlidingPercentileBandwidthStatistic()` Creates an instance with a maximum of `DEFAULT_MAX_SAMPLES_COUNT` samples, returning the `DEFAULT_PERCENTILE`.
`SlidingPercentileBandwidthStatistic( maxSampleCount: Int, percentile: Double )` Creates an instance.

Public functions
`Unit`	`addSample(bytes: Long, durationUs: Long)` Adds a transfer sample to the statistic.
`Long`	`getBandwidthEstimate()` Returns the bandwidth estimate in bits per second, or `ESTIMATE_NOT_AVAILABLE` if there is no estimate available yet.
`Unit`	`reset()` Resets the statistic.

const val DEFAULT_MAX_SAMPLES_COUNT = 10: Int

The default maximum number of samples.

const val DEFAULT_PERCENTILE = 0.5: Double

The default percentile to return.

SlidingPercentileBandwidthStatistic()

Creates an instance with a maximum of DEFAULT_MAX_SAMPLES_COUNT samples, returning the DEFAULT_PERCENTILE.

SlidingPercentileBandwidthStatistic(
    maxSampleCount: Int,
    percentile: Double
)

Creates an instance.

Parameters
`maxSampleCount: Int`	The maximum number of samples.
`percentile: Double`	The percentile to return. Must be in the range of [0-1].

fun addSample(bytes: Long, durationUs: Long): Unit

Adds a transfer sample to the statistic.

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

fun getBandwidthEstimate(): Long

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

fun reset(): Unit

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