HeapProfiler (DevTools-Selenium 1.2.1 API)

```
public interface HeapProfiler
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addInspectedHeapObject(String heapObjectId)` Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).
`void`	`collectGarbage()`
`void`	`disable()`
`void`	`enable()`
`String`	`getHeapObjectId(String objectId)`
`RemoteObject`	`getObjectByHeapObjectId(String objectId)`
`RemoteObject`	`getObjectByHeapObjectId(String objectId, String objectGroup)`
`SamplingHeapProfile`	`getSamplingProfile()`
`EventListener`	`onAddHeapSnapshotChunk(EventHandler<AddHeapSnapshotChunk> eventListener)`
`EventListener`	`onHeapStatsUpdate(EventHandler<HeapStatsUpdate> eventListener)` If heap objects tracking has been started then backend may send update for one or more fragments
`EventListener`	`onLastSeenObjectId(EventHandler<LastSeenObjectId> eventListener)` If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp.
`EventListener`	`onReportHeapSnapshotProgress(EventHandler<ReportHeapSnapshotProgress> eventListener)`
`EventListener`	`onResetProfiles(EventHandler<ResetProfiles> eventListener)`
`void`	`startSampling()`
`void`	`startSampling(Double samplingInterval)`
`void`	`startTrackingHeapObjects()`
`void`	`startTrackingHeapObjects(Boolean trackAllocations)`
`SamplingHeapProfile`	`stopSampling()`
`void`	`stopTrackingHeapObjects()`
`void`	`stopTrackingHeapObjects(Boolean reportProgress)`
`void`	`takeHeapSnapshot()`
`void`	`takeHeapSnapshot(Boolean reportProgress)`

- Method Detail
  - addInspectedHeapObject
```
void addInspectedHeapObject(String heapObjectId)
```
    Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).
    
    Parameters:
    
    heapObjectId - Heap snapshot object id to be accessible by means of $x command line API.
  - collectGarbage
```
void collectGarbage()
```
  - disable
```
void disable()
```
  - enable
```
void enable()
```
  - getHeapObjectId
```
String getHeapObjectId(String objectId)
```
    Parameters:
    
    objectId - Identifier of the object to get heap object id for.
  - getObjectByHeapObjectId
```
RemoteObject getObjectByHeapObjectId(String objectId)
```
    Parameters:
    
    objectId -
  - getObjectByHeapObjectId
```
RemoteObject getObjectByHeapObjectId(String objectId,
                                     String objectGroup)
```
    Parameters:
    
    objectId -
    
    objectGroup - Symbolic group name that can be used to release multiple objects.
  - getSamplingProfile
```
SamplingHeapProfile getSamplingProfile()
```
  - startSampling
```
void startSampling()
```
  - startSampling
```
void startSampling(Double samplingInterval)
```
    Parameters:
    
    samplingInterval - Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes.
  - startTrackingHeapObjects
```
void startTrackingHeapObjects()
```
  - startTrackingHeapObjects
```
void startTrackingHeapObjects(Boolean trackAllocations)
```
    Parameters:
    
    trackAllocations -
  - stopSampling
```
SamplingHeapProfile stopSampling()
```
  - stopTrackingHeapObjects
```
void stopTrackingHeapObjects()
```
  - stopTrackingHeapObjects
```
void stopTrackingHeapObjects(Boolean reportProgress)
```
    Parameters:
    
    reportProgress - If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped.
  - takeHeapSnapshot
```
void takeHeapSnapshot()
```
  - takeHeapSnapshot
```
void takeHeapSnapshot(Boolean reportProgress)
```
    Parameters:
    
    reportProgress - If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.
  - onAddHeapSnapshotChunk
```
EventListener onAddHeapSnapshotChunk(EventHandler<AddHeapSnapshotChunk> eventListener)
```
  - onHeapStatsUpdate
```
EventListener onHeapStatsUpdate(EventHandler<HeapStatsUpdate> eventListener)
```
    If heap objects tracking has been started then backend may send update for one or more fragments
  - onLastSeenObjectId
```
EventListener onLastSeenObjectId(EventHandler<LastSeenObjectId> eventListener)
```
    If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
  - onReportHeapSnapshotProgress
```
EventListener onReportHeapSnapshotProgress(EventHandler<ReportHeapSnapshotProgress> eventListener)
```
  - onResetProfiles
```
EventListener onResetProfiles(EventHandler<ResetProfiles> eventListener)
```

Interface HeapProfiler

Method Summary

Method Detail

addInspectedHeapObject

collectGarbage

disable

enable

getHeapObjectId

getObjectByHeapObjectId

getObjectByHeapObjectId

getSamplingProfile

startSampling

startSampling

startTrackingHeapObjects

startTrackingHeapObjects

stopSampling

stopTrackingHeapObjects

stopTrackingHeapObjects

takeHeapSnapshot

takeHeapSnapshot

onAddHeapSnapshotChunk

onHeapStatsUpdate

onLastSeenObjectId

onReportHeapSnapshotProgress

onResetProfiles