19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.os; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Log; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Printer; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.Modifier; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A Handler allows you to send and process {@link Message} and Runnable 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * objects associated with a thread's {@link MessageQueue}. Each Handler 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * instance is associated with a single thread and that thread's message 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * queue. When you create a new Handler, it is bound to the thread / 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue of the thread that is creating it -- from that point on, 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it will deliver messages and runnables to that message queue and execute 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * them as they come out of the message queue. 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>There are two main uses for a Handler: (1) to schedule messages and 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * runnables to be executed as some point in the future; and (2) to enqueue 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * an action to be performed on a different thread than your own. 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Scheduling messages is accomplished with the 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #post}, {@link #postAtTime(Runnable, long)}, 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #postDelayed}, {@link #sendEmptyMessage}, 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #sendMessage}, {@link #sendMessageAtTime}, and 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #sendMessageDelayed} methods. The <em>post</em> versions allow 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you to enqueue Runnable objects to be called by the message queue when 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * they are received; the <em>sendMessage</em> versions allow you to enqueue 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a {@link Message} object containing a bundle of data that will be 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * processed by the Handler's {@link #handleMessage} method (requiring that 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you implement a subclass of Handler). 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>When posting or sending to a Handler, you can either 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * allow the item to be processed as soon as the message queue is ready 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to do so, or specify a delay before it gets processed or absolute time for 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it to be processed. The latter two allow you to implement timeouts, 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ticks, and other timing-based behavior. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>When a 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * process is created for your application, its main thread is dedicated to 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * running a message queue that takes care of managing the top-level 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * application objects (activities, broadcast receivers, etc) and any windows 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * they create. You can create your own threads, and communicate back with 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the main application thread through a Handler. This is done by calling 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the same <em>post</em> or <em>sendMessage</em> methods as before, but from 6142855149750fb848b0d743cf0e5f204a05be2f07Chris Palmer * your new thread. The given Runnable or Message will then be scheduled 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the Handler's message queue and processed when appropriate. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class Handler { 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set this flag to true to detect anonymous, local or member classes 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that extend this Handler class and that are not static. These kind 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of classes can potentially create leaks. 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final boolean FIND_POTENTIAL_LEAKS = false; 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final String TAG = "Handler"; 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Callback interface you can use when instantiating a Handler to avoid 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * having to implement your own subclass of Handler. 761d3b409cd93f803aa7a0bbafa2ac5fa90866bc33Kristian Monsen * 771d3b409cd93f803aa7a0bbafa2ac5fa90866bc33Kristian Monsen * @param msg A {@link android.os.Message Message} object 781d3b409cd93f803aa7a0bbafa2ac5fa90866bc33Kristian Monsen * @return True if no further handling is desired 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface Callback { 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean handleMessage(Message msg); 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Subclasses must implement this to receive messages. 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void handleMessage(Message msg) { 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Handle system messages here. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void dispatchMessage(Message msg) { 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (msg.callback != null) { 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project handleCallback(msg); 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mCallback != null) { 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mCallback.handleMessage(msg)) { 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project handleMessage(msg); 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 107a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Default constructor associates this handler with the {@link Looper} for the 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current thread. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 110a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * If this thread does not have a looper, this handler won't be able to receive messages 111a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * so an exception is thrown. 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler() { 114a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(null, false); 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 118a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Constructor associates this handler with the {@link Looper} for the 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current thread and takes a callback interface in which you can handle 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * messages. 121a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 122a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * If this thread does not have a looper, this handler won't be able to receive messages 123a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * so an exception is thrown. 124a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 125a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler(Callback callback) { 128a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(callback, false); 129a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 130a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 131a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 132a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the provided {@link Looper} instead of the default one. 133a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 134a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param looper The looper, must not be null. 135a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 136a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(Looper looper) { 137a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(looper, null, false); 138a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 139a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 140a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 141a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the provided {@link Looper} instead of the default one and take a callback 142a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * interface in which to handle messages. 143a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 144a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param looper The looper, must not be null. 145a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 146a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 147a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(Looper looper, Callback callback) { 148a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(looper, callback, false); 149a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 150a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 151a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 152a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the {@link Looper} for the current thread 153a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * and set whether the handler should be asynchronous. 154a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 155a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Handlers are synchronous by default unless this constructor is used to make 156a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * one that is strictly asynchronous. 157a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 158a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Asynchronous messages represent interrupts or events that do not require global ordering 159a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * with represent to synchronous messages. Asynchronous messages are not subject to 160a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}. 161a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 162a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for 163a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * each {@link Message} that is sent to it or {@link Runnable} that is posted to it. 164a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 165a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @hide 166a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 167a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(boolean async) { 168a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(null, async); 169a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 170a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 171a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 172a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the {@link Looper} for the current thread with the specified callback interface 173a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * and set whether the handler should be asynchronous. 174a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 175a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Handlers are synchronous by default unless this constructor is used to make 176a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * one that is strictly asynchronous. 177a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 178a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Asynchronous messages represent interrupts or events that do not require global ordering 179a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * with represent to synchronous messages. Asynchronous messages are not subject to 180a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}. 181a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 182a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 183a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for 184a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * each {@link Message} that is sent to it or {@link Runnable} that is posted to it. 185a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 186a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @hide 187a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 188a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(Callback callback, boolean async) { 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (FIND_POTENTIAL_LEAKS) { 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Class<? extends Handler> klass = getClass(); 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) && 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (klass.getModifiers() & Modifier.STATIC) == 0) { 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w(TAG, "The following Handler class should be static or leaks might occur: " + 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project klass.getCanonicalName()); 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper = Looper.myLooper(); 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new RuntimeException( 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Can't create handler inside thread that has not called Looper.prepare()"); 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue = mLooper.mQueue; 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCallback = callback; 205a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown mAsynchronous = async; 206109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown } 207109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown 208109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown /** 209a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the provided {@link Looper} instead of the default one and take a callback 210109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * interface in which to handle messages. Also set whether the handler 211109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * should be asynchronous. 212109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 213109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * Handlers are synchronous by default unless this constructor is used to make 214109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * one that is strictly asynchronous. 215109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 216109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * Asynchronous messages represent interrupts or events that do not require global ordering 217109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * with represent to synchronous messages. Asynchronous messages are not subject to 218109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}. 219109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 220a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param looper The looper, must not be null. 221a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 222109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for 223109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * each {@link Message} that is sent to it or {@link Runnable} that is posted to it. 224109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 225109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * @hide 226109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown */ 227109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown public Handler(Looper looper, Callback callback, boolean async) { 228109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mLooper = looper; 229109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mQueue = looper.mQueue; 230109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mCallback = callback; 231109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mAsynchronous = async; 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 235f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * Returns a string representing the name of the specified message. 236f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * The default implementation will either return the class name of the 237f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * message callback if any, or the hexadecimal representation of the 238f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * message "what" field. 239f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * 240f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * @param message The message whose name is being queried 241f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy */ 242f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy public String getMessageName(Message message) { 243f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy if (message.callback != null) { 244f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy return message.callback.getClass().getName(); 245f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy } 246f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy return "0x" + Integer.toHexString(message.what); 247f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy } 248f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy 249f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy /** 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns a new {@link android.os.Message Message} from the global message pool. More efficient than 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * creating and allocating new instances. The retrieved message has its handler set to this instance (Message.target == this). 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If you don't want that facility, just call Message.obtain() instead. 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage() 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this); 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what member of the returned Message. 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what) 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what); 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what and obj members 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of the returned Message. 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param obj Value to assign to the returned Message.obj field. 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, Object obj) 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, obj); 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what, arg1 and arg2 members of the returned 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Message. 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg1 Value to assign to the returned Message.arg1 field. 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg2 Value to assign to the returned Message.arg2 field. 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, int arg1, int arg2) 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, arg1, arg2); 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what, obj, arg1,and arg2 values on the 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * returned Message. 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg1 Value to assign to the returned Message.arg1 field. 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg2 Value to assign to the returned Message.arg2 field. 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param obj Value to assign to the returned Message.obj field. 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, int arg1, int arg2, Object obj) 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, arg1, arg2, obj); 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue. 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attached. 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean post(Runnable r) 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(getPostMessage(r), 0); 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time given by <var>uptimeMillis</var>. 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is attached. 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the callback should run, 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using the {@link android.os.SystemClock#uptimeMillis} time-base. 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- if 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtTime(Runnable r, long uptimeMillis) 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(getPostMessage(r), uptimeMillis); 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time given by <var>uptimeMillis</var>. 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is attached. 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the callback should run, 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using the {@link android.os.SystemClock#uptimeMillis} time-base. 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- if 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see android.os.SystemClock#uptimeMillis 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtTime(Runnable r, Object token, long uptimeMillis) 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(getPostMessage(r, token), uptimeMillis); 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the specified amount of time elapses. 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is attached. 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param delayMillis The delay (in milliseconds) until the Runnable 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be executed. 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if the looper is quit before the delivery time of the message 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postDelayed(Runnable r, long delayMillis) 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(getPostMessage(r), delayMillis); 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Posts a message to an object that implements Runnable. 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to executed on the next iteration through the 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. The runnable will be run on the thread to which this 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * handler is attached. 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>This method is only for use in very special circumstances -- it 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily starve the message queue, cause ordering problems, or have 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other unexpected side-effects.</b> 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtFrontOfQueue(Runnable r) 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtFrontOfQueue(getPostMessage(r)); 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 418c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Runs the specified task synchronously. 4198b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * <p> 420c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * If the current thread is the same as the handler thread, then the runnable 421c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * runs immediately without being enqueued. Otherwise, posts the runnable 422c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * to the handler and waits for it to complete before returning. 4238b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * </p><p> 424c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * This method is dangerous! Improper use can result in deadlocks. 425c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Never call this method while any locks are held or use it in a 426c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * possibly re-entrant manner. 4278b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * </p><p> 428c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * This method is occasionally useful in situations where a background thread 429c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * must synchronously await completion of a task that must run on the 430c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * handler's thread. However, this problem is often a symptom of bad design. 431c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Consider improving the design (if possible) before resorting to this method. 4328b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * </p><p> 433c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * One example of where you might want to use this method is when you just 434c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * set up a Handler thread and need to perform some initialization steps on 435c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * it before continuing execution. 4368b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * </p><p> 4374ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * If timeout occurs then this method returns <code>false</code> but the runnable 4384ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * will remain posted on the handler and may already be in progress or 4394ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * complete at a later time. 4408b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * </p><p> 4418b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * When using this method, be sure to use {@link Looper#quitSafely} when 4428b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * quitting the looper. Otherwise {@link #runWithScissors} may hang indefinitely. 4438b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * (TODO: We should fix this by making MessageQueue aware of blocking runnables.) 4448b60e4514702edd1eb4b6f2bfc027e04a94369c0Jeff Brown * </p> 4454ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * 446c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * @param r The Runnable that will be executed synchronously. 4474ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * @param timeout The timeout in milliseconds, or 0 to wait indefinitely. 448c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 449c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * @return Returns true if the Runnable was successfully executed. 450c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Returns false on failure, usually because the 451c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * looper processing the message queue is exiting. 452c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 453c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * @hide This method is prone to abuse and should probably not be in the API. 454c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * If we ever do make it part of the API, we might want to rename it to something 455c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * less funny like runUnsafe(). 456c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown */ 4574ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown public final boolean runWithScissors(final Runnable r, long timeout) { 458c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown if (r == null) { 459c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown throw new IllegalArgumentException("runnable must not be null"); 460c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 4614ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown if (timeout < 0) { 4624ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown throw new IllegalArgumentException("timeout must be non-negative"); 4634ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 464c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 465c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown if (Looper.myLooper() == mLooper) { 466c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown r.run(); 467c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown return true; 468c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 469c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 470c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown BlockingRunnable br = new BlockingRunnable(r); 4714ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown return br.postAndWait(this, timeout); 472c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 473c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 474c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown /** 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of Runnable r that are in the message queue. 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacks(Runnable r) 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, r, null); 4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of Runnable <var>r</var> with Object 484466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * <var>token</var> that are in the message queue. If <var>token</var> is null, 485466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * all callbacks will be removed. 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacks(Runnable r, Object token) 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, r, token); 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Pushes a message onto the end of the message queue after all pending messages 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the current time. It will be received in {@link #handleMessage}, 4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the thread attached to this handler. 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessage(Message msg) 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(msg, 0); 5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value. 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessage(int what) 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendEmptyMessageDelayed(what, 0); 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value, to be delivered 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the specified amount of time elapses. 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #sendMessageDelayed(android.os.Message, long) 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessageDelayed(int what, long delayMillis) { 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message msg = Message.obtain(); 5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.what = what; 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(msg, delayMillis); 5319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value, to be delivered 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time. 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #sendMessageAtTime(android.os.Message, long) 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessageAtTime(int what, long uptimeMillis) { 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message msg = Message.obtain(); 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.what = what; 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(msg, uptimeMillis); 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message into the message queue after all pending messages 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before (current time + delayMillis). You will receive it in 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #handleMessage}, in the thread attached to this handler. 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the message will be processed -- if 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessageDelayed(Message msg, long delayMillis) 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (delayMillis < 0) { 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project delayMillis = 0; 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(msg, SystemClock.uptimeMillis() + delayMillis); 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message into the message queue after all pending messages 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the absolute time (in milliseconds) <var>uptimeMillis</var>. 5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You will receive it in {@link #handleMessage}, in the thread attached 5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to this handler. 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the message should be 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * delivered, using the 5789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.os.SystemClock#uptimeMillis} time-base. 5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the message will be processed -- if 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 587109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown public boolean sendMessageAtTime(Message msg, long uptimeMillis) { 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MessageQueue queue = mQueue; 589109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown if (queue == null) { 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 591109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown this + " sendMessageAtTime() called with no mQueue"); 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("Looper", e.getMessage(), e); 593109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return false; 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 595109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return enqueueMessage(queue, msg, uptimeMillis); 5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message at the front of the message queue, to be processed on 6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the next iteration of the message loop. You will receive it in 6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #handleMessage}, in the thread attached to this handler. 6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>This method is only for use in very special circumstances -- it 6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily starve the message queue, cause ordering problems, or have 6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other unexpected side-effects.</b> 6059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 6099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 610109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown public final boolean sendMessageAtFrontOfQueue(Message msg) { 6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MessageQueue queue = mQueue; 612109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown if (queue == null) { 6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 6149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this + " sendMessageAtTime() called with no mQueue"); 6159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("Looper", e.getMessage(), e); 616109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return false; 617109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown } 618109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return enqueueMessage(queue, msg, 0); 619109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown } 620109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown 621109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown private boolean enqueueMessage(MessageQueue queue, Message msg, long uptimeMillis) { 622109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown msg.target = this; 623109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown if (mAsynchronous) { 624109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown msg.setAsynchronous(true); 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 626109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return queue.enqueueMessage(msg, uptimeMillis); 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of messages with code 'what' that are in the 6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. 6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeMessages(int what) { 6340f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown mQueue.removeMessages(this, what, null); 6359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of messages with code 'what' and whose obj is 63932c8113510b2774f865e8ac763976b90d9db2706Jeff Brown * 'object' that are in the message queue. If <var>object</var> is null, 640466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * all messages will be removed. 6419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeMessages(int what, Object object) { 6430f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown mQueue.removeMessages(this, what, object); 6449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of callbacks and sent messages whose 648466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * <var>obj</var> is <var>token</var>. If <var>token</var> is null, 649466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * all callbacks and messages will be removed. 6509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacksAndMessages(Object token) { 6529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeCallbacksAndMessages(this, token); 6539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check if there are any pending posts of messages with code 'what' in 6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the message queue. 6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasMessages(int what) { 6600f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown return mQueue.hasMessages(this, what, null); 6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check if there are any pending posts of messages with code 'what' and 6659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * whose obj is 'object' in the message queue. 6669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasMessages(int what, Object object) { 6680f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown return mQueue.hasMessages(this, what, object); 6699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 671ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy /** 672ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * Check if there are any pending posts of messages with callback r in 673ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * the message queue. 674ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * 675ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * @hide 676ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy */ 677ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy public final boolean hasCallbacks(Runnable r) { 678ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy return mQueue.hasMessages(this, r, null); 679ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy } 680ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy 6819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // if we can get rid of this method, the handler need not remember its loop 6829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // we could instead export a getMessageQueue() method... 6839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Looper getLooper() { 6849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLooper; 6859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void dump(Printer pw, String prefix) { 6889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.println(prefix + this + " @ " + SystemClock.uptimeMillis()); 6899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 6909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.println(prefix + "looper uninitialized"); 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper.dump(pw, prefix + " "); 6939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 698588d8560b3fabcbc0d90c63f386b2fa0d56643deKristian Monsen return "Handler (" + getClass().getName() + ") {" 6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + Integer.toHexString(System.identityHashCode(this)) 7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "}"; 7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final IMessenger getIMessenger() { 7049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project synchronized (mQueue) { 7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mMessenger != null) { 7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMessenger; 7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMessenger = new MessengerImpl(); 7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMessenger; 7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 712333b8cba996c8ebb8ca55ebfc5cc536bdd64af94Brad Fitzpatrick 7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final class MessengerImpl extends IMessenger.Stub { 7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void send(Message msg) { 7159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Handler.this.sendMessage(msg); 7169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 718333b8cba996c8ebb8ca55ebfc5cc536bdd64af94Brad Fitzpatrick 719ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy private static Message getPostMessage(Runnable r) { 7209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message m = Message.obtain(); 7219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.callback = r; 7229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return m; 7239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 725ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy private static Message getPostMessage(Runnable r, Object token) { 7269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message m = Message.obtain(); 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.obj = token; 7289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.callback = r; 7299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return m; 7309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 732ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy private static void handleCallback(Message message) { 7339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project message.callback.run(); 7349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final MessageQueue mQueue; 7379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Looper mLooper; 7389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Callback mCallback; 739109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown final boolean mAsynchronous; 7409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IMessenger mMessenger; 741c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 742c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown private static final class BlockingRunnable implements Runnable { 743c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown private final Runnable mTask; 744c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown private boolean mDone; 745c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 746c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown public BlockingRunnable(Runnable task) { 747c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown mTask = task; 748c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 749c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 750c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown @Override 751c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown public void run() { 752c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown try { 753c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown mTask.run(); 754c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } finally { 755c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown synchronized (this) { 756c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown mDone = true; 757c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown notifyAll(); 758c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 759c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 760c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 761c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 7624ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown public boolean postAndWait(Handler handler, long timeout) { 763c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown if (!handler.post(this)) { 764c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown return false; 765c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 766c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 767c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown synchronized (this) { 7684ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown if (timeout > 0) { 7694ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown final long expirationTime = SystemClock.uptimeMillis() + timeout; 7704ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown while (!mDone) { 7714ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown long delay = expirationTime - SystemClock.uptimeMillis(); 7724ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown if (delay <= 0) { 7734ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown return false; // timeout 7744ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 7754ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown try { 7764ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown wait(delay); 7774ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } catch (InterruptedException ex) { 7784ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 7794ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 7804ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } else { 7814ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown while (!mDone) { 7824ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown try { 7834ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown wait(); 7844ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } catch (InterruptedException ex) { 7854ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 786c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 787c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 788c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 789c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown return true; 790c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 791c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 7929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 793