com.facebook.battery.metrics.network

Class RadioStateCollector

java.lang.Object

com.facebook.battery.metrics.api.SystemMetricsCollector<RadioStateMetrics>

com.facebook.battery.metrics.network.RadioStateCollector

public class RadioStateCollector
extends SystemMetricsCollector<RadioStateMetrics>

Collector that allows to obtain info about Radio up time by network type(MOBILE and WIFI).

When sending or receiving data, the RadioStateCollector should be then notified to ensure Radio state estimations are computed correctly.

Depending on the type of Active Network the Collector will attempt to estimate when Radio turns On and Off taking care of eventual tail time. The latter is the amount of time Radio might be kept active to preserve battery consumption and reduce latency of transition.

Constructor Summary

Constructors

Constructor and Description
RadioStateCollector(Context context)

Method Summary

Modifier and Type	Method and Description
RadioStateMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
boolean	getSnapshot(RadioStateMetrics snapshot) Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.
void	onRadioActive(long startTimeMs, long endTimeMs)
void	onRadioActiveNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RadioStateCollector

public RadioStateCollector(Context context)

Method Detail

getSnapshot

public boolean getSnapshot(RadioStateMetrics snapshot)

Description copied from class: SystemMetricsCollector

Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.

Specified by:

getSnapshot in class SystemMetricsCollector<RadioStateMetrics>

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

public RadioStateMetrics createMetrics()

Description copied from class: SystemMetricsCollector

Creates an empty instance of the corresponding system metrics.

Explicitly having this function available reduces a significant amount of boilerplate

Specified by:

createMetrics in class SystemMetricsCollector<RadioStateMetrics>

Returns:

New System Metrics object

onRadioActiveNow

public void onRadioActiveNow()

onRadioActive

public void onRadioActive(long startTimeMs,
                          long endTimeMs)