Package Torello.Browser

Class HeapProfiler

java.lang.Object

Torello.Browser.HeapProfiler

public class HeapProfiler
extends java.lang.Object

Class created by Automatic Code-Generator.
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

JSON-Viewable Google-API:
These files may be viewed here: browser_protocol.json and js_protocol.json.
These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

HTML-Viewable API:
In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

Node.js RDP-API Implementation:
You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM

[No Description Provided by Google]

This class is intended to be used with a Headless Browser

These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

Foreign Function API:
Every one of the methods that reside in this class are designed to do nothing more than:

1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object

Java-HTML Difference:
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".

Hi-Lited Source-Code:

• View Here: Torello/Browser/HeapProfiler.java
• Open New Browser-Tab: Torello/Browser/HeapProfiler.java

File Size: 47,520 Bytes Line Count: 1,184 '\n' Characters Found

Stateless Class:

This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

• 1 Constructor(s), 1 declared private, zero-argument constructor
• 12 Method(s), 12 declared static
• 5 Field(s), 5 declared static, 4 declared final
• Fields excused from final modifier (with explanation):

  Field 'counter' is not final.

  Reason: CONFIGURATION

Nested Class Summary

Type Classes: HeapProfiler Domain Types
Modifier and Type	Inner-Class
static class	HeapProfiler.SamplingHeapProfile	Sampling profile.
static class	HeapProfiler.SamplingHeapProfileNode	Sampling Heap Profile node.
static class	HeapProfiler.SamplingHeapProfileSample	A single sample from a sampling profile.
Event Classes: HeapProfiler Domain Events
Modifier and Type	Inner-Class
static class	HeapProfiler.addHeapSnapshotChunk	[No Description Provided by Google]
static class	HeapProfiler.heapStatsUpdate	If heap objects tracking has been started then backend may send update for one or more fragments
static class	HeapProfiler.lastSeenObjectId	If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp.
static class	HeapProfiler.reportHeapSnapshotProgress	[No Description Provided by Google]
static class	HeapProfiler.resetProfiles	- This is Marker-Event.

Method Summary

HeapProfiler Domain Commands
Script Returns	Modifier and Type	Method
NONE (void)	static Script<>	addInspectedHeapObject(String heapObjectId) Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).
NONE (void)	static Script<>	collectGarbage() [No Description Provided by Google]
NONE (void)	static Script<>	disable() [No Description Provided by Google]
NONE (void)	static Script<>	enable() [No Description Provided by Google]
String	static Script<>	getHeapObjectId(String objectId) [No Description Provided by Google]
RunTime.RemoteObject	static Script<>	getObjectByHeapObjectId(String objectId, String objectGroup) [No Description Provided by Google]
HeapProfiler.SamplingHeapProfile	static Script<>	getSamplingProfile() [No Description Provided by Google]
NONE (void)	static Script<>	startSampling(Number samplingInterval) [No Description Provided by Google]
NONE (void)	static Script<>	startTrackingHeapObjects(Boolean trackAllocations) [No Description Provided by Google]
HeapProfiler.SamplingHeapProfile	static Script<>	stopSampling() [No Description Provided by Google]
NONE (void)	static Script<>	stopTrackingHeapObjects(Boolean reportProgress, Boolean treatGlobalObjectsAsRoots, Boolean captureNumericValue) [No Description Provided by Google]
NONE (void)	static Script<>	takeHeapSnapshot(Boolean reportProgress, Boolean treatGlobalObjectsAsRoots, Boolean captureNumericValue) [No Description Provided by Google]

Methods inherited from class java.lang.Object

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

Method Detail

addInspectedHeapObject

🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> addInspectedHeapObject
            (java.lang.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.

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

collectGarbage

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> collectGarbage()

[No Description Provided by Google]

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

disable

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> disable()

[No Description Provided by Google]

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

enable

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> enable()

[No Description Provided by Google]

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

getHeapObjectId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,java.lang.String> getHeapObjectId
            (java.lang.String objectId)

[No Description Provided by Google]

Parameters:

objectId - Identifier of the object to get heap object id for.

Returns:

An instance of Script<String, JsonObject, String>

This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, String> will be returned.

Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

This Browser Function returns

• String (heapSnapshotObjectId)
  Id of the heap snapshot object corresponding to the passed remote object id.

getObjectByHeapObjectId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,RunTime.RemoteObject> getObjectByHeapObjectId
            (java.lang.String objectId,
             java.lang.String objectGroup)

[No Description Provided by Google]

Parameters:

objectId - -

objectGroup - Symbolic group name that can be used to release multiple objects.
OPTIONAL

Returns:

An instance of Script<String, JsonObject, RunTime.RemoteObject>

This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, RunTime.RemoteObject> will be returned.

Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

This Browser Function returns

• RunTime.RemoteObject (result)
  Evaluation result.

getSamplingProfile

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,HeapProfiler.SamplingHeapProfile> getSamplingProfile
            ()

[No Description Provided by Google]

Returns:

An instance of Script<String, JsonObject, HeapProfiler.SamplingHeapProfile>

This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, HeapProfiler.SamplingHeapProfile> will be returned.

Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

This Browser Function returns

• HeapProfiler.SamplingHeapProfile (profile)
  Return the sampling profile being collected.

startSampling

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> startSampling
            (java.lang.Number samplingInterval)

[No Description Provided by Google]

Parameters:

samplingInterval - Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes.
OPTIONAL

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

startTrackingHeapObjects

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> startTrackingHeapObjects
            (java.lang.Boolean trackAllocations)

[No Description Provided by Google]

Parameters:

trackAllocations - -
OPTIONAL

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

stopSampling

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,HeapProfiler.SamplingHeapProfile> stopSampling
            ()

[No Description Provided by Google]

Returns:

An instance of Script<String, JsonObject, HeapProfiler.SamplingHeapProfile>

This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, HeapProfiler.SamplingHeapProfile> will be returned.

Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

This Browser Function returns

• HeapProfiler.SamplingHeapProfile (profile)
  Recorded sampling heap profile.

stopTrackingHeapObjects

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> stopTrackingHeapObjects
            (java.lang.Boolean reportProgress,
             java.lang.Boolean treatGlobalObjectsAsRoots,
             java.lang.Boolean captureNumericValue)

[No Description Provided by Google]

Parameters:

reportProgress - If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped.
OPTIONAL

treatGlobalObjectsAsRoots - -
OPTIONAL

captureNumericValue - If true, numerical values are included in the snapshot
OPTIONAL

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

takeHeapSnapshot

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> takeHeapSnapshot
            (java.lang.Boolean reportProgress,
             java.lang.Boolean treatGlobalObjectsAsRoots,
             java.lang.Boolean captureNumericValue)

[No Description Provided by Google]

Parameters:

reportProgress - If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.
OPTIONAL

treatGlobalObjectsAsRoots - If true, a raw snapshot without artificial roots will be generated
OPTIONAL

captureNumericValue - If true, numerical values are included in the snapshot
OPTIONAL

Returns:

An instance of Script<String, JsonObject, Ret0>

This Script instance must be executed before the browser receives the invocation-request.

This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.