1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * 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.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// 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 BASE_IDLE_TIMER_H__
#define BASE_IDLE_TIMER_H__
#include <windows.h>
#include "base/basictypes.h"
#include "base/task.h"
#include "base/timer.h"
// IdleTimer is a recurring Timer task which runs only when the system is idle.
// System Idle time is defined as not having any user keyboard or mouse
// activity for some period of time. Because the timer is user dependant, it
// is possible for the timer to never fire.
//
// Usage should be for low-priority tasks, and may look like this:
//
// class MyIdleTimerTask : public IdleTimerTask {
// public:
// // This task will run after 5 seconds of idle time
// // and not more often than once per minute.
// MyIdleTimerTask() : IdleTimerTask(5, 60) {};
// virtual void OnIdle() { do something };
// }
//
// MyIdleTimerTask *task = new MyIdleTimerTask();
// task->Start();
//
// // As with all TimerTasks, the caller must dispose the object.
// delete task; // Will Stop the timer and cleanup the task.
class TimerManager;
// Function prototype for GetLastInputInfo.
typedef BOOL (__stdcall *GetLastInputInfoFunction)(PLASTINPUTINFO plii);
class IdleTimerTask : public Task {
public:
// Create an IdleTimerTask.
// idle_time: idle time required before this task can run.
// repeat: true if the timer should fire multiple times per idle,
// false to fire once per idle.
IdleTimerTask(TimeDelta idle_time, bool repeat);
// On destruction, the IdleTimerTask will Stop itself and delete the Task.
virtual ~IdleTimerTask();
// Start the IdleTimerTask.
void Start();
// Stop the IdleTimertask.
void Stop();
// The method to run when the timer elapses.
virtual void OnIdle() = 0;
protected:
// Override the GetLastInputInfo function.
void set_last_input_info_fn(GetLastInputInfoFunction function) {
get_last_input_info_fn_ = function;
}
private:
// This task's run method.
virtual void Run();
// Start the timer.
void StartTimer();
// Gets the number of milliseconds since the last input event.
TimeDelta CurrentIdleTime();
// Compute time until idle. Returns 0 if we are now idle.
TimeDelta TimeUntilIdle();
TimeDelta idle_interval_;
bool repeat_;
Time last_time_fired_; // The last time the idle timer fired.
// will be 0 until the timer fires the first time.
scoped_ptr<OneShotTimer> timer_;
GetLastInputInfoFunction get_last_input_info_fn_;
};
#endif // BASE_IDLE_TIMER_H__
|
