Home | History | Annotate | Download | only in xml 
      1 /*
      2  * Copyright (C) 2010 Julien Chaffraix <jchaffraix (at) 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 #ifndef XMLHttpRequestProgressEventThrottle_h
     28 #define XMLHttpRequestProgressEventThrottle_h
     29 
     30 #include "platform/Timer.h"
     31 #include "wtf/PassRefPtr.h"
     32 #include "wtf/Vector.h"
     33 #include "wtf/text/AtomicString.h"
     34 
     35 namespace WebCore {
     36 
     37 class Event;
     38 class EventTarget;
     39 
     40 enum ProgressEventAction {
     41     DoNotFlushProgressEvent,
     42     FlushDeferredProgressEvent,
     43     FlushProgressEvent
     44 };
     45 
     46 // This implements the XHR2 progress event dispatching: "dispatch a progress event called progress
     47 // about every 50ms or for every byte received, whichever is least frequent".
     48 class XMLHttpRequestProgressEventThrottle : public TimerBase {
     49 public:
     50     explicit XMLHttpRequestProgressEventThrottle(EventTarget*);
     51     virtual ~XMLHttpRequestProgressEventThrottle();
     52 
     53     void dispatchProgressEvent(bool lengthComputable, unsigned long long loaded, unsigned long long total);
     54     void dispatchReadyStateChangeEvent(PassRefPtr<Event>, ProgressEventAction = DoNotFlushProgressEvent);
     55     void dispatchEvent(PassRefPtr<Event>);
     56     void dispatchEventAndLoadEnd(const AtomicString&, bool, unsigned long long, unsigned long long);
     57 
     58     void suspend();
     59     void resume();
     60 
     61 private:
     62     static const double minimumProgressEventDispatchingIntervalInSeconds;
     63 
     64     virtual void fired();
     65     void dispatchDeferredEvents(Timer<XMLHttpRequestProgressEventThrottle>*);
     66     bool flushDeferredProgressEvent();
     67     void deliverProgressEvent();
     68 
     69     bool hasEventToDispatch() const;
     70 
     71     // Weak pointer to our XMLHttpRequest object as it is the one holding us.
     72     EventTarget* m_target;
     73 
     74     bool m_lengthComputable;
     75     unsigned long long m_loaded;
     76     unsigned long long m_total;
     77 
     78     bool m_deferEvents;
     79     RefPtr<Event> m_deferredProgressEvent;
     80     Vector<RefPtr<Event> > m_deferredEvents;
     81     Timer<XMLHttpRequestProgressEventThrottle> m_dispatchDeferredEventsTimer;
     82 };
     83 
     84 } // namespace WebCore
     85 
     86 #endif // XMLHttpRequestProgressEventThrottle_h
     87