c655e4a07b9ccb8acc2d4abf853c5f52c6fa7d94
[WebKit-https.git] / Source / WebCore / page / Performance.idl
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2012 Intel Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 // https://w3c.github.io/hr-time/
33
34 typedef double DOMHighResTimeStamp;
35
36 [
37     Exposed=(Window,Worker),
38     GenerateIsReachable=ImplScriptExecutionContext,
39 ] interface Performance : EventTarget {
40     DOMHighResTimeStamp now();
41     // FIXME: Implement 'timeOrigin' - https://webkit.org/b/174862
42     // readonly attribute DOMHighResTimeStamp timeOrigin;
43     [Default] object toJSON();
44
45     // https://w3c.github.io/navigation-timing/#extensions-to-the-performance-interface
46     readonly attribute PerformanceNavigation navigation;
47     readonly attribute PerformanceTiming timing;
48
49     // https://w3c.github.io/performance-timeline/#extensions-to-the-performance-interface
50     PerformanceEntryList getEntries();
51     PerformanceEntryList getEntriesByType(DOMString entryType);
52     PerformanceEntryList getEntriesByName(DOMString name, optional DOMString entryType);
53
54     // https://w3c.github.io/resource-timing/#sec-extensions-performance-interface
55     undefined clearResourceTimings();
56     undefined setResourceTimingBufferSize(unsigned long maxSize);
57     attribute EventHandler onresourcetimingbufferfull;
58
59     // https://w3c.github.io/user-timing/#extensions-performance-interface
60     // FIXME: 'mark' should return a PerformanceMark.
61     [MayThrowException] undefined mark(DOMString markName);
62     undefined clearMarks(optional DOMString markName);
63     // FIXME: 'measure' should return a PerformanceMeasure.
64     [MayThrowException] undefined measure(DOMString measureName, optional DOMString startMark, optional DOMString endMark);
65     undefined clearMeasures(optional DOMString measureName);
66 };
67
68 typedef sequence<PerformanceEntry> PerformanceEntryList;