diff options
Diffstat (limited to 'WebCore/xml/XMLHttpRequestProgressEventThrottle.h')
-rw-r--r-- | WebCore/xml/XMLHttpRequestProgressEventThrottle.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/WebCore/xml/XMLHttpRequestProgressEventThrottle.h b/WebCore/xml/XMLHttpRequestProgressEventThrottle.h new file mode 100644 index 0000000..f51aea1 --- /dev/null +++ b/WebCore/xml/XMLHttpRequestProgressEventThrottle.h @@ -0,0 +1,81 @@ +/* + * 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 "Timer.h" +#include "wtf/PassRefPtr.h" +#include "wtf/Vector.h" + +namespace WebCore { + +class Event; +class EventTarget; + +enum ProgressEventAction { + DoNotFlushProgressEvent, + FlushProgressEvent +}; + +// This implements the XHR2 progress event dispatching: "dispatch a progress event called progress +// about every 50ms or for every byte received, whichever is least frequent". +class XMLHttpRequestProgressEventThrottle : public TimerBase { +public: + XMLHttpRequestProgressEventThrottle(EventTarget*); + virtual ~XMLHttpRequestProgressEventThrottle(); + + void dispatchProgressEvent(bool lengthComputable, unsigned loaded, unsigned total); + void dispatchEvent(PassRefPtr<Event>, ProgressEventAction = DoNotFlushProgressEvent); + + void suspend(); + void resume(); + + bool suspended() const { return m_suspended; } + +private: + static const double minimumProgressEventDispatchingIntervalInSeconds; + + virtual void fired(); + void dispatchPausedEvent(); + void flushProgressEvent(); + + bool hasEventToDispatch() const; + + // Weak pointer to our XMLHttpRequest object as it is the one holding us. + EventTarget* m_target; + + bool m_lengthComputable; + unsigned m_loaded; + unsigned m_total; + + bool m_suspended; + RefPtr<Event> m_pausedEvent; +}; + +} // namespace WebCore + +#endif // XMLHttpRequestProgressEventThrottle_h |