blob: 3c7c962eaa12dd0a76133ceb175854cd6a37ad6a [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 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
17package android.os;
18
19import android.util.Log;
20import android.util.Printer;
21
22import java.lang.reflect.Modifier;
23
24/**
25 * A Handler allows you to send and process {@link Message} and Runnable
26 * objects associated with a thread's {@link MessageQueue}. Each Handler
27 * instance is associated with a single thread and that thread's message
28 * queue. When you create a new Handler, it is bound to the thread /
29 * message queue of the thread that is creating it -- from that point on,
30 * it will deliver messages and runnables to that message queue and execute
31 * them as they come out of the message queue.
32 *
33 * <p>There are two main uses for a Handler: (1) to schedule messages and
34 * runnables to be executed as some point in the future; and (2) to enqueue
35 * an action to be performed on a different thread than your own.
36 *
37 * <p>Scheduling messages is accomplished with the
38 * {@link #post}, {@link #postAtTime(Runnable, long)},
39 * {@link #postDelayed}, {@link #sendEmptyMessage},
40 * {@link #sendMessage}, {@link #sendMessageAtTime}, and
41 * {@link #sendMessageDelayed} methods. The <em>post</em> versions allow
42 * you to enqueue Runnable objects to be called by the message queue when
43 * they are received; the <em>sendMessage</em> versions allow you to enqueue
44 * a {@link Message} object containing a bundle of data that will be
45 * processed by the Handler's {@link #handleMessage} method (requiring that
46 * you implement a subclass of Handler).
47 *
48 * <p>When posting or sending to a Handler, you can either
49 * allow the item to be processed as soon as the message queue is ready
50 * to do so, or specify a delay before it gets processed or absolute time for
51 * it to be processed. The latter two allow you to implement timeouts,
52 * ticks, and other timing-based behavior.
53 *
54 * <p>When a
55 * process is created for your application, its main thread is dedicated to
56 * running a message queue that takes care of managing the top-level
57 * application objects (activities, broadcast receivers, etc) and any windows
58 * they create. You can create your own threads, and communicate back with
59 * the main application thread through a Handler. This is done by calling
60 * the same <em>post</em> or <em>sendMessage</em> methods as before, but from
Chris Palmer42855142010-09-09 17:04:31 -070061 * your new thread. The given Runnable or Message will then be scheduled
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080062 * in the Handler's message queue and processed when appropriate.
63 */
64public class Handler {
65 /*
66 * Set this flag to true to detect anonymous, local or member classes
67 * that extend this Handler class and that are not static. These kind
68 * of classes can potentially create leaks.
69 */
70 private static final boolean FIND_POTENTIAL_LEAKS = false;
71 private static final String TAG = "Handler";
72
73 /**
74 * Callback interface you can use when instantiating a Handler to avoid
75 * having to implement your own subclass of Handler.
Kristian Monsen1d3b4092013-06-05 17:06:32 -070076 *
77 * @param msg A {@link android.os.Message Message} object
78 * @return True if no further handling is desired
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080079 */
80 public interface Callback {
81 public boolean handleMessage(Message msg);
82 }
83
84 /**
85 * Subclasses must implement this to receive messages.
86 */
87 public void handleMessage(Message msg) {
88 }
89
90 /**
91 * Handle system messages here.
92 */
93 public void dispatchMessage(Message msg) {
94 if (msg.callback != null) {
95 handleCallback(msg);
96 } else {
97 if (mCallback != null) {
98 if (mCallback.handleMessage(msg)) {
99 return;
100 }
101 }
102 handleMessage(msg);
103 }
104 }
105
106 /**
Jeff Browna2910d02012-08-25 12:29:46 -0700107 * Default constructor associates this handler with the {@link Looper} for the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800108 * current thread.
109 *
Jeff Browna2910d02012-08-25 12:29:46 -0700110 * If this thread does not have a looper, this handler won't be able to receive messages
111 * so an exception is thrown.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800112 */
113 public Handler() {
Jeff Browna2910d02012-08-25 12:29:46 -0700114 this(null, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800115 }
116
117 /**
Jeff Browna2910d02012-08-25 12:29:46 -0700118 * Constructor associates this handler with the {@link Looper} for the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800119 * current thread and takes a callback interface in which you can handle
120 * messages.
Jeff Browna2910d02012-08-25 12:29:46 -0700121 *
122 * If this thread does not have a looper, this handler won't be able to receive messages
123 * so an exception is thrown.
124 *
125 * @param callback The callback interface in which to handle messages, or null.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800126 */
127 public Handler(Callback callback) {
Jeff Browna2910d02012-08-25 12:29:46 -0700128 this(callback, false);
129 }
130
131 /**
132 * Use the provided {@link Looper} instead of the default one.
133 *
134 * @param looper The looper, must not be null.
135 */
136 public Handler(Looper looper) {
137 this(looper, null, false);
138 }
139
140 /**
141 * Use the provided {@link Looper} instead of the default one and take a callback
142 * interface in which to handle messages.
143 *
144 * @param looper The looper, must not be null.
145 * @param callback The callback interface in which to handle messages, or null.
146 */
147 public Handler(Looper looper, Callback callback) {
148 this(looper, callback, false);
149 }
150
151 /**
152 * Use the {@link Looper} for the current thread
153 * and set whether the handler should be asynchronous.
154 *
155 * Handlers are synchronous by default unless this constructor is used to make
156 * one that is strictly asynchronous.
157 *
158 * Asynchronous messages represent interrupts or events that do not require global ordering
Jeff Brown9840c072014-11-11 20:21:21 -0800159 * with respect to synchronous messages. Asynchronous messages are not subject to
Jeff Browna2910d02012-08-25 12:29:46 -0700160 * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}.
161 *
162 * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for
163 * each {@link Message} that is sent to it or {@link Runnable} that is posted to it.
164 *
165 * @hide
166 */
167 public Handler(boolean async) {
168 this(null, async);
169 }
170
171 /**
172 * Use the {@link Looper} for the current thread with the specified callback interface
173 * and set whether the handler should be asynchronous.
174 *
175 * Handlers are synchronous by default unless this constructor is used to make
176 * one that is strictly asynchronous.
177 *
178 * Asynchronous messages represent interrupts or events that do not require global ordering
Jeff Brown9840c072014-11-11 20:21:21 -0800179 * with respect to synchronous messages. Asynchronous messages are not subject to
Jeff Browna2910d02012-08-25 12:29:46 -0700180 * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}.
181 *
182 * @param callback The callback interface in which to handle messages, or null.
183 * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for
184 * each {@link Message} that is sent to it or {@link Runnable} that is posted to it.
185 *
186 * @hide
187 */
188 public Handler(Callback callback, boolean async) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800189 if (FIND_POTENTIAL_LEAKS) {
190 final Class<? extends Handler> klass = getClass();
191 if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) &&
192 (klass.getModifiers() & Modifier.STATIC) == 0) {
193 Log.w(TAG, "The following Handler class should be static or leaks might occur: " +
194 klass.getCanonicalName());
195 }
196 }
197
198 mLooper = Looper.myLooper();
199 if (mLooper == null) {
200 throw new RuntimeException(
201 "Can't create handler inside thread that has not called Looper.prepare()");
202 }
203 mQueue = mLooper.mQueue;
204 mCallback = callback;
Jeff Browna2910d02012-08-25 12:29:46 -0700205 mAsynchronous = async;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800206 }
207
208 /**
Jeff Browna2910d02012-08-25 12:29:46 -0700209 * Use the provided {@link Looper} instead of the default one and take a callback
Jeff Brown109025d2012-08-14 20:41:30 -0700210 * interface in which to handle messages. Also set whether the handler
211 * should be asynchronous.
212 *
213 * Handlers are synchronous by default unless this constructor is used to make
214 * one that is strictly asynchronous.
215 *
216 * Asynchronous messages represent interrupts or events that do not require global ordering
Jeff Brown9840c072014-11-11 20:21:21 -0800217 * with respect to synchronous messages. Asynchronous messages are not subject to
Jeff Brown109025d2012-08-14 20:41:30 -0700218 * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}.
219 *
Jeff Browna2910d02012-08-25 12:29:46 -0700220 * @param looper The looper, must not be null.
221 * @param callback The callback interface in which to handle messages, or null.
Jeff Brown109025d2012-08-14 20:41:30 -0700222 * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for
223 * each {@link Message} that is sent to it or {@link Runnable} that is posted to it.
224 *
225 * @hide
226 */
227 public Handler(Looper looper, Callback callback, boolean async) {
228 mLooper = looper;
229 mQueue = looper.mQueue;
230 mCallback = callback;
231 mAsynchronous = async;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800232 }
233
Jeff Sharkey74cd3de2016-04-06 17:40:54 -0600234 /** {@hide} */
235 public String getTraceName(Message message) {
236 final StringBuilder sb = new StringBuilder();
237 sb.append(getClass().getName()).append(": ");
238 if (message.callback != null) {
239 sb.append(message.callback.getClass().getName());
240 } else {
241 sb.append("#").append(message.what);
242 }
243 return sb.toString();
244 }
245
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800246 /**
Romain Guyf9284692011-07-13 18:46:21 -0700247 * Returns a string representing the name of the specified message.
248 * The default implementation will either return the class name of the
249 * message callback if any, or the hexadecimal representation of the
250 * message "what" field.
251 *
252 * @param message The message whose name is being queried
253 */
254 public String getMessageName(Message message) {
255 if (message.callback != null) {
256 return message.callback.getClass().getName();
257 }
258 return "0x" + Integer.toHexString(message.what);
259 }
260
261 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800262 * Returns a new {@link android.os.Message Message} from the global message pool. More efficient than
263 * creating and allocating new instances. The retrieved message has its handler set to this instance (Message.target == this).
264 * If you don't want that facility, just call Message.obtain() instead.
265 */
266 public final Message obtainMessage()
267 {
268 return Message.obtain(this);
269 }
270
271 /**
272 * Same as {@link #obtainMessage()}, except that it also sets the what member of the returned Message.
273 *
274 * @param what Value to assign to the returned Message.what field.
275 * @return A Message from the global message pool.
276 */
277 public final Message obtainMessage(int what)
278 {
279 return Message.obtain(this, what);
280 }
281
282 /**
283 *
284 * Same as {@link #obtainMessage()}, except that it also sets the what and obj members
285 * of the returned Message.
286 *
287 * @param what Value to assign to the returned Message.what field.
288 * @param obj Value to assign to the returned Message.obj field.
289 * @return A Message from the global message pool.
290 */
291 public final Message obtainMessage(int what, Object obj)
292 {
293 return Message.obtain(this, what, obj);
294 }
295
296 /**
297 *
298 * Same as {@link #obtainMessage()}, except that it also sets the what, arg1 and arg2 members of the returned
299 * Message.
300 * @param what Value to assign to the returned Message.what field.
301 * @param arg1 Value to assign to the returned Message.arg1 field.
302 * @param arg2 Value to assign to the returned Message.arg2 field.
303 * @return A Message from the global message pool.
304 */
305 public final Message obtainMessage(int what, int arg1, int arg2)
306 {
307 return Message.obtain(this, what, arg1, arg2);
308 }
309
310 /**
311 *
312 * Same as {@link #obtainMessage()}, except that it also sets the what, obj, arg1,and arg2 values on the
313 * returned Message.
314 * @param what Value to assign to the returned Message.what field.
315 * @param arg1 Value to assign to the returned Message.arg1 field.
316 * @param arg2 Value to assign to the returned Message.arg2 field.
317 * @param obj Value to assign to the returned Message.obj field.
318 * @return A Message from the global message pool.
319 */
320 public final Message obtainMessage(int what, int arg1, int arg2, Object obj)
321 {
322 return Message.obtain(this, what, arg1, arg2, obj);
323 }
324
325 /**
326 * Causes the Runnable r to be added to the message queue.
327 * The runnable will be run on the thread to which this handler is
328 * attached.
329 *
330 * @param r The Runnable that will be executed.
331 *
332 * @return Returns true if the Runnable was successfully placed in to the
333 * message queue. Returns false on failure, usually because the
334 * looper processing the message queue is exiting.
335 */
336 public final boolean post(Runnable r)
337 {
338 return sendMessageDelayed(getPostMessage(r), 0);
339 }
340
341 /**
342 * Causes the Runnable r to be added to the message queue, to be run
343 * at a specific time given by <var>uptimeMillis</var>.
344 * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b>
David Christiea8cf4f22013-12-19 18:30:06 -0800345 * Time spent in deep sleep will add an additional delay to execution.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800346 * The runnable will be run on the thread to which this handler is attached.
347 *
348 * @param r The Runnable that will be executed.
349 * @param uptimeMillis The absolute time at which the callback should run,
350 * using the {@link android.os.SystemClock#uptimeMillis} time-base.
351 *
352 * @return Returns true if the Runnable was successfully placed in to the
353 * message queue. Returns false on failure, usually because the
354 * looper processing the message queue is exiting. Note that a
355 * result of true does not mean the Runnable will be processed -- if
356 * the looper is quit before the delivery time of the message
357 * occurs then the message will be dropped.
358 */
359 public final boolean postAtTime(Runnable r, long uptimeMillis)
360 {
361 return sendMessageAtTime(getPostMessage(r), uptimeMillis);
362 }
363
364 /**
365 * Causes the Runnable r to be added to the message queue, to be run
366 * at a specific time given by <var>uptimeMillis</var>.
367 * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b>
David Christiea8cf4f22013-12-19 18:30:06 -0800368 * Time spent in deep sleep will add an additional delay to execution.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800369 * The runnable will be run on the thread to which this handler is attached.
370 *
371 * @param r The Runnable that will be executed.
372 * @param uptimeMillis The absolute time at which the callback should run,
373 * using the {@link android.os.SystemClock#uptimeMillis} time-base.
374 *
375 * @return Returns true if the Runnable was successfully placed in to the
376 * message queue. Returns false on failure, usually because the
377 * looper processing the message queue is exiting. Note that a
378 * result of true does not mean the Runnable will be processed -- if
379 * the looper is quit before the delivery time of the message
380 * occurs then the message will be dropped.
381 *
382 * @see android.os.SystemClock#uptimeMillis
383 */
384 public final boolean postAtTime(Runnable r, Object token, long uptimeMillis)
385 {
386 return sendMessageAtTime(getPostMessage(r, token), uptimeMillis);
387 }
388
389 /**
390 * Causes the Runnable r to be added to the message queue, to be run
391 * after the specified amount of time elapses.
392 * The runnable will be run on the thread to which this handler
393 * is attached.
David Christiea8cf4f22013-12-19 18:30:06 -0800394 * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b>
395 * Time spent in deep sleep will add an additional delay to execution.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800396 *
397 * @param r The Runnable that will be executed.
398 * @param delayMillis The delay (in milliseconds) until the Runnable
399 * will be executed.
400 *
401 * @return Returns true if the Runnable was successfully placed in to the
402 * message queue. Returns false on failure, usually because the
403 * looper processing the message queue is exiting. Note that a
404 * result of true does not mean the Runnable will be processed --
405 * if the looper is quit before the delivery time of the message
406 * occurs then the message will be dropped.
407 */
408 public final boolean postDelayed(Runnable r, long delayMillis)
409 {
410 return sendMessageDelayed(getPostMessage(r), delayMillis);
411 }
412
413 /**
414 * Posts a message to an object that implements Runnable.
415 * Causes the Runnable r to executed on the next iteration through the
416 * message queue. The runnable will be run on the thread to which this
417 * handler is attached.
418 * <b>This method is only for use in very special circumstances -- it
419 * can easily starve the message queue, cause ordering problems, or have
420 * other unexpected side-effects.</b>
421 *
422 * @param r The Runnable that will be executed.
423 *
424 * @return Returns true if the message was successfully placed in to the
425 * message queue. Returns false on failure, usually because the
426 * looper processing the message queue is exiting.
427 */
428 public final boolean postAtFrontOfQueue(Runnable r)
429 {
430 return sendMessageAtFrontOfQueue(getPostMessage(r));
431 }
432
433 /**
Jeff Brownc53abc42012-08-29 04:43:25 -0700434 * Runs the specified task synchronously.
Jeff Brown8b60e452013-04-18 15:17:48 -0700435 * <p>
Jeff Brownc53abc42012-08-29 04:43:25 -0700436 * If the current thread is the same as the handler thread, then the runnable
437 * runs immediately without being enqueued. Otherwise, posts the runnable
438 * to the handler and waits for it to complete before returning.
Jeff Brown8b60e452013-04-18 15:17:48 -0700439 * </p><p>
Jeff Brownc53abc42012-08-29 04:43:25 -0700440 * This method is dangerous! Improper use can result in deadlocks.
441 * Never call this method while any locks are held or use it in a
442 * possibly re-entrant manner.
Jeff Brown8b60e452013-04-18 15:17:48 -0700443 * </p><p>
Jeff Brownc53abc42012-08-29 04:43:25 -0700444 * This method is occasionally useful in situations where a background thread
445 * must synchronously await completion of a task that must run on the
446 * handler's thread. However, this problem is often a symptom of bad design.
447 * Consider improving the design (if possible) before resorting to this method.
Jeff Brown8b60e452013-04-18 15:17:48 -0700448 * </p><p>
Jeff Brownc53abc42012-08-29 04:43:25 -0700449 * One example of where you might want to use this method is when you just
450 * set up a Handler thread and need to perform some initialization steps on
451 * it before continuing execution.
Jeff Brown8b60e452013-04-18 15:17:48 -0700452 * </p><p>
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700453 * If timeout occurs then this method returns <code>false</code> but the runnable
454 * will remain posted on the handler and may already be in progress or
455 * complete at a later time.
Jeff Brown8b60e452013-04-18 15:17:48 -0700456 * </p><p>
457 * When using this method, be sure to use {@link Looper#quitSafely} when
458 * quitting the looper. Otherwise {@link #runWithScissors} may hang indefinitely.
459 * (TODO: We should fix this by making MessageQueue aware of blocking runnables.)
460 * </p>
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700461 *
Jeff Brownc53abc42012-08-29 04:43:25 -0700462 * @param r The Runnable that will be executed synchronously.
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700463 * @param timeout The timeout in milliseconds, or 0 to wait indefinitely.
Jeff Brownc53abc42012-08-29 04:43:25 -0700464 *
465 * @return Returns true if the Runnable was successfully executed.
466 * Returns false on failure, usually because the
467 * looper processing the message queue is exiting.
468 *
469 * @hide This method is prone to abuse and should probably not be in the API.
470 * If we ever do make it part of the API, we might want to rename it to something
471 * less funny like runUnsafe().
472 */
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700473 public final boolean runWithScissors(final Runnable r, long timeout) {
Jeff Brownc53abc42012-08-29 04:43:25 -0700474 if (r == null) {
475 throw new IllegalArgumentException("runnable must not be null");
476 }
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700477 if (timeout < 0) {
478 throw new IllegalArgumentException("timeout must be non-negative");
479 }
Jeff Brownc53abc42012-08-29 04:43:25 -0700480
481 if (Looper.myLooper() == mLooper) {
482 r.run();
483 return true;
484 }
485
486 BlockingRunnable br = new BlockingRunnable(r);
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700487 return br.postAndWait(this, timeout);
Jeff Brownc53abc42012-08-29 04:43:25 -0700488 }
489
490 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800491 * Remove any pending posts of Runnable r that are in the message queue.
492 */
493 public final void removeCallbacks(Runnable r)
494 {
495 mQueue.removeMessages(this, r, null);
496 }
497
498 /**
499 * Remove any pending posts of Runnable <var>r</var> with Object
Dianne Hackborn466ed242011-07-21 18:16:31 -0700500 * <var>token</var> that are in the message queue. If <var>token</var> is null,
501 * all callbacks will be removed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800502 */
503 public final void removeCallbacks(Runnable r, Object token)
504 {
505 mQueue.removeMessages(this, r, token);
506 }
507
508 /**
509 * Pushes a message onto the end of the message queue after all pending messages
510 * before the current time. It will be received in {@link #handleMessage},
511 * in the thread attached to this handler.
512 *
513 * @return Returns true if the message was successfully placed in to the
514 * message queue. Returns false on failure, usually because the
515 * looper processing the message queue is exiting.
516 */
517 public final boolean sendMessage(Message msg)
518 {
519 return sendMessageDelayed(msg, 0);
520 }
521
522 /**
523 * Sends a Message containing only the what value.
524 *
525 * @return Returns true if the message was successfully placed in to the
526 * message queue. Returns false on failure, usually because the
527 * looper processing the message queue is exiting.
528 */
529 public final boolean sendEmptyMessage(int what)
530 {
531 return sendEmptyMessageDelayed(what, 0);
532 }
533
534 /**
535 * Sends a Message containing only the what value, to be delivered
536 * after the specified amount of time elapses.
537 * @see #sendMessageDelayed(android.os.Message, long)
538 *
539 * @return Returns true if the message was successfully placed in to the
540 * message queue. Returns false on failure, usually because the
541 * looper processing the message queue is exiting.
542 */
543 public final boolean sendEmptyMessageDelayed(int what, long delayMillis) {
544 Message msg = Message.obtain();
545 msg.what = what;
546 return sendMessageDelayed(msg, delayMillis);
547 }
548
549 /**
550 * Sends a Message containing only the what value, to be delivered
551 * at a specific time.
552 * @see #sendMessageAtTime(android.os.Message, long)
553 *
554 * @return Returns true if the message was successfully placed in to the
555 * message queue. Returns false on failure, usually because the
556 * looper processing the message queue is exiting.
557 */
558
559 public final boolean sendEmptyMessageAtTime(int what, long uptimeMillis) {
560 Message msg = Message.obtain();
561 msg.what = what;
562 return sendMessageAtTime(msg, uptimeMillis);
563 }
564
565 /**
566 * Enqueue a message into the message queue after all pending messages
567 * before (current time + delayMillis). You will receive it in
568 * {@link #handleMessage}, in the thread attached to this handler.
569 *
570 * @return Returns true if the message was successfully placed in to the
571 * message queue. Returns false on failure, usually because the
572 * looper processing the message queue is exiting. Note that a
573 * result of true does not mean the message will be processed -- if
574 * the looper is quit before the delivery time of the message
575 * occurs then the message will be dropped.
576 */
577 public final boolean sendMessageDelayed(Message msg, long delayMillis)
578 {
579 if (delayMillis < 0) {
580 delayMillis = 0;
581 }
582 return sendMessageAtTime(msg, SystemClock.uptimeMillis() + delayMillis);
583 }
584
585 /**
586 * Enqueue a message into the message queue after all pending messages
587 * before the absolute time (in milliseconds) <var>uptimeMillis</var>.
588 * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b>
David Christiea8cf4f22013-12-19 18:30:06 -0800589 * Time spent in deep sleep will add an additional delay to execution.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800590 * You will receive it in {@link #handleMessage}, in the thread attached
591 * to this handler.
592 *
593 * @param uptimeMillis The absolute time at which the message should be
594 * delivered, using the
595 * {@link android.os.SystemClock#uptimeMillis} time-base.
596 *
597 * @return Returns true if the message was successfully placed in to the
598 * message queue. Returns false on failure, usually because the
599 * looper processing the message queue is exiting. Note that a
600 * result of true does not mean the message will be processed -- if
601 * the looper is quit before the delivery time of the message
602 * occurs then the message will be dropped.
603 */
Jeff Brown109025d2012-08-14 20:41:30 -0700604 public boolean sendMessageAtTime(Message msg, long uptimeMillis) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800605 MessageQueue queue = mQueue;
Jeff Brown109025d2012-08-14 20:41:30 -0700606 if (queue == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800607 RuntimeException e = new RuntimeException(
Jeff Brown109025d2012-08-14 20:41:30 -0700608 this + " sendMessageAtTime() called with no mQueue");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800609 Log.w("Looper", e.getMessage(), e);
Jeff Brown109025d2012-08-14 20:41:30 -0700610 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800611 }
Jeff Brown109025d2012-08-14 20:41:30 -0700612 return enqueueMessage(queue, msg, uptimeMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800613 }
614
615 /**
616 * Enqueue a message at the front of the message queue, to be processed on
617 * the next iteration of the message loop. You will receive it in
618 * {@link #handleMessage}, in the thread attached to this handler.
619 * <b>This method is only for use in very special circumstances -- it
620 * can easily starve the message queue, cause ordering problems, or have
621 * other unexpected side-effects.</b>
622 *
623 * @return Returns true if the message was successfully placed in to the
624 * message queue. Returns false on failure, usually because the
625 * looper processing the message queue is exiting.
626 */
Jeff Brown109025d2012-08-14 20:41:30 -0700627 public final boolean sendMessageAtFrontOfQueue(Message msg) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800628 MessageQueue queue = mQueue;
Jeff Brown109025d2012-08-14 20:41:30 -0700629 if (queue == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800630 RuntimeException e = new RuntimeException(
631 this + " sendMessageAtTime() called with no mQueue");
632 Log.w("Looper", e.getMessage(), e);
Jeff Brown109025d2012-08-14 20:41:30 -0700633 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800634 }
Jeff Brown109025d2012-08-14 20:41:30 -0700635 return enqueueMessage(queue, msg, 0);
636 }
637
638 private boolean enqueueMessage(MessageQueue queue, Message msg, long uptimeMillis) {
639 msg.target = this;
640 if (mAsynchronous) {
641 msg.setAsynchronous(true);
642 }
643 return queue.enqueueMessage(msg, uptimeMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800644 }
645
646 /**
647 * Remove any pending posts of messages with code 'what' that are in the
648 * message queue.
649 */
650 public final void removeMessages(int what) {
Jeff Brown0f85ce32012-02-16 14:41:10 -0800651 mQueue.removeMessages(this, what, null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800652 }
653
654 /**
655 * Remove any pending posts of messages with code 'what' and whose obj is
Jeff Brown32c81132012-04-30 16:28:32 -0700656 * 'object' that are in the message queue. If <var>object</var> is null,
Dianne Hackborn466ed242011-07-21 18:16:31 -0700657 * all messages will be removed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800658 */
659 public final void removeMessages(int what, Object object) {
Jeff Brown0f85ce32012-02-16 14:41:10 -0800660 mQueue.removeMessages(this, what, object);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800661 }
662
663 /**
664 * Remove any pending posts of callbacks and sent messages whose
Dianne Hackborn466ed242011-07-21 18:16:31 -0700665 * <var>obj</var> is <var>token</var>. If <var>token</var> is null,
666 * all callbacks and messages will be removed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800667 */
668 public final void removeCallbacksAndMessages(Object token) {
669 mQueue.removeCallbacksAndMessages(this, token);
670 }
671
672 /**
673 * Check if there are any pending posts of messages with code 'what' in
674 * the message queue.
675 */
676 public final boolean hasMessages(int what) {
Jeff Brown0f85ce32012-02-16 14:41:10 -0800677 return mQueue.hasMessages(this, what, null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800678 }
679
680 /**
681 * Check if there are any pending posts of messages with code 'what' and
682 * whose obj is 'object' in the message queue.
683 */
684 public final boolean hasMessages(int what, Object object) {
Jeff Brown0f85ce32012-02-16 14:41:10 -0800685 return mQueue.hasMessages(this, what, object);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800686 }
687
Romain Guyba6be8a2012-04-23 18:22:09 -0700688 /**
689 * Check if there are any pending posts of messages with callback r in
690 * the message queue.
691 *
692 * @hide
693 */
694 public final boolean hasCallbacks(Runnable r) {
695 return mQueue.hasMessages(this, r, null);
696 }
697
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800698 // if we can get rid of this method, the handler need not remember its loop
699 // we could instead export a getMessageQueue() method...
700 public final Looper getLooper() {
701 return mLooper;
702 }
703
704 public final void dump(Printer pw, String prefix) {
705 pw.println(prefix + this + " @ " + SystemClock.uptimeMillis());
706 if (mLooper == null) {
707 pw.println(prefix + "looper uninitialized");
708 } else {
709 mLooper.dump(pw, prefix + " ");
710 }
711 }
712
713 @Override
714 public String toString() {
Kristian Monsen588d8562011-08-04 12:55:33 +0100715 return "Handler (" + getClass().getName() + ") {"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800716 + Integer.toHexString(System.identityHashCode(this))
717 + "}";
718 }
719
720 final IMessenger getIMessenger() {
721 synchronized (mQueue) {
722 if (mMessenger != null) {
723 return mMessenger;
724 }
725 mMessenger = new MessengerImpl();
726 return mMessenger;
727 }
728 }
Brad Fitzpatrick333b8cb2010-08-26 12:04:57 -0700729
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800730 private final class MessengerImpl extends IMessenger.Stub {
731 public void send(Message msg) {
Dianne Hackborncb3ed1d2014-06-27 18:37:06 -0700732 msg.sendingUid = Binder.getCallingUid();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800733 Handler.this.sendMessage(msg);
734 }
735 }
Brad Fitzpatrick333b8cb2010-08-26 12:04:57 -0700736
Romain Guyba6be8a2012-04-23 18:22:09 -0700737 private static Message getPostMessage(Runnable r) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800738 Message m = Message.obtain();
739 m.callback = r;
740 return m;
741 }
742
Romain Guyba6be8a2012-04-23 18:22:09 -0700743 private static Message getPostMessage(Runnable r, Object token) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800744 Message m = Message.obtain();
745 m.obj = token;
746 m.callback = r;
747 return m;
748 }
749
Romain Guyba6be8a2012-04-23 18:22:09 -0700750 private static void handleCallback(Message message) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800751 message.callback.run();
752 }
753
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800754 final Looper mLooper;
Jeff Sharkey74cd3de2016-04-06 17:40:54 -0600755 final MessageQueue mQueue;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800756 final Callback mCallback;
Jeff Brown109025d2012-08-14 20:41:30 -0700757 final boolean mAsynchronous;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800758 IMessenger mMessenger;
Jeff Brownc53abc42012-08-29 04:43:25 -0700759
760 private static final class BlockingRunnable implements Runnable {
761 private final Runnable mTask;
762 private boolean mDone;
763
764 public BlockingRunnable(Runnable task) {
765 mTask = task;
766 }
767
768 @Override
769 public void run() {
770 try {
771 mTask.run();
772 } finally {
773 synchronized (this) {
774 mDone = true;
775 notifyAll();
776 }
777 }
778 }
779
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700780 public boolean postAndWait(Handler handler, long timeout) {
Jeff Brownc53abc42012-08-29 04:43:25 -0700781 if (!handler.post(this)) {
782 return false;
783 }
784
785 synchronized (this) {
Jeff Brown4ed8fe72012-08-30 18:18:29 -0700786 if (timeout > 0) {
787 final long expirationTime = SystemClock.uptimeMillis() + timeout;
788 while (!mDone) {
789 long delay = expirationTime - SystemClock.uptimeMillis();
790 if (delay <= 0) {
791 return false; // timeout
792 }
793 try {
794 wait(delay);
795 } catch (InterruptedException ex) {
796 }
797 }
798 } else {
799 while (!mDone) {
800 try {
801 wait();
802 } catch (InterruptedException ex) {
803 }
Jeff Brownc53abc42012-08-29 04:43:25 -0700804 }
805 }
806 }
807 return true;
808 }
809 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800810}