[Resource Timing] Gather timing information with reliable responseEnd time
[WebKit-https.git] / Source / WebCore / loader / ResourceTiming.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "LoadTiming.h"
29 #include "NetworkLoadMetrics.h"
30 #include "URL.h"
31
32 namespace WebCore {
33
34 class CachedResource;
35 class ResourceResponse;
36 class SecurityOrigin;
37
38 class ResourceTiming {
39     WTF_MAKE_FAST_ALLOCATED;
40 public:
41     static ResourceTiming fromCache(const URL&, const String& initiator, const LoadTiming&);
42     static ResourceTiming fromLoad(CachedResource&, const String& initiator, const LoadTiming&, const NetworkLoadMetrics&, const SecurityOrigin&);
43     static ResourceTiming fromSynchronousLoad(const URL&, const String& initiator, const LoadTiming&, const NetworkLoadMetrics&, const ResourceResponse&, const SecurityOrigin&);
44
45     URL url() const { return m_url; }
46     String initiator() const { return m_initiator; }
47     LoadTiming loadTiming() const { return m_loadTiming; }
48     NetworkLoadMetrics networkLoadMetrics() const { return m_networkLoadMetrics; }
49     bool allowTimingDetails() const { return m_allowTimingDetails; }
50
51     ResourceTiming isolatedCopy() const;
52
53     void overrideInitiatorName(const String& name) { m_initiator = name; }
54
55 private:
56     ResourceTiming(CachedResource&, const String& initiator, const LoadTiming&, const NetworkLoadMetrics&, const SecurityOrigin&);
57     ResourceTiming(const URL&, const String& initiator, const LoadTiming&, const NetworkLoadMetrics&, const ResourceResponse&, const SecurityOrigin&);
58     ResourceTiming(const URL&, const String& initiator, const LoadTiming&);
59     ResourceTiming(const URL& url, const String& initiator, const LoadTiming& loadTiming, const NetworkLoadMetrics& networkLoadMetrics, bool allowTimingDetails)
60         : m_url(url)
61         , m_initiator(initiator)
62         , m_loadTiming(loadTiming)
63         , m_networkLoadMetrics(networkLoadMetrics)
64         , m_allowTimingDetails(allowTimingDetails)
65     {
66     }
67
68     URL m_url;
69     String m_initiator;
70     LoadTiming m_loadTiming;
71     NetworkLoadMetrics m_networkLoadMetrics;
72     bool m_allowTimingDetails { false };
73 };
74
75 } // namespace WebCore