The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.os; |
| 18 | |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 19 | import android.content.Context; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 20 | import android.util.Log; |
| 21 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 22 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 23 | * This class gives you control of the power state of the device. |
| 24 | * |
| 25 | * <p> |
| 26 | * <b>Device battery life will be significantly affected by the use of this API.</b> |
| 27 | * Do not acquire {@link WakeLock}s unless you really need them, use the minimum levels |
| 28 | * possible, and be sure to release them as soon as possible. |
| 29 | * </p><p> |
| 30 | * You can obtain an instance of this class by calling |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 31 | * {@link android.content.Context#getSystemService(java.lang.String) Context.getSystemService()}. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 32 | * </p><p> |
| 33 | * The primary API you'll use is {@link #newWakeLock(int, String) newWakeLock()}. |
| 34 | * This will create a {@link PowerManager.WakeLock} object. You can then use methods |
| 35 | * on the wake lock object to control the power state of the device. |
| 36 | * </p><p> |
| 37 | * In practice it's quite simple: |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 38 | * {@samplecode |
| 39 | * PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); |
| 40 | * PowerManager.WakeLock wl = pm.newWakeLock(PowerManager.SCREEN_DIM_WAKE_LOCK, "My Tag"); |
| 41 | * wl.acquire(); |
| 42 | * ..screen will stay on during this section.. |
| 43 | * wl.release(); |
| 44 | * } |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 45 | * </p><p> |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 46 | * The following wake lock levels are defined, with varying effects on system power. |
| 47 | * <i>These levels are mutually exclusive - you may only specify one of them.</i> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 48 | * |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 49 | * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 50 | * <thead> |
| 51 | * <tr><th>Flag Value</th> |
| 52 | * <th>CPU</th> <th>Screen</th> <th>Keyboard</th></tr> |
| 53 | * </thead> |
| 54 | * |
| 55 | * <tbody> |
| 56 | * <tr><th>{@link #PARTIAL_WAKE_LOCK}</th> |
| 57 | * <td>On*</td> <td>Off</td> <td>Off</td> |
| 58 | * </tr> |
| 59 | * |
| 60 | * <tr><th>{@link #SCREEN_DIM_WAKE_LOCK}</th> |
| 61 | * <td>On</td> <td>Dim</td> <td>Off</td> |
| 62 | * </tr> |
| 63 | * |
| 64 | * <tr><th>{@link #SCREEN_BRIGHT_WAKE_LOCK}</th> |
| 65 | * <td>On</td> <td>Bright</td> <td>Off</td> |
| 66 | * </tr> |
| 67 | * |
| 68 | * <tr><th>{@link #FULL_WAKE_LOCK}</th> |
| 69 | * <td>On</td> <td>Bright</td> <td>Bright</td> |
| 70 | * </tr> |
| 71 | * </tbody> |
| 72 | * </table> |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 73 | * </p><p> |
| 74 | * *<i>If you hold a partial wake lock, the CPU will continue to run, regardless of any |
| 75 | * display timeouts or the state of the screen and even after the user presses the power button. |
| 76 | * In all other wake locks, the CPU will run, but the user can still put the device to sleep |
| 77 | * using the power button.</i> |
| 78 | * </p><p> |
| 79 | * In addition, you can add two more flags, which affect behavior of the screen only. |
| 80 | * <i>These flags have no effect when combined with a {@link #PARTIAL_WAKE_LOCK}.</i> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 81 | * |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 82 | * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 83 | * <thead> |
| 84 | * <tr><th>Flag Value</th> <th>Description</th></tr> |
| 85 | * </thead> |
| 86 | * |
| 87 | * <tbody> |
| 88 | * <tr><th>{@link #ACQUIRE_CAUSES_WAKEUP}</th> |
| 89 | * <td>Normal wake locks don't actually turn on the illumination. Instead, they cause |
| 90 | * the illumination to remain on once it turns on (e.g. from user activity). This flag |
| 91 | * will force the screen and/or keyboard to turn on immediately, when the WakeLock is |
| 92 | * acquired. A typical use would be for notifications which are important for the user to |
| 93 | * see immediately.</td> |
| 94 | * </tr> |
| 95 | * |
| 96 | * <tr><th>{@link #ON_AFTER_RELEASE}</th> |
| 97 | * <td>If this flag is set, the user activity timer will be reset when the WakeLock is |
| 98 | * released, causing the illumination to remain on a bit longer. This can be used to |
| 99 | * reduce flicker if you are cycling between wake lock conditions.</td> |
| 100 | * </tr> |
| 101 | * </tbody> |
| 102 | * </table> |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 103 | * </p><p> |
Kenny Root | d710fb5 | 2011-03-15 17:39:45 -0700 | [diff] [blame] | 104 | * Any application using a WakeLock must request the {@code android.permission.WAKE_LOCK} |
| 105 | * permission in an {@code <uses-permission>} element of the application's manifest. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 106 | * </p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 107 | */ |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 108 | public final class PowerManager { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 109 | private static final String TAG = "PowerManager"; |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 110 | |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 111 | /* NOTE: Wake lock levels were previously defined as a bit field, except that only a few |
| 112 | * combinations were actually supported so the bit field was removed. This explains |
| 113 | * why the numbering scheme is so odd. If adding a new wake lock level, any unused |
| 114 | * value can be used. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 115 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 116 | |
| 117 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 118 | * Wake lock level: Ensures that the CPU is running; the screen and keyboard |
| 119 | * backlight will be allowed to go off. |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 120 | * <p> |
| 121 | * If the user presses the power button, then the screen will be turned off |
| 122 | * but the CPU will be kept on until all partial wake locks have been released. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 123 | * </p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 124 | */ |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 125 | public static final int PARTIAL_WAKE_LOCK = 0x00000001; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 126 | |
| 127 | /** |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 128 | * Wake lock level: Ensures that the screen is on (but may be dimmed); |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 129 | * the keyboard backlight will be allowed to go off. |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 130 | * <p> |
| 131 | * If the user presses the power button, then the {@link #SCREEN_DIM_WAKE_LOCK} will be |
| 132 | * implicitly released by the system, causing both the screen and the CPU to be turned off. |
| 133 | * Contrast with {@link #PARTIAL_WAKE_LOCK}. |
| 134 | * </p> |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 135 | * |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 136 | * @deprecated Most applications should use |
| 137 | * {@link android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON} instead |
| 138 | * of this type of wake lock, as it will be correctly managed by the platform |
| 139 | * as the user moves between applications and doesn't require a special permission. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 140 | */ |
Dianne Hackborn | 9567a66 | 2011-04-19 18:44:03 -0700 | [diff] [blame] | 141 | @Deprecated |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 142 | public static final int SCREEN_DIM_WAKE_LOCK = 0x00000006; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 143 | |
| 144 | /** |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 145 | * Wake lock level: Ensures that the screen is on at full brightness; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 146 | * the keyboard backlight will be allowed to go off. |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 147 | * <p> |
| 148 | * If the user presses the power button, then the {@link #SCREEN_BRIGHT_WAKE_LOCK} will be |
| 149 | * implicitly released by the system, causing both the screen and the CPU to be turned off. |
| 150 | * Contrast with {@link #PARTIAL_WAKE_LOCK}. |
| 151 | * </p> |
| 152 | * |
| 153 | * @deprecated Most applications should use |
| 154 | * {@link android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON} instead |
| 155 | * of this type of wake lock, as it will be correctly managed by the platform |
| 156 | * as the user moves between applications and doesn't require a special permission. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 157 | */ |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 158 | @Deprecated |
| 159 | public static final int SCREEN_BRIGHT_WAKE_LOCK = 0x0000000a; |
| 160 | |
| 161 | /** |
| 162 | * Wake lock level: Ensures that the screen and keyboard backlight are on at |
| 163 | * full brightness. |
| 164 | * <p> |
| 165 | * If the user presses the power button, then the {@link #FULL_WAKE_LOCK} will be |
| 166 | * implicitly released by the system, causing both the screen and the CPU to be turned off. |
| 167 | * Contrast with {@link #PARTIAL_WAKE_LOCK}. |
| 168 | * </p> |
| 169 | * |
| 170 | * @deprecated Most applications should use |
| 171 | * {@link android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON} instead |
| 172 | * of this type of wake lock, as it will be correctly managed by the platform |
| 173 | * as the user moves between applications and doesn't require a special permission. |
| 174 | */ |
| 175 | @Deprecated |
| 176 | public static final int FULL_WAKE_LOCK = 0x0000001a; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 177 | |
| 178 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 179 | * Wake lock level: Turns the screen off when the proximity sensor activates. |
| 180 | * <p> |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 181 | * Since not all devices have proximity sensors, use {@link #isWakeLockLevelSupported} |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 182 | * to determine whether this wake lock level is supported. |
| 183 | * </p> |
Mike Lockwood | bc706a0 | 2009-07-27 13:50:57 -0700 | [diff] [blame] | 184 | * |
| 185 | * {@hide} |
| 186 | */ |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 187 | public static final int PROXIMITY_SCREEN_OFF_WAKE_LOCK = 0x00000020; |
Mike Lockwood | bc706a0 | 2009-07-27 13:50:57 -0700 | [diff] [blame] | 188 | |
| 189 | /** |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 190 | * Mask for the wake lock level component of a combined wake lock level and flags integer. |
Mike Lockwood | 0e39ea8 | 2009-11-18 15:37:10 -0500 | [diff] [blame] | 191 | * |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 192 | * @hide |
Mike Lockwood | 0e39ea8 | 2009-11-18 15:37:10 -0500 | [diff] [blame] | 193 | */ |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 194 | public static final int WAKE_LOCK_LEVEL_MASK = 0x0000ffff; |
Mike Lockwood | 0e39ea8 | 2009-11-18 15:37:10 -0500 | [diff] [blame] | 195 | |
| 196 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 197 | * Wake lock flag: Turn the screen on when the wake lock is acquired. |
| 198 | * <p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 199 | * Normally wake locks don't actually wake the device, they just cause |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 200 | * the screen to remain on once it's already on. Think of the video player |
| 201 | * application as the normal behavior. Notifications that pop up and want |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 202 | * the device to be on are the exception; use this flag to be like them. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 203 | * </p><p> |
| 204 | * Cannot be used with {@link #PARTIAL_WAKE_LOCK}. |
| 205 | * </p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 206 | */ |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 207 | public static final int ACQUIRE_CAUSES_WAKEUP = 0x10000000; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 208 | |
| 209 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 210 | * Wake lock flag: When this wake lock is released, poke the user activity timer |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 211 | * so the screen stays on for a little longer. |
| 212 | * <p> |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 213 | * Will not turn the screen on if it is not already on. |
| 214 | * See {@link #ACQUIRE_CAUSES_WAKEUP} if you want that. |
| 215 | * </p><p> |
| 216 | * Cannot be used with {@link #PARTIAL_WAKE_LOCK}. |
| 217 | * </p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 218 | */ |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 219 | public static final int ON_AFTER_RELEASE = 0x20000000; |
| 220 | |
| 221 | /** |
| 222 | * Flag for {@link WakeLock#release release(int)} to defer releasing a |
| 223 | * {@link #WAKE_BIT_PROXIMITY_SCREEN_OFF} wake lock until the proximity sensor returns |
| 224 | * a negative value. |
| 225 | * |
| 226 | * {@hide} |
| 227 | */ |
| 228 | public static final int WAIT_FOR_PROXIMITY_NEGATIVE = 1; |
Jeff Brown | 7304c34 | 2012-05-11 18:42:42 -0700 | [diff] [blame] | 229 | |
| 230 | /** |
Jeff Brown | 7304c34 | 2012-05-11 18:42:42 -0700 | [diff] [blame] | 231 | * Brightness value for fully on. |
| 232 | * @hide |
| 233 | */ |
| 234 | public static final int BRIGHTNESS_ON = 255; |
| 235 | |
| 236 | /** |
Jeff Brown | 7304c34 | 2012-05-11 18:42:42 -0700 | [diff] [blame] | 237 | * Brightness value for fully off. |
| 238 | * @hide |
| 239 | */ |
| 240 | public static final int BRIGHTNESS_OFF = 0; |
| 241 | |
Jeff Brown | b696de5 | 2012-07-27 15:38:50 -0700 | [diff] [blame] | 242 | // Note: Be sure to update android.os.BatteryStats and PowerManager.h |
| 243 | // if adding or modifying user activity event constants. |
| 244 | |
| 245 | /** |
| 246 | * User activity event type: Unspecified event type. |
| 247 | * @hide |
| 248 | */ |
| 249 | public static final int USER_ACTIVITY_EVENT_OTHER = 0; |
| 250 | |
| 251 | /** |
| 252 | * User activity event type: Button or key pressed or released. |
| 253 | * @hide |
| 254 | */ |
| 255 | public static final int USER_ACTIVITY_EVENT_BUTTON = 1; |
| 256 | |
| 257 | /** |
| 258 | * User activity event type: Touch down, move or up. |
| 259 | * @hide |
| 260 | */ |
| 261 | public static final int USER_ACTIVITY_EVENT_TOUCH = 2; |
| 262 | |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 263 | /** |
| 264 | * User activity flag: Do not restart the user activity timeout or brighten |
| 265 | * the display in response to user activity if it is already dimmed. |
| 266 | * @hide |
| 267 | */ |
| 268 | public static final int USER_ACTIVITY_FLAG_NO_CHANGE_LIGHTS = 1 << 0; |
| 269 | |
| 270 | /** |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 271 | * Go to sleep reason code: Going to sleep due by user request. |
| 272 | * @hide |
| 273 | */ |
| 274 | public static final int GO_TO_SLEEP_REASON_USER = 0; |
| 275 | |
| 276 | /** |
| 277 | * Go to sleep reason code: Going to sleep due by request of the |
| 278 | * device administration policy. |
| 279 | * @hide |
| 280 | */ |
| 281 | public static final int GO_TO_SLEEP_REASON_DEVICE_ADMIN = 1; |
| 282 | |
| 283 | /** |
| 284 | * Go to sleep reason code: Going to sleep due to a screen timeout. |
| 285 | * @hide |
| 286 | */ |
| 287 | public static final int GO_TO_SLEEP_REASON_TIMEOUT = 2; |
| 288 | |
| 289 | final Context mContext; |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 290 | final IPowerManager mService; |
| 291 | final Handler mHandler; |
| 292 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 293 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 294 | * {@hide} |
| 295 | */ |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 296 | public PowerManager(Context context, IPowerManager service, Handler handler) { |
| 297 | mContext = context; |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 298 | mService = service; |
| 299 | mHandler = handler; |
| 300 | } |
| 301 | |
| 302 | /** |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 303 | * Gets the minimum supported screen brightness setting. |
| 304 | * The screen may be allowed to become dimmer than this value but |
| 305 | * this is the minimum value that can be set by the user. |
| 306 | * @hide |
| 307 | */ |
| 308 | public int getMinimumScreenBrightnessSetting() { |
| 309 | return mContext.getResources().getInteger( |
Jeff Brown | f9bba13 | 2012-08-21 22:04:02 -0700 | [diff] [blame] | 310 | com.android.internal.R.integer.config_screenBrightnessSettingMinimum); |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 311 | } |
| 312 | |
| 313 | /** |
| 314 | * Gets the maximum supported screen brightness setting. |
| 315 | * The screen may be allowed to become dimmer than this value but |
| 316 | * this is the maximum value that can be set by the user. |
| 317 | * @hide |
| 318 | */ |
| 319 | public int getMaximumScreenBrightnessSetting() { |
Jeff Brown | f9bba13 | 2012-08-21 22:04:02 -0700 | [diff] [blame] | 320 | return mContext.getResources().getInteger( |
| 321 | com.android.internal.R.integer.config_screenBrightnessSettingMaximum); |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 322 | } |
| 323 | |
| 324 | /** |
| 325 | * Gets the default screen brightness setting. |
| 326 | * @hide |
| 327 | */ |
| 328 | public int getDefaultScreenBrightnessSetting() { |
Jeff Brown | f9bba13 | 2012-08-21 22:04:02 -0700 | [diff] [blame] | 329 | return mContext.getResources().getInteger( |
| 330 | com.android.internal.R.integer.config_screenBrightnessSettingDefault); |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 331 | } |
| 332 | |
| 333 | /** |
Jeff Brown | 631938f | 2012-09-08 15:11:11 -0700 | [diff] [blame] | 334 | * Returns true if the screen auto-brightness adjustment setting should |
| 335 | * be available in the UI. This setting is experimental and disabled by default. |
| 336 | * @hide |
| 337 | */ |
| 338 | public static boolean useScreenAutoBrightnessAdjustmentFeature() { |
| 339 | return SystemProperties.getBoolean("persist.power.useautobrightadj", false); |
| 340 | } |
| 341 | |
| 342 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 343 | * Creates a new wake lock with the specified level and flags. |
Kenny Root | d710fb5 | 2011-03-15 17:39:45 -0700 | [diff] [blame] | 344 | * <p> |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 345 | * The {@code levelAndFlags} parameter specifies a wake lock level and optional flags |
| 346 | * combined using the logical OR operator. |
| 347 | * </p><p> |
| 348 | * The wake lock levels are: {@link #PARTIAL_WAKE_LOCK}, |
| 349 | * {@link #FULL_WAKE_LOCK}, {@link #SCREEN_DIM_WAKE_LOCK} |
| 350 | * and {@link #SCREEN_BRIGHT_WAKE_LOCK}. Exactly one wake lock level must be |
| 351 | * specified as part of the {@code levelAndFlags} parameter. |
| 352 | * </p><p> |
| 353 | * The wake lock flags are: {@link #ACQUIRE_CAUSES_WAKEUP} |
| 354 | * and {@link #ON_AFTER_RELEASE}. Multiple flags can be combined as part of the |
| 355 | * {@code levelAndFlags} parameters. |
| 356 | * </p><p> |
| 357 | * Call {@link WakeLock#acquire() acquire()} on the object to acquire the |
| 358 | * wake lock, and {@link WakeLock#release release()} when you are done. |
| 359 | * </p><p> |
| 360 | * {@samplecode |
| 361 | * PowerManager pm = (PowerManager)mContext.getSystemService( |
| 362 | * Context.POWER_SERVICE); |
| 363 | * PowerManager.WakeLock wl = pm.newWakeLock( |
| 364 | * PowerManager.SCREEN_DIM_WAKE_LOCK |
| 365 | * | PowerManager.ON_AFTER_RELEASE, |
| 366 | * TAG); |
| 367 | * wl.acquire(); |
| 368 | * // ... do work... |
| 369 | * wl.release(); |
| 370 | * } |
| 371 | * </p><p> |
| 372 | * Although a wake lock can be created without special permissions, |
| 373 | * the {@link android.Manifest.permission#WAKE_LOCK} permission is |
| 374 | * required to actually acquire or release the wake lock that is returned. |
| 375 | * </p><p class="note"> |
| 376 | * If using this to keep the screen on, you should strongly consider using |
| 377 | * {@link android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON} instead. |
| 378 | * This window flag will be correctly managed by the platform |
| 379 | * as the user moves between applications and doesn't require a special permission. |
| 380 | * </p> |
| 381 | * |
| 382 | * @param levelAndFlags Combination of wake lock level and flag values defining |
| 383 | * the requested behavior of the WakeLock. |
| 384 | * @param tag Your class name (or other tag) for debugging purposes. |
| 385 | * |
| 386 | * @see WakeLock#acquire() |
| 387 | * @see WakeLock#release() |
| 388 | * @see #PARTIAL_WAKE_LOCK |
| 389 | * @see #FULL_WAKE_LOCK |
| 390 | * @see #SCREEN_DIM_WAKE_LOCK |
| 391 | * @see #SCREEN_BRIGHT_WAKE_LOCK |
| 392 | * @see #ACQUIRE_CAUSES_WAKEUP |
| 393 | * @see #ON_AFTER_RELEASE |
| 394 | */ |
| 395 | public WakeLock newWakeLock(int levelAndFlags, String tag) { |
Jeff Brown | 155fc70 | 2012-07-27 12:12:15 -0700 | [diff] [blame] | 396 | validateWakeLockParameters(levelAndFlags, tag); |
| 397 | return new WakeLock(levelAndFlags, tag); |
| 398 | } |
| 399 | |
| 400 | /** @hide */ |
| 401 | public static void validateWakeLockParameters(int levelAndFlags, String tag) { |
| 402 | switch (levelAndFlags & WAKE_LOCK_LEVEL_MASK) { |
| 403 | case PARTIAL_WAKE_LOCK: |
| 404 | case SCREEN_DIM_WAKE_LOCK: |
| 405 | case SCREEN_BRIGHT_WAKE_LOCK: |
| 406 | case FULL_WAKE_LOCK: |
| 407 | case PROXIMITY_SCREEN_OFF_WAKE_LOCK: |
| 408 | break; |
| 409 | default: |
| 410 | throw new IllegalArgumentException("Must specify a valid wake lock level."); |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 411 | } |
| 412 | if (tag == null) { |
| 413 | throw new IllegalArgumentException("The tag must not be null."); |
| 414 | } |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 415 | } |
| 416 | |
| 417 | /** |
| 418 | * Notifies the power manager that user activity happened. |
| 419 | * <p> |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 420 | * Resets the auto-off timer and brightens the screen if the device |
| 421 | * is not asleep. This is what happens normally when a key or the touch |
| 422 | * screen is pressed or when some other user activity occurs. |
| 423 | * This method does not wake up the device if it has been put to sleep. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 424 | * </p><p> |
| 425 | * Requires the {@link android.Manifest.permission#DEVICE_POWER} permission. |
| 426 | * </p> |
| 427 | * |
| 428 | * @param when The time of the user activity, in the {@link SystemClock#uptimeMillis()} |
Jeff Brown | 62c82e4 | 2012-09-26 01:30:41 -0700 | [diff] [blame] | 429 | * time base. This timestamp is used to correctly order the user activity request with |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 430 | * other power management functions. It should be set |
| 431 | * to the timestamp of the input event that caused the user activity. |
| 432 | * @param noChangeLights If true, does not cause the keyboard backlight to turn on |
| 433 | * because of this event. This is set when the power key is pressed. |
| 434 | * We want the device to stay on while the button is down, but we're about |
| 435 | * to turn off the screen so we don't want the keyboard backlight to turn on again. |
| 436 | * Otherwise the lights flash on and then off and it looks weird. |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 437 | * |
| 438 | * @see #wakeUp |
| 439 | * @see #goToSleep |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 440 | */ |
| 441 | public void userActivity(long when, boolean noChangeLights) { |
| 442 | try { |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 443 | mService.userActivity(when, USER_ACTIVITY_EVENT_OTHER, |
| 444 | noChangeLights ? USER_ACTIVITY_FLAG_NO_CHANGE_LIGHTS : 0); |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 445 | } catch (RemoteException e) { |
| 446 | } |
| 447 | } |
| 448 | |
| 449 | /** |
| 450 | * Forces the device to go to sleep. |
| 451 | * <p> |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 452 | * Overrides all the wake locks that are held. |
| 453 | * This is what happens when the power key is pressed to turn off the screen. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 454 | * </p><p> |
| 455 | * Requires the {@link android.Manifest.permission#DEVICE_POWER} permission. |
| 456 | * </p> |
| 457 | * |
| 458 | * @param time The time when the request to go to sleep was issued, in the |
| 459 | * {@link SystemClock#uptimeMillis()} time base. This timestamp is used to correctly |
Jeff Brown | 62c82e4 | 2012-09-26 01:30:41 -0700 | [diff] [blame] | 460 | * order the go to sleep request with other power management functions. It should be set |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 461 | * to the timestamp of the input event that caused the request to go to sleep. |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 462 | * |
| 463 | * @see #userActivity |
| 464 | * @see #wakeUp |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 465 | */ |
| 466 | public void goToSleep(long time) { |
| 467 | try { |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 468 | mService.goToSleep(time, GO_TO_SLEEP_REASON_USER); |
| 469 | } catch (RemoteException e) { |
| 470 | } |
| 471 | } |
| 472 | |
| 473 | /** |
| 474 | * Forces the device to wake up from sleep. |
| 475 | * <p> |
| 476 | * If the device is currently asleep, wakes it up, otherwise does nothing. |
| 477 | * This is what happens when the power key is pressed to turn on the screen. |
| 478 | * </p><p> |
| 479 | * Requires the {@link android.Manifest.permission#DEVICE_POWER} permission. |
| 480 | * </p> |
| 481 | * |
| 482 | * @param time The time when the request to wake up was issued, in the |
| 483 | * {@link SystemClock#uptimeMillis()} time base. This timestamp is used to correctly |
Jeff Brown | 62c82e4 | 2012-09-26 01:30:41 -0700 | [diff] [blame] | 484 | * order the wake up request with other power management functions. It should be set |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 485 | * to the timestamp of the input event that caused the request to wake up. |
| 486 | * |
| 487 | * @see #userActivity |
| 488 | * @see #goToSleep |
| 489 | */ |
| 490 | public void wakeUp(long time) { |
| 491 | try { |
| 492 | mService.wakeUp(time); |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 493 | } catch (RemoteException e) { |
| 494 | } |
| 495 | } |
| 496 | |
| 497 | /** |
Jeff Brown | 62c82e4 | 2012-09-26 01:30:41 -0700 | [diff] [blame] | 498 | * Forces the device to start napping. |
| 499 | * <p> |
| 500 | * If the device is currently awake, starts dreaming, otherwise does nothing. |
| 501 | * When the dream ends or if the dream cannot be started, the device will |
| 502 | * either wake up or go to sleep depending on whether there has been recent |
| 503 | * user activity. |
| 504 | * </p><p> |
| 505 | * Requires the {@link android.Manifest.permission#DEVICE_POWER} permission. |
| 506 | * </p> |
| 507 | * |
| 508 | * @param time The time when the request to nap was issued, in the |
| 509 | * {@link SystemClock#uptimeMillis()} time base. This timestamp is used to correctly |
| 510 | * order the nap request with other power management functions. It should be set |
| 511 | * to the timestamp of the input event that caused the request to nap. |
| 512 | * |
| 513 | * @see #wakeUp |
| 514 | * @see #goToSleep |
| 515 | * |
| 516 | * @hide |
| 517 | */ |
| 518 | public void nap(long time) { |
| 519 | try { |
| 520 | mService.nap(time); |
| 521 | } catch (RemoteException e) { |
| 522 | } |
| 523 | } |
| 524 | |
| 525 | /** |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 526 | * Sets the brightness of the backlights (screen, keyboard, button). |
| 527 | * <p> |
| 528 | * Requires the {@link android.Manifest.permission#DEVICE_POWER} permission. |
| 529 | * </p> |
| 530 | * |
| 531 | * @param brightness The brightness value from 0 to 255. |
| 532 | * |
| 533 | * {@hide} |
| 534 | */ |
| 535 | public void setBacklightBrightness(int brightness) { |
| 536 | try { |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 537 | mService.setTemporaryScreenBrightnessSettingOverride(brightness); |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 538 | } catch (RemoteException e) { |
| 539 | } |
| 540 | } |
| 541 | |
| 542 | /** |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 543 | * Returns true if the specified wake lock level is supported. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 544 | * |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 545 | * @param level The wake lock level to check. |
| 546 | * @return True if the specified wake lock level is supported. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 547 | * |
| 548 | * {@hide} |
| 549 | */ |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 550 | public boolean isWakeLockLevelSupported(int level) { |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 551 | try { |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 552 | return mService.isWakeLockLevelSupported(level); |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 553 | } catch (RemoteException e) { |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 554 | return false; |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 555 | } |
| 556 | } |
| 557 | |
| 558 | /** |
| 559 | * Returns whether the screen is currently on. |
| 560 | * <p> |
| 561 | * Only indicates whether the screen is on. The screen could be either bright or dim. |
| 562 | * </p><p> |
| 563 | * {@samplecode |
| 564 | * PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); |
| 565 | * boolean isScreenOn = pm.isScreenOn(); |
| 566 | * } |
| 567 | * </p> |
| 568 | * |
| 569 | * @return whether the screen is on (bright or dim). |
| 570 | */ |
| 571 | public boolean isScreenOn() { |
| 572 | try { |
| 573 | return mService.isScreenOn(); |
| 574 | } catch (RemoteException e) { |
| 575 | return false; |
| 576 | } |
| 577 | } |
| 578 | |
| 579 | /** |
| 580 | * Reboot the device. Will not return if the reboot is successful. |
| 581 | * <p> |
| 582 | * Requires the {@link android.Manifest.permission#REBOOT} permission. |
| 583 | * </p> |
| 584 | * |
| 585 | * @param reason code to pass to the kernel (e.g., "recovery") to |
| 586 | * request special boot modes, or null. |
| 587 | */ |
| 588 | public void reboot(String reason) { |
| 589 | try { |
| 590 | mService.reboot(reason); |
| 591 | } catch (RemoteException e) { |
| 592 | } |
| 593 | } |
| 594 | |
| 595 | /** |
| 596 | * A wake lock is a mechanism to indicate that your application needs |
| 597 | * to have the device stay on. |
Kenny Root | d710fb5 | 2011-03-15 17:39:45 -0700 | [diff] [blame] | 598 | * <p> |
| 599 | * Any application using a WakeLock must request the {@code android.permission.WAKE_LOCK} |
| 600 | * permission in an {@code <uses-permission>} element of the application's manifest. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 601 | * Obtain a wake lock by calling {@link PowerManager#newWakeLock(int, String)}. |
| 602 | * </p><p> |
| 603 | * Call {@link #acquire()} to acquire the wake lock and force the device to stay |
| 604 | * on at the level that was requested when the wake lock was created. |
| 605 | * </p><p> |
| 606 | * Call {@link #release()} when you are done and don't need the lock anymore. |
| 607 | * It is very important to do this as soon as possible to avoid running down the |
| 608 | * device's battery excessively. |
| 609 | * </p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 610 | */ |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 611 | public final class WakeLock { |
| 612 | private final int mFlags; |
| 613 | private final String mTag; |
| 614 | private final IBinder mToken; |
| 615 | private int mCount; |
| 616 | private boolean mRefCounted = true; |
| 617 | private boolean mHeld; |
| 618 | private WorkSource mWorkSource; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 619 | |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 620 | private final Runnable mReleaser = new Runnable() { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 621 | public void run() { |
| 622 | release(); |
| 623 | } |
| 624 | }; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 625 | |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 626 | WakeLock(int flags, String tag) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 627 | mFlags = flags; |
| 628 | mTag = tag; |
| 629 | mToken = new Binder(); |
| 630 | } |
| 631 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 632 | @Override |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 633 | protected void finalize() throws Throwable { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 634 | synchronized (mToken) { |
| 635 | if (mHeld) { |
Dan Egnor | 60d8762 | 2009-12-16 16:32:58 -0800 | [diff] [blame] | 636 | Log.wtf(TAG, "WakeLock finalized while still held: " + mTag); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 637 | try { |
Mike Lockwood | 0e39ea8 | 2009-11-18 15:37:10 -0500 | [diff] [blame] | 638 | mService.releaseWakeLock(mToken, 0); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 639 | } catch (RemoteException e) { |
| 640 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 641 | } |
| 642 | } |
| 643 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 644 | |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 645 | /** |
| 646 | * Sets whether this WakeLock is reference counted. |
| 647 | * <p> |
| 648 | * Wake locks are reference counted by default. If a wake lock is |
| 649 | * reference counted, then each call to {@link #acquire()} must be |
| 650 | * balanced by an equal number of calls to {@link #release()}. If a wake |
| 651 | * lock is not reference counted, then one call to {@link #release()} is |
| 652 | * sufficient to undo the effect of all previous calls to {@link #acquire()}. |
| 653 | * </p> |
| 654 | * |
| 655 | * @param value True to make the wake lock reference counted, false to |
| 656 | * make the wake lock non-reference counted. |
| 657 | */ |
| 658 | public void setReferenceCounted(boolean value) { |
| 659 | synchronized (mToken) { |
| 660 | mRefCounted = value; |
| 661 | } |
Mike Lockwood | f5bd092 | 2010-03-22 17:10:15 -0400 | [diff] [blame] | 662 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 663 | |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 664 | /** |
| 665 | * Acquires the wake lock. |
| 666 | * <p> |
| 667 | * Ensures that the device is on at the level requested when |
| 668 | * the wake lock was created. |
| 669 | * </p> |
| 670 | */ |
| 671 | public void acquire() { |
| 672 | synchronized (mToken) { |
| 673 | acquireLocked(); |
| 674 | } |
| 675 | } |
| 676 | |
| 677 | /** |
| 678 | * Acquires the wake lock with a timeout. |
| 679 | * <p> |
| 680 | * Ensures that the device is on at the level requested when |
| 681 | * the wake lock was created. The lock will be released after the given timeout |
| 682 | * expires. |
| 683 | * </p> |
| 684 | * |
| 685 | * @param timeout The timeout after which to release the wake lock, in milliseconds. |
| 686 | */ |
| 687 | public void acquire(long timeout) { |
| 688 | synchronized (mToken) { |
| 689 | acquireLocked(); |
| 690 | mHandler.postDelayed(mReleaser, timeout); |
| 691 | } |
| 692 | } |
| 693 | |
| 694 | private void acquireLocked() { |
| 695 | if (!mRefCounted || mCount++ == 0) { |
Jeff Brown | ff1baef | 2012-07-19 15:01:17 -0700 | [diff] [blame] | 696 | // Do this even if the wake lock is already thought to be held (mHeld == true) |
| 697 | // because non-reference counted wake locks are not always properly released. |
| 698 | // For example, the keyguard's wake lock might be forcibly released by the |
| 699 | // power manager without the keyguard knowing. A subsequent call to acquire |
| 700 | // should immediately acquire the wake lock once again despite never having |
| 701 | // been explicitly released by the keyguard. |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 702 | mHandler.removeCallbacks(mReleaser); |
Jeff Brown | ff1baef | 2012-07-19 15:01:17 -0700 | [diff] [blame] | 703 | try { |
Jeff Brown | 9630704 | 2012-07-27 15:51:34 -0700 | [diff] [blame] | 704 | mService.acquireWakeLock(mToken, mFlags, mTag, mWorkSource); |
Jeff Brown | ff1baef | 2012-07-19 15:01:17 -0700 | [diff] [blame] | 705 | } catch (RemoteException e) { |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 706 | } |
Jeff Brown | ff1baef | 2012-07-19 15:01:17 -0700 | [diff] [blame] | 707 | mHeld = true; |
Jeff Brown | 1244cda | 2012-06-19 16:44:46 -0700 | [diff] [blame] | 708 | } |
| 709 | } |
| 710 | |
| 711 | /** |
| 712 | * Releases the wake lock. |
| 713 | * <p> |
| 714 | * This method releases your claim to the CPU or screen being on. |
| 715 | * The screen may turn off shortly after you release the wake lock, or it may |
| 716 | * not if there are other wake locks still held. |
| 717 | * </p> |
| 718 | */ |
| 719 | public void release() { |
| 720 | release(0); |
| 721 | } |
| 722 | |
| 723 | /** |
| 724 | * Releases the wake lock with flags to modify the release behavior. |
| 725 | * <p> |
| 726 | * This method releases your claim to the CPU or screen being on. |
| 727 | * The screen may turn off shortly after you release the wake lock, or it may |
| 728 | * not if there are other wake locks still held. |
| 729 | * </p> |
| 730 | * |
| 731 | * @param flags Combination of flag values to modify the release behavior. |
| 732 | * Currently only {@link #WAIT_FOR_PROXIMITY_NEGATIVE} is supported. |
| 733 | * |
| 734 | * {@hide} |
| 735 | */ |
| 736 | public void release(int flags) { |
| 737 | synchronized (mToken) { |
| 738 | if (!mRefCounted || --mCount == 0) { |
| 739 | mHandler.removeCallbacks(mReleaser); |
| 740 | if (mHeld) { |
| 741 | try { |
| 742 | mService.releaseWakeLock(mToken, flags); |
| 743 | } catch (RemoteException e) { |
| 744 | } |
| 745 | mHeld = false; |
| 746 | } |
| 747 | } |
| 748 | if (mCount < 0) { |
| 749 | throw new RuntimeException("WakeLock under-locked " + mTag); |
| 750 | } |
| 751 | } |
| 752 | } |
| 753 | |
| 754 | /** |
| 755 | * Returns true if the wake lock has been acquired but not yet released. |
| 756 | * |
| 757 | * @return True if the wake lock is held. |
| 758 | */ |
| 759 | public boolean isHeld() { |
| 760 | synchronized (mToken) { |
| 761 | return mHeld; |
| 762 | } |
| 763 | } |
| 764 | |
| 765 | /** |
| 766 | * Sets the work source associated with the wake lock. |
| 767 | * <p> |
| 768 | * The work source is used to determine on behalf of which application |
| 769 | * the wake lock is being held. This is useful in the case where a |
| 770 | * service is performing work on behalf of an application so that the |
| 771 | * cost of that work can be accounted to the application. |
| 772 | * </p> |
| 773 | * |
| 774 | * @param ws The work source, or null if none. |
| 775 | */ |
| 776 | public void setWorkSource(WorkSource ws) { |
| 777 | synchronized (mToken) { |
| 778 | if (ws != null && ws.size() == 0) { |
| 779 | ws = null; |
| 780 | } |
| 781 | |
| 782 | final boolean changed; |
| 783 | if (ws == null) { |
| 784 | changed = mWorkSource != null; |
| 785 | mWorkSource = null; |
| 786 | } else if (mWorkSource == null) { |
| 787 | changed = true; |
| 788 | mWorkSource = new WorkSource(ws); |
| 789 | } else { |
| 790 | changed = mWorkSource.diff(ws); |
| 791 | if (changed) { |
| 792 | mWorkSource.set(ws); |
| 793 | } |
| 794 | } |
| 795 | |
| 796 | if (changed && mHeld) { |
| 797 | try { |
| 798 | mService.updateWakeLockWorkSource(mToken, mWorkSource); |
| 799 | } catch (RemoteException e) { |
| 800 | } |
| 801 | } |
| 802 | } |
| 803 | } |
| 804 | |
| 805 | @Override |
| 806 | public String toString() { |
| 807 | synchronized (mToken) { |
| 808 | return "WakeLock{" |
| 809 | + Integer.toHexString(System.identityHashCode(this)) |
| 810 | + " held=" + mHeld + ", refCount=" + mCount + "}"; |
| 811 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 812 | } |
| 813 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 814 | } |