ea90a2ea0fd6bccae8e53aa9f091daa1f8163363
[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 // See: http://dev.w3.org/2006/webapi/WebTiming/
33 [
34     Conditional=WEB_TIMING,
35     EventTarget,
36 ] interface Performance {
37     readonly attribute PerformanceNavigation navigation;
38     readonly attribute PerformanceTiming timing;
39     readonly attribute MemoryInfo memory;
40
41 #if defined(ENABLE_PERFORMANCE_TIMELINE) && ENABLE_PERFORMANCE_TIMELINE
42     PerformanceEntryList webkitGetEntries();
43     PerformanceEntryList webkitGetEntriesByType(DOMString entryType);
44     PerformanceEntryList webkitGetEntriesByName(DOMString name, [Default=NullString] optional DOMString entryType);
45 #endif
46
47 #if defined(ENABLE_RESOURCE_TIMING) && ENABLE_RESOURCE_TIMING
48     void webkitClearResourceTimings();
49     void webkitSetResourceTimingBufferSize(unsigned long maxSize);
50
51     attribute EventListener onwebkitresourcetimingbufferfull;
52 #endif
53
54     // See http://www.w3.org/TR/2012/CR-user-timing-20120726/
55 #if defined(ENABLE_USER_TIMING) && ENABLE_USER_TIMING
56     void webkitMark(DOMString markName)
57         raises(DOMException);
58     void webkitClearMarks([Default=NullString] optional  DOMString markName);
59
60     void webkitMeasure(DOMString measureName, [Default=NullString] optional DOMString startMark, [Default=NullString] optional DOMString endMark)
61         raises(DOMException);
62     void webkitClearMeasures([Default=NullString] optional DOMString measureName);
63 #endif
64
65     // See http://www.w3.org/TR/hr-time/ for details.
66     double now();
67 };
68