WebProgressTracker updates progress too frequently
[WebKit-https.git] / Source / WebCore / loader / ProgressTracker.h
1 /*
2  * Copyright (C) 2007 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ProgressTracker_h
27 #define ProgressTracker_h
28
29 #include "Timer.h"
30 #include <chrono>
31 #include <wtf/Forward.h>
32 #include <wtf/HashMap.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/RefPtr.h>
35
36 namespace WebCore {
37
38 class Frame;
39 class ResourceResponse;
40 class ProgressTrackerClient;
41 struct ProgressItem;
42
43 class ProgressTracker {
44     WTF_MAKE_NONCOPYABLE(ProgressTracker); WTF_MAKE_FAST_ALLOCATED;
45 public:
46     explicit ProgressTracker(ProgressTrackerClient&);
47     ~ProgressTracker();
48
49     static unsigned long createUniqueIdentifier();
50
51     double estimatedProgress() const;
52
53     void progressStarted(Frame&);
54     void progressCompleted(Frame&);
55     
56     void incrementProgress(unsigned long identifier, const ResourceResponse&);
57     void incrementProgress(unsigned long identifier, unsigned bytesReceived);
58     void completeProgress(unsigned long identifier);
59
60     long long totalPageAndResourceBytesToLoad() const { return m_totalPageAndResourceBytesToLoad; }
61     long long totalBytesReceived() const { return m_totalBytesReceived; }
62
63     bool isMainLoadProgressing() const;
64
65 private:
66     void reset();
67     void finalProgressComplete();
68
69     void progressHeartbeatTimerFired(Timer<ProgressTracker>&);
70     
71     static unsigned long s_uniqueIdentifier;
72     
73     ProgressTrackerClient& m_client;
74     long long m_totalPageAndResourceBytesToLoad;
75     long long m_totalBytesReceived;
76     double m_lastNotifiedProgressValue;
77     std::chrono::steady_clock::time_point m_lastNotifiedProgressTime;
78     bool m_finalProgressChangedSent;    
79     double m_progressValue;
80     RefPtr<Frame> m_originatingProgressFrame;
81     
82     int m_numProgressTrackedFrames;
83     HashMap<unsigned long, std::unique_ptr<ProgressItem>> m_progressItems;
84
85     Timer<ProgressTracker> m_progressHeartbeatTimer;
86     unsigned m_heartbeatsWithNoProgress;
87     long long m_totalBytesReceivedBeforePreviousHeartbeat;
88     std::chrono::steady_clock::time_point m_mainLoadCompletionTime;
89     bool m_isMainLoad;
90 };
91     
92 }
93
94 #endif