Source/WebKit2/UIProcess/ResponsivenessTimer.h

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef ResponsivenessTimer_h
  27 #define ResponsivenessTimer_h
  28
  29 #include <WebCore/RunLoop.h>
  30
  31 namespace WebKit {
  32
  33 class ResponsivenessTimer {
  34 public:
  35     class Client {
  36     public:
  37         virtual ~Client() { }
  38         virtual void didBecomeUnresponsive(ResponsivenessTimer*) = 0;
  39         virtual void interactionOccurredWhileUnresponsive(ResponsivenessTimer*) = 0;
  40         virtual void didBecomeResponsive(ResponsivenessTimer*) = 0;
  41     };
  42
  43     ResponsivenessTimer(ResponsivenessTimer::Client*);
  44     ~ResponsivenessTimer();
  45
  46     void start();
  47     void stop();
  48
  49     void invalidate();
  50
  51     bool isResponsive() { return m_isResponsive; }
  52
  53 private:
  54     void timerFired();
  55
  56     ResponsivenessTimer::Client* m_client;
  57     bool m_isResponsive;
  58
  59     WebCore::RunLoop::Timer<ResponsivenessTimer> m_timer;
  60 };
  61
  62 } // namespace WebKit
  63
  64 #endif // ResponsivenessTimer_h
  65