com.facebook.battery.metrics.cpu

Class CpuMetricsCollector

java.lang.Object

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

com.facebook.battery.metrics.cpu.CpuMetricsCollector

public class CpuMetricsCollector
extends SystemMetricsCollector<CpuMetrics>

Collects data about cpu metrics.

This data is read from /proc/<pid>/stat -- see the corresponding man page for details.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DEFAULT_CLOCK_TICKS_PER_SECOND

Constructor Summary

Constructors

Constructor and Description
CpuMetricsCollector()

Method Summary

Modifier and Type	Method and Description
CpuMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
boolean	getSnapshot(CpuMetrics snapshot) Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.
protected java.lang.String	readProcFile()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLOCK_TICKS_PER_SECOND

protected static final long DEFAULT_CLOCK_TICKS_PER_SECOND

See Also:

Constant Field Values

Constructor Detail

CpuMetricsCollector

public CpuMetricsCollector()

Method Detail

getSnapshot

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

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

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

Returns:

New System Metrics object

readProcFile

@Nullable
protected java.lang.String readProcFile()