1/*
2 * Copyright (C) 2007, 2018 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#pragma once
27
28#include "Timer.h"
29#include <wtf/Forward.h>
30#include <wtf/HashMap.h>
31#include <wtf/Noncopyable.h>
32#include <wtf/RefPtr.h>
33
34namespace WebCore {
35
36class Frame;
37class ResourceResponse;
38class ProgressTrackerClient;
39struct ProgressItem;
40
41class ProgressTracker {
42 WTF_MAKE_NONCOPYABLE(ProgressTracker); WTF_MAKE_FAST_ALLOCATED;
43public:
44 explicit ProgressTracker(ProgressTrackerClient&);
45 ~ProgressTracker();
46
47 static unsigned long createUniqueIdentifier();
48
49 WEBCORE_EXPORT double estimatedProgress() const;
50
51 void progressStarted(Frame&);
52 void progressCompleted(Frame&);
53
54 void incrementProgress(unsigned long identifier, const ResourceResponse&);
55 void incrementProgress(unsigned long identifier, unsigned bytesReceived);
56 void completeProgress(unsigned long identifier);
57
58 long long totalPageAndResourceBytesToLoad() const { return m_totalPageAndResourceBytesToLoad; }
59 long long totalBytesReceived() const { return m_totalBytesReceived; }
60
61 bool isMainLoadProgressing() const;
62
63private:
64 void reset();
65 void finalProgressComplete();
66
67 void progressHeartbeatTimerFired();
68 bool isAlwaysOnLoggingAllowed() const;
69
70 static unsigned long s_uniqueIdentifier;
71
72 ProgressTrackerClient& m_client;
73 RefPtr<Frame> m_originatingProgressFrame;
74 HashMap<unsigned long, std::unique_ptr<ProgressItem>> m_progressItems;
75 Timer m_progressHeartbeatTimer;
76
77 long long m_totalPageAndResourceBytesToLoad { 0 };
78 long long m_totalBytesReceived { 0 };
79 long long m_totalBytesReceivedBeforePreviousHeartbeat { 0 };
80
81 double m_lastNotifiedProgressValue { 0 };
82 double m_progressValue { 0 };
83
84 MonotonicTime m_mainLoadCompletionTime;
85 MonotonicTime m_lastNotifiedProgressTime;
86
87 int m_numProgressTrackedFrames { 0 };
88 unsigned m_heartbeatsWithNoProgress { 0 };
89
90 bool m_finalProgressChangedSent { false };
91 bool m_isMainLoad { false };
92};
93
94} // namespace WebCore
95