Source/WebKit2/UIProcess/ProcessThrottler.h

   1 /*
   2  * Copyright (C) 2014 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 ProcessThrottler_h
  27 #define ProcessThrottler_h
  28
  29 #include "ProcessAssertion.h"
  30
  31 #include <wtf/RunLoop.h>
  32 #include <wtf/WeakPtr.h>
  33
  34 namespace WebKit {
  35
  36 class WebProcessProxy;
  37
  38 class ProcessThrottler {
  39 public:
  40     class ForegroundActivityToken {
  41     public:
  42         ForegroundActivityToken(ProcessThrottler&);
  43         ~ForegroundActivityToken();
  44
  45     private:
  46         WeakPtr<ProcessThrottler> m_throttler;
  47     };
  48
  49     class BackgroundActivityToken {
  50     public:
  51         BackgroundActivityToken(ProcessThrottler&);
  52         ~BackgroundActivityToken();
  53
  54     private:
  55         WeakPtr<ProcessThrottler> m_throttler;
  56     };
  57
  58     ProcessThrottler(WebProcessProxy*);
  59
  60     void didConnnectToProcess(pid_t);
  61     void processReadyToSuspend();
  62     void didCancelProcessSuspension();
  63
  64 private:
  65     friend class ForegroundActivityToken;
  66     friend class BackgroundActivityToken;
  67     WeakPtr<ProcessThrottler> weakPtr() { return m_weakPtrFactory.createWeakPtr(); }
  68
  69     AssertionState assertionState();
  70     void updateAssertion();
  71     void updateAssertionNow();
  72     void suspendTimerFired();
  73
  74     WebProcessProxy* m_process;
  75     WeakPtrFactory<ProcessThrottler> m_weakPtrFactory;
  76     std::unique_ptr<ProcessAndUIAssertion> m_assertion;
  77     RunLoop::Timer<ProcessThrottler> m_suspendTimer;
  78     unsigned m_foregroundCount;
  79     unsigned m_backgroundCount;
  80     int m_suspendMessageCount;
  81 };
  82
  83 }
  84
  85 #endif // ProcessThrottler_h