public class PerformanceTimeline extends java.lang.ObjectClass created by
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.
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.
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
You may read about the
Node.js Chrome Remote Interfaceon the Node.js Package Manager Web-Site: NPM
Reporting of performance timeline events, as specified in https://w3c.github.io/performance-timeline/#dom-performanceobserver.
This class is intended to be used with a Headless BrowserThese 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:
- Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
- Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
- Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
- Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
- Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object
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".
Stateless Class:This class neither contains any program-state, nor can it be instantiated. The
@StaticFunctionalAnnotation may also be called 'The Spaghetti Report'.
Static-Functionalclasses are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 1 Method(s), 1 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: PerformanceTimeline Domain Types Modifier and Type Inner-Class
PerformanceTimeline.LargestContentfulPaintSee https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl
PerformanceTimeline.LayoutShiftSee https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl
[No Description Provided by Google]
[No Description Provided by Google]
Event Classes: PerformanceTimeline Domain Events Modifier and Type Inner-Class
PerformanceTimeline.timelineEventAddedSent when a performance timeline event is added.
PerformanceTimeline Domain Commands Script Returns Modifier and Type Method NONE (
Previously buffered events would be reported before method returns.
public static Script<java.lang.String,JsonObject,Ret0> enable (java.lang.String eventTypes)Previously buffered events would be reported before method returns. See also: timelineEventAdded
eventTypes- The types of event to report, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype The specified filter overrides any previous filters, passing empty filter disables recording. Note that not all types exposed to the web platform are currently supported.
- An instance of
Scriptinstance 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
>to ensure the Browser Function has run to completion.