Share code to normalize an HTTP method
[WebKit-https.git] / Source / WebCore / xml / XMLHttpRequestProgressEventThrottle.h
1 /*
2  * Copyright (C) 2010 Julien Chaffraix <jchaffraix@webkit.org>
3  * All right reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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.
25  */
26
27 #pragma once
28
29 #include "Timer.h"
30 #include <wtf/Forward.h>
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class Event;
36 class EventTarget;
37
38 enum ProgressEventAction {
39     DoNotFlushProgressEvent,
40     FlushProgressEvent
41 };
42
43 // This implements the XHR2 progress event dispatching: "dispatch a progress event called progress
44 // about every 50ms or for every byte received, whichever is least frequent".
45 class XMLHttpRequestProgressEventThrottle : public TimerBase {
46 public:
47     explicit XMLHttpRequestProgressEventThrottle(EventTarget*);
48     virtual ~XMLHttpRequestProgressEventThrottle();
49
50     void dispatchThrottledProgressEvent(bool lengthComputable, unsigned long long loaded, unsigned long long total);
51     void dispatchReadyStateChangeEvent(Event&, ProgressEventAction = DoNotFlushProgressEvent);
52     void dispatchProgressEvent(const AtomicString&);
53
54     void suspend();
55     void resume();
56
57 private:
58     static const Seconds minimumProgressEventDispatchingInterval;
59
60     void fired() override;
61     void dispatchDeferredEvents();
62     void flushProgressEvent();
63     void dispatchEvent(Event&);
64
65     bool hasEventToDispatch() const;
66
67     // Weak pointer to our XMLHttpRequest object as it is the one holding us.
68     EventTarget* m_target;
69
70     bool m_hasThrottledProgressEvent;
71     bool m_lengthComputable;
72     unsigned long long m_loaded;
73     unsigned long long m_total;
74
75     bool m_deferEvents;
76     RefPtr<Event> m_deferredProgressEvent;
77     Vector<Ref<Event>> m_deferredEvents;
78     Timer m_dispatchDeferredEventsTimer;
79 };
80
81 } // namespace WebCore