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 #ifndef XMLHttpRequestProgressEventThrottle_h

    28 #define XMLHttpRequestProgressEventThrottle_h

    29 

    30 #include "Timer.h"

    31 #include "wtf/PassRefPtr.h"

    32 #include "wtf/Vector.h"

    33 

    34 namespace WebCore {

    35 

    36 class Event;

    37 class EventTarget;

    38 

    39 enum ProgressEventAction {

    40     DoNotFlushProgressEvent,

    41     FlushProgressEvent

    42 };

    43 

    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 {

    47 public:

    48     XMLHttpRequestProgressEventThrottle(EventTarget*);

    49     virtual ~XMLHttpRequestProgressEventThrottle();

    50 

    51     void dispatchProgressEvent(bool lengthComputable, unsigned loaded, unsigned total);

    52     void dispatchEvent(PassRefPtr<Event>, ProgressEventAction = DoNotFlushProgressEvent);

    53 

    54     void suspend();

    55     void resume();

    56 

    57     bool suspended() const { return m_suspended; }

    58 

    59 private:

    60     static const double minimumProgressEventDispatchingIntervalInSeconds;

    61 

    62     virtual void fired();

    63     void dispatchPausedEvent();

    64     void flushProgressEvent();

    65 

    66     bool hasEventToDispatch() const;

    67 

    68     // Weak pointer to our XMLHttpRequest object as it is the one holding us.

    69     EventTarget* m_target;

    70 

    71     bool m_lengthComputable;

    72     unsigned m_loaded;

    73     unsigned m_total;

    74 

    75     bool m_suspended;

    76     RefPtr<Event> m_pausedEvent;

    77 };

    78 

    79 } // namespace WebCore

    80 

    81 #endif // XMLHttpRequestProgressEventThrottle_h