2 * Copyright (C) 2010 Julien Chaffraix <jchaffraix@webkit.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #ifndef XMLHttpRequestProgressEventThrottle_h
28 #define XMLHttpRequestProgressEventThrottle_h
31 #include "wtf/PassRefPtr.h"
32 #include "wtf/Vector.h"
39 enum ProgressEventAction {
40 DoNotFlushProgressEvent,
44 // This implements the XHR2 progress event dispatching: "dispatch a progress event called progress
45 // about every 50ms or for every byte received, whichever is least frequent".
46 class XMLHttpRequestProgressEventThrottle : public TimerBase {
48 XMLHttpRequestProgressEventThrottle(EventTarget*);
49 virtual ~XMLHttpRequestProgressEventThrottle();
51 void dispatchProgressEvent(bool lengthComputable, unsigned long long loaded, unsigned long long total);
52 void dispatchEvent(PassRefPtr<Event>, ProgressEventAction = DoNotFlushProgressEvent);
57 bool suspended() const { return m_suspended; }
60 static const double minimumProgressEventDispatchingIntervalInSeconds;
63 void dispatchPausedEvent();
64 void flushProgressEvent();
66 bool hasEventToDispatch() const;
68 // Weak pointer to our XMLHttpRequest object as it is the one holding us.
69 EventTarget* m_target;
71 bool m_lengthComputable;
72 unsigned long long m_loaded;
73 unsigned long long m_total;
76 RefPtr<Event> m_pausedEvent;
79 } // namespace WebCore
81 #endif // XMLHttpRequestProgressEventThrottle_h