com.facebook.battery.metrics.bluetooth

Class BluetoothMetricsCollector

java.lang.Object

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

com.facebook.battery.metrics.bluetooth.BluetoothMetricsCollector

public class BluetoothMetricsCollector
extends SystemMetricsCollector<BluetoothMetrics>

A box of values for recording all bluetooth scans; requires custom instrumentation. Trigger with addScan(long) to record a bluetooth scan.

Constructor Summary

Constructors

Constructor and Description
BluetoothMetricsCollector()

Method Summary

Modifier and Type	Method and Description
void	addScan(long durationMs) Record a bluetooth scan with the duration it ran for.
BluetoothMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
boolean	getSnapshot(BluetoothMetrics snapshot) Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.

Methods inherited from class java.lang.Object

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

Constructor Detail

BluetoothMetricsCollector

public BluetoothMetricsCollector()

Method Detail

getSnapshot

public boolean getSnapshot(BluetoothMetrics 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<BluetoothMetrics>

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

public BluetoothMetrics 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<BluetoothMetrics>

Returns:

New System Metrics object

addScan

public void addScan(long durationMs)

Record a bluetooth scan with the duration it ran for.