1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*
* Copyright (C) 2010 Julien Chaffraix <jchaffraix@webkit.org>
* All right reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef XMLHttpRequestProgressEventThrottle_h
#define XMLHttpRequestProgressEventThrottle_h
#include "platform/Timer.h"
#include "platform/heap/Handle.h"
#include "wtf/Forward.h"
#include "wtf/PassRefPtr.h"
namespace blink {
class Event;
class XMLHttpRequest;
// This class implements the XHR2 ProgressEvent dispatching:
// "dispatch a progress event named progress about every 50ms or for every
// byte received, whichever is least frequent".
//
// readystatechange events also go through this class since ProgressEvents and
// readystatechange events affect each other.
//
// In the comments for this class:
// - "progress" event means an event named "progress"
// - ProgressEvent means an event using the ProgressEvent interface defined in
// the spec.
class XMLHttpRequestProgressEventThrottle final
: public GarbageCollectedFinalized<XMLHttpRequestProgressEventThrottle>,
public TimerBase {
public:
static XMLHttpRequestProgressEventThrottle* create(
XMLHttpRequest* eventTarget) {
return new XMLHttpRequestProgressEventThrottle(eventTarget);
}
~XMLHttpRequestProgressEventThrottle() override;
enum DeferredEventAction {
Ignore,
Clear,
Flush,
};
// Dispatches a ProgressEvent.
//
// Special treatment for events named "progress" is implemented to dispatch
// them at the required frequency. If this object is suspended, the given
// ProgressEvent overwrites the existing. I.e. only the latest one gets
// queued. If the timer is running, this method just updates
// m_lengthComputable, m_loaded and m_total. They'll be used on next
// fired() call.
// For an event named "progress", a readyStateChange will be dispatched
// as well.
void dispatchProgressEvent(const AtomicString&,
bool lengthComputable,
unsigned long long loaded,
unsigned long long total);
// Dispatches the given event after operation about the "progress" event
// depending on the value of the ProgressEventAction argument.
void dispatchReadyStateChangeEvent(Event*, DeferredEventAction);
void suspend();
void resume();
// Need to promptly stop this timer when it is deemed finalizable.
EAGERLY_FINALIZE();
DECLARE_TRACE();
private:
explicit XMLHttpRequestProgressEventThrottle(XMLHttpRequest*);
// Dispatches a "progress" progress event and usually a readyStateChange
// event as well.
void dispatchProgressProgressEvent(Event*);
// The main purpose of this class is to throttle the "progress"
// ProgressEvent dispatching. This class represents such a deferred
// "progress" ProgressEvent.
class DeferredEvent {
public:
DeferredEvent();
void set(bool lengthComputable,
unsigned long long loaded,
unsigned long long total);
void clear();
bool isSet() const { return m_isSet; }
Event* take();
private:
unsigned long long m_loaded;
unsigned long long m_total;
bool m_lengthComputable;
bool m_isSet;
};
void fired() override;
Member<XMLHttpRequest> m_target;
// A slot for the deferred "progress" ProgressEvent. When multiple events
// arrive, only the last one is stored and others are discarded.
DeferredEvent m_deferred;
// True if any "progress" progress event has been dispatched since
// |m_target|'s readyState changed.
bool m_hasDispatchedProgressProgressEvent;
};
} // namespace blink
#endif // XMLHttpRequestProgressEventThrottle_h
|
