PercentileTimeToFirstByteEstimator

Kotlin |Java

@UnstableApi
class PercentileTimeToFirstByteEstimator : TimeToFirstByteEstimator

Implementation of TimeToFirstByteEstimator that returns a configured percentile of a sliding window of collected response times.

Summary

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

Public constructors
`PercentileTimeToFirstByteEstimator()` Creates an instance that keeps up to `DEFAULT_MAX_SAMPLES_COUNT` samples and returns the `DEFAULT_PERCENTILE` percentile.
`PercentileTimeToFirstByteEstimator( numberOfSamples: Int, percentile: Float )` Creates an instance.

Public functions
`Long`	`getTimeToFirstByteEstimateUs()` Returns the estimated time to first byte of the response body, in microseconds, or `TIME_UNSET` if no estimate is available.
`Unit`	`onTransferInitializing(dataSpec: DataSpec!)` Called when a transfer is being initialized.
`Unit`	`onTransferStart(dataSpec: DataSpec!)` Called when a transfer starts.
`Unit`	`reset()` Resets the estimator.

const val DEFAULT_MAX_SAMPLES_COUNT = 10: Int

The default maximum number of samples.

const val DEFAULT_PERCENTILE = 0.5f: Float

The default percentile to return.

PercentileTimeToFirstByteEstimator()

Creates an instance that keeps up to DEFAULT_MAX_SAMPLES_COUNT samples and returns the DEFAULT_PERCENTILE percentile.

PercentileTimeToFirstByteEstimator(
    numberOfSamples: Int,
    percentile: Float
)

Creates an instance.

Parameters
`numberOfSamples: Int`	The maximum number of samples to be kept in the sliding window.
`percentile: Float`	The percentile for estimating the time to the first byte.

fun getTimeToFirstByteEstimateUs(): Long

Returns the estimated time to first byte of the response body, in microseconds, or TIME_UNSET if no estimate is available.

fun onTransferInitializing(dataSpec: DataSpec!): Unit

Called when a transfer is being initialized.

Parameters
`dataSpec: DataSpec!`	Describes the data for which the transfer is initialized.

fun onTransferStart(dataSpec: DataSpec!): Unit

Called when a transfer starts.

Parameters
`dataSpec: DataSpec!`	Describes the data being transferred.

fun reset(): Unit

Resets the estimator.