java.lang.Object
- Torello.Browser.Memory

```
public class Memory
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/Memory.java
- Open New Browser-Tab: Torello/Browser/Memory.java
File Size: 31,422 Bytes Line Count: 767 '\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
- 10 Method(s), 10 declared static
- 6 Field(s), 6 declared static, 5 declared final
- Fields excused from final modifier (with explanation):
  
  Field 'counter' is not final. Reason: CONFIGURATION

Nested Class Summary

Type Classes: Memory Domain Types

Modifier and Type	Inner-Class
`static class`	`Memory.Module`	Executable module information
`static class`	`Memory.SamplingProfile`	Array of heap profile samples.
`static class`	`Memory.SamplingProfileNode`	Heap profile sample.

Field Summary

Memory Domain Enumerated String Types

Modifier and Type Field

static String[] PressureLevel
Memory pressure level.

Method Summary

Memory Domain Commands

Script Returns	Modifier and Type	Method
NONE (`void`)	`static Script<>`	`forciblyPurgeJavaScriptMemory()` Simulate OomIntervention by purging V8 memory.
`Memory.SamplingProfile`	`static Script<>`	`getAllTimeSamplingProfile()` Retrieve native memory allocations profile collected since renderer process startup.
`Memory.SamplingProfile`	`static Script<>`	`getBrowserSamplingProfile()` Retrieve native memory allocations profile collected since browser process startup.
`Ret3<Integer, Integer, Integer>`	`static Script<>`	`getDOMCounters()` `[No Description Provided by Google]`
`Memory.SamplingProfile`	`static Script<>`	`getSamplingProfile()` Retrieve native memory allocations profile collected since last `startSampling` call.
NONE (`void`)	`static Script<>`	`prepareForLeakDetection()` `[No Description Provided by Google]`
NONE (`void`)	`static Script<>`	`setPressureNotificationsSuppressed(boolean suppressed)` Enable/disable suppressing memory pressure notifications in all processes.
NONE (`void`)	`static Script<>`	`simulatePressureNotification(String level)` Simulate a memory pressure notification in all processes.
NONE (`void`)	`static Script<>`	`startSampling(Integer samplingInterval, Boolean suppressRandomness)` Start collecting native memory profile.
NONE (`void`)	`static Script<>`	`stopSampling()` Stop collecting native memory profile.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PressureLevel
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static final java.lang.String[] PressureLevel
    
    Memory pressure level.
- Method Detail
  - getDOMCounters
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret3<java.lang.Integer,java.lang.Integer,java.lang.Integer>> getDOMCounters ()
    
    [No Description Provided by Google]
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret3>
    
    This Script may be executed (using Script.exec()), and a Promise returned.
    
    When the Promise is awaited (using Promise.await()), the Ret3 will subsequently be returned from that call.
    
    The returned values are encapsulated in an instance of Ret3
    
    Ret3.a: Integer (documents)
    -
    
    Ret3.b: Integer (nodes)
    -
    
    Ret3.c: Integer (jsEventListeners)
    -
  - prepareForLeakDetection
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> prepareForLeakDetection ()
    
    [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.
  - forciblyPurgeJavaScriptMemory
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> forciblyPurgeJavaScriptMemory ()
    
    Simulate OomIntervention by purging V8 memory.
    
    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.
  - setPressureNotificationsSuppressed
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> setPressureNotificationsSuppressed (boolean suppressed)
    
    Enable/disable suppressing memory pressure notifications in all processes.
    
    Parameters:
    
    suppressed - If true, memory pressure notifications will be suppressed.
    
    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.
  - simulatePressureNotification
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> simulatePressureNotification (java.lang.String level)
    
    Simulate a memory pressure notification in all processes.
    
    Parameters:
    
    level - Memory pressure level of the notification.
    
    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.
  - startSampling
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> startSampling (java.lang.Integer samplingInterval, java.lang.Boolean suppressRandomness)
    
    Start collecting native memory profile.
    
    Parameters:
    
    samplingInterval - Average number of bytes between samples.
    OPTIONAL
    
    suppressRandomness - Do not randomize intervals between samples.
    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,Ret0> stopSampling()
    
    Stop collecting native memory profile.
    
    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.
  - getAllTimeSamplingProfile
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Memory.SamplingProfile> getAllTimeSamplingProfile ()
    
    Retrieve native memory allocations profile collected since renderer process startup.
    
    Returns:
    
    An instance of Script<String, JsonObject, Memory.SamplingProfile>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Memory.SamplingProfile> 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
    
    Memory.SamplingProfile (profile)
    -
  - getBrowserSamplingProfile
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Memory.SamplingProfile> getBrowserSamplingProfile ()
    
    Retrieve native memory allocations profile collected since browser process startup.
    
    Returns:
    
    An instance of Script<String, JsonObject, Memory.SamplingProfile>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Memory.SamplingProfile> 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
    
    Memory.SamplingProfile (profile)
    -
  - getSamplingProfile
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Memory.SamplingProfile> getSamplingProfile ()
    
    Retrieve native memory allocations profile collected since last startSampling call.
    
    Returns:
    
    An instance of Script<String, JsonObject, Memory.SamplingProfile>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Memory.SamplingProfile> 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
    
    Memory.SamplingProfile (profile)
    -

Memory Domain Enumerated String Types

Modifier and Type	Field
`static String[]`	`PressureLevel`	Memory pressure level.

Fields
String[]	PressureLevel
Methods
Script	forciblyPurgeJavaScriptMemory()
Script	getAllTimeSamplingProfile()
Script	getBrowserSamplingProfile()
Script	getDOMCounters()
Script	getSamplingProfile()
Script	prepareForLeakDetection()
Script	setPressureNotificationsSuppressed(boolean suppressed)
Script	simulatePressureNotification(String level)
Script	startSampling(Integer samplingInterval, Boolean suppressRandomness)
Script	stopSampling()

Class Memory

This class is intended to be used with a Headless Browser

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PressureLevel

Method Detail

getDOMCounters

prepareForLeakDetection

forciblyPurgeJavaScriptMemory

setPressureNotificationsSuppressed

simulatePressureNotification

startSampling

stopSampling

getAllTimeSamplingProfile

getBrowserSamplingProfile

getSamplingProfile