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. 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface Callback { 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean handleMessage(Message msg); 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Subclasses must implement this to receive messages. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void handleMessage(Message msg) { 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Handle system messages here. 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void dispatchMessage(Message msg) { 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (msg.callback != null) { 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project handleCallback(msg); 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mCallback != null) { 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mCallback.handleMessage(msg)) { 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project handleMessage(msg); 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 104a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Default constructor associates this handler with the {@link Looper} for the 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current thread. 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 107a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * If this thread does not have a looper, this handler won't be able to receive messages 108a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * so an exception is thrown. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler() { 111a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(null, false); 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 115a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Constructor associates this handler with the {@link Looper} for the 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current thread and takes a callback interface in which you can handle 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * messages. 118a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 119a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * If this thread does not have a looper, this handler won't be able to receive messages 120a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * so an exception is thrown. 121a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 122a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler(Callback callback) { 125a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(callback, false); 126a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 127a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 128a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 129a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the provided {@link Looper} instead of the default one. 130a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 131a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param looper The looper, must not be null. 132a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 133a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(Looper looper) { 134a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(looper, null, false); 135a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 136a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 137a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 138a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the provided {@link Looper} instead of the default one and take a callback 139a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * interface in which to handle messages. 140a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 141a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param looper The looper, must not be null. 142a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 143a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 144a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(Looper looper, Callback callback) { 145a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(looper, callback, false); 146a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 147a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 148a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 149a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the {@link Looper} for the current thread 150a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * and set whether the handler should be asynchronous. 151a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 152a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Handlers are synchronous by default unless this constructor is used to make 153a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * one that is strictly asynchronous. 154a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 155a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Asynchronous messages represent interrupts or events that do not require global ordering 156a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * with represent to synchronous messages. Asynchronous messages are not subject to 157a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}. 158a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 159a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for 160a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * each {@link Message} that is sent to it or {@link Runnable} that is posted to it. 161a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 162a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @hide 163a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 164a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(boolean async) { 165a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown this(null, async); 166a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown } 167a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown 168a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown /** 169a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the {@link Looper} for the current thread with the specified callback interface 170a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * and set whether the handler should be asynchronous. 171a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 172a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Handlers are synchronous by default unless this constructor is used to make 173a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * one that is strictly asynchronous. 174a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 175a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Asynchronous messages represent interrupts or events that do not require global ordering 176a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * with represent to synchronous messages. Asynchronous messages are not subject to 177a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}. 178a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 179a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 180a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for 181a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * each {@link Message} that is sent to it or {@link Runnable} that is posted to it. 182a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * 183a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @hide 184a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown */ 185a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown public Handler(Callback callback, boolean async) { 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (FIND_POTENTIAL_LEAKS) { 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Class<? extends Handler> klass = getClass(); 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) && 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (klass.getModifiers() & Modifier.STATIC) == 0) { 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w(TAG, "The following Handler class should be static or leaks might occur: " + 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project klass.getCanonicalName()); 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper = Looper.myLooper(); 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new RuntimeException( 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Can't create handler inside thread that has not called Looper.prepare()"); 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue = mLooper.mQueue; 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCallback = callback; 202a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown mAsynchronous = async; 203109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown } 204109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown 205109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown /** 206a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * Use the provided {@link Looper} instead of the default one and take a callback 207109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * interface in which to handle messages. Also set whether the handler 208109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * should be asynchronous. 209109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 210109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * Handlers are synchronous by default unless this constructor is used to make 211109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * one that is strictly asynchronous. 212109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 213109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * Asynchronous messages represent interrupts or events that do not require global ordering 214109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * with represent to synchronous messages. Asynchronous messages are not subject to 215109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}. 216109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 217a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param looper The looper, must not be null. 218a2910d0abbbe18ba1710dfd4a31af45769632255Jeff Brown * @param callback The callback interface in which to handle messages, or null. 219109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for 220109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * each {@link Message} that is sent to it or {@link Runnable} that is posted to it. 221109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * 222109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown * @hide 223109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown */ 224109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown public Handler(Looper looper, Callback callback, boolean async) { 225109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mLooper = looper; 226109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mQueue = looper.mQueue; 227109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mCallback = callback; 228109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown mAsynchronous = async; 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 232f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * Returns a string representing the name of the specified message. 233f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * The default implementation will either return the class name of the 234f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * message callback if any, or the hexadecimal representation of the 235f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * message "what" field. 236f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * 237f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy * @param message The message whose name is being queried 238f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy */ 239f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy public String getMessageName(Message message) { 240f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy if (message.callback != null) { 241f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy return message.callback.getClass().getName(); 242f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy } 243f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy return "0x" + Integer.toHexString(message.what); 244f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy } 245f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy 246f9284695e8c10dad4daf3d2c84f607483bcb56caRomain Guy /** 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns a new {@link android.os.Message Message} from the global message pool. More efficient than 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * creating and allocating new instances. The retrieved message has its handler set to this instance (Message.target == this). 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If you don't want that facility, just call Message.obtain() instead. 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage() 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this); 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what member of the returned Message. 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what) 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what); 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what and obj members 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of the returned Message. 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param obj Value to assign to the returned Message.obj field. 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, Object obj) 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, obj); 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what, arg1 and arg2 members of the returned 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Message. 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg1 Value to assign to the returned Message.arg1 field. 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg2 Value to assign to the returned Message.arg2 field. 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, int arg1, int arg2) 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, arg1, arg2); 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what, obj, arg1,and arg2 values on the 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * returned Message. 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg1 Value to assign to the returned Message.arg1 field. 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg2 Value to assign to the returned Message.arg2 field. 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param obj Value to assign to the returned Message.obj field. 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, int arg1, int arg2, Object obj) 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, arg1, arg2, obj); 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue. 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attached. 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean post(Runnable r) 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(getPostMessage(r), 0); 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time given by <var>uptimeMillis</var>. 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is attached. 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the callback should run, 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using the {@link android.os.SystemClock#uptimeMillis} time-base. 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- if 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtTime(Runnable r, long uptimeMillis) 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(getPostMessage(r), uptimeMillis); 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time given by <var>uptimeMillis</var>. 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is attached. 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the callback should run, 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using the {@link android.os.SystemClock#uptimeMillis} time-base. 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- if 3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see android.os.SystemClock#uptimeMillis 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtTime(Runnable r, Object token, long uptimeMillis) 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(getPostMessage(r, token), uptimeMillis); 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the specified amount of time elapses. 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is attached. 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param delayMillis The delay (in milliseconds) until the Runnable 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be executed. 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if the looper is quit before the delivery time of the message 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postDelayed(Runnable r, long delayMillis) 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(getPostMessage(r), delayMillis); 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Posts a message to an object that implements Runnable. 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to executed on the next iteration through the 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. The runnable will be run on the thread to which this 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * handler is attached. 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>This method is only for use in very special circumstances -- it 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily starve the message queue, cause ordering problems, or have 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other unexpected side-effects.</b> 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtFrontOfQueue(Runnable r) 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtFrontOfQueue(getPostMessage(r)); 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 415c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Runs the specified task synchronously. 416c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 417c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * If the current thread is the same as the handler thread, then the runnable 418c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * runs immediately without being enqueued. Otherwise, posts the runnable 419c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * to the handler and waits for it to complete before returning. 420c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 421c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * This method is dangerous! Improper use can result in deadlocks. 422c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Never call this method while any locks are held or use it in a 423c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * possibly re-entrant manner. 424c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 425c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * This method is occasionally useful in situations where a background thread 426c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * must synchronously await completion of a task that must run on the 427c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * handler's thread. However, this problem is often a symptom of bad design. 428c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Consider improving the design (if possible) before resorting to this method. 429c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 430c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * One example of where you might want to use this method is when you just 431c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * set up a Handler thread and need to perform some initialization steps on 432c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * it before continuing execution. 433c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 4344ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * If timeout occurs then this method returns <code>false</code> but the runnable 4354ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * will remain posted on the handler and may already be in progress or 4364ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * complete at a later time. 4374ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * 438c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * @param r The Runnable that will be executed synchronously. 4394ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown * @param timeout The timeout in milliseconds, or 0 to wait indefinitely. 440c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 441c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * @return Returns true if the Runnable was successfully executed. 442c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * Returns false on failure, usually because the 443c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * looper processing the message queue is exiting. 444c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * 445c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * @hide This method is prone to abuse and should probably not be in the API. 446c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * If we ever do make it part of the API, we might want to rename it to something 447c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown * less funny like runUnsafe(). 448c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown */ 4494ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown public final boolean runWithScissors(final Runnable r, long timeout) { 450c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown if (r == null) { 451c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown throw new IllegalArgumentException("runnable must not be null"); 452c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 4534ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown if (timeout < 0) { 4544ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown throw new IllegalArgumentException("timeout must be non-negative"); 4554ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 456c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 457c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown if (Looper.myLooper() == mLooper) { 458c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown r.run(); 459c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown return true; 460c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 461c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 462c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown BlockingRunnable br = new BlockingRunnable(r); 4634ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown return br.postAndWait(this, timeout); 464c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 465c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 466c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown /** 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of Runnable r that are in the message queue. 4689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacks(Runnable r) 4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, r, null); 4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of Runnable <var>r</var> with Object 476466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * <var>token</var> that are in the message queue. If <var>token</var> is null, 477466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * all callbacks will be removed. 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacks(Runnable r, Object token) 4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, r, token); 4829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Pushes a message onto the end of the message queue after all pending messages 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the current time. It will be received in {@link #handleMessage}, 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the thread attached to this handler. 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessage(Message msg) 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(msg, 0); 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value. 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessage(int what) 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendEmptyMessageDelayed(what, 0); 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value, to be delivered 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the specified amount of time elapses. 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #sendMessageDelayed(android.os.Message, long) 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessageDelayed(int what, long delayMillis) { 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message msg = Message.obtain(); 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.what = what; 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(msg, delayMillis); 5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value, to be delivered 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time. 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #sendMessageAtTime(android.os.Message, long) 5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessageAtTime(int what, long uptimeMillis) { 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message msg = Message.obtain(); 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.what = what; 5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(msg, uptimeMillis); 5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message into the message queue after all pending messages 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before (current time + delayMillis). You will receive it in 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #handleMessage}, in the thread attached to this handler. 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the message will be processed -- if 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessageDelayed(Message msg, long delayMillis) 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (delayMillis < 0) { 5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project delayMillis = 0; 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(msg, SystemClock.uptimeMillis() + delayMillis); 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message into the message queue after all pending messages 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the absolute time (in milliseconds) <var>uptimeMillis</var>. 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You will receive it in {@link #handleMessage}, in the thread attached 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to this handler. 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the message should be 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * delivered, using the 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.os.SystemClock#uptimeMillis} time-base. 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the message will be processed -- if 5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 5789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 579109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown public boolean sendMessageAtTime(Message msg, long uptimeMillis) { 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MessageQueue queue = mQueue; 581109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown if (queue == null) { 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 583109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown this + " sendMessageAtTime() called with no mQueue"); 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("Looper", e.getMessage(), e); 585109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return false; 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 587109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return enqueueMessage(queue, msg, uptimeMillis); 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message at the front of the message queue, to be processed on 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the next iteration of the message loop. You will receive it in 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #handleMessage}, in the thread attached to this handler. 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>This method is only for use in very special circumstances -- it 5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily starve the message queue, cause ordering problems, or have 5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other unexpected side-effects.</b> 5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 602109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown public final boolean sendMessageAtFrontOfQueue(Message msg) { 6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MessageQueue queue = mQueue; 604109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown if (queue == null) { 6059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this + " sendMessageAtTime() called with no mQueue"); 6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("Looper", e.getMessage(), e); 608109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return false; 609109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown } 610109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return enqueueMessage(queue, msg, 0); 611109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown } 612109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown 613109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown private boolean enqueueMessage(MessageQueue queue, Message msg, long uptimeMillis) { 614109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown msg.target = this; 615109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown if (mAsynchronous) { 616109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown msg.setAsynchronous(true); 6179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 618109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown return queue.enqueueMessage(msg, uptimeMillis); 6199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of messages with code 'what' that are in the 6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. 6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeMessages(int what) { 6260f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown mQueue.removeMessages(this, what, null); 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' and whose obj is 63132c8113510b2774f865e8ac763976b90d9db2706Jeff Brown * 'object' that are in the message queue. If <var>object</var> is null, 632466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * all messages will be removed. 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeMessages(int what, Object object) { 6350f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown mQueue.removeMessages(this, what, object); 6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of callbacks and sent messages whose 640466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * <var>obj</var> is <var>token</var>. If <var>token</var> is null, 641466ed24810d329add4f9200edf8c1918a3e80716Dianne Hackborn * all callbacks and messages will be removed. 6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacksAndMessages(Object token) { 6449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeCallbacksAndMessages(this, token); 6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check if there are any pending posts of messages with code 'what' in 6499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the message queue. 6509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasMessages(int what) { 6520f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown return mQueue.hasMessages(this, what, null); 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' and 6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * whose obj is 'object' in the message queue. 6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasMessages(int what, Object object) { 6600f85ce3837633a03460a61405087a5d28a4bf955Jeff Brown return mQueue.hasMessages(this, what, object); 6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 663ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy /** 664ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * Check if there are any pending posts of messages with callback r in 665ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * the message queue. 666ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * 667ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy * @hide 668ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy */ 669ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy public final boolean hasCallbacks(Runnable r) { 670ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy return mQueue.hasMessages(this, r, null); 671ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy } 672ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy 6739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // if we can get rid of this method, the handler need not remember its loop 6749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // we could instead export a getMessageQueue() method... 6759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Looper getLooper() { 6769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLooper; 6779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void dump(Printer pw, String prefix) { 6809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.println(prefix + this + " @ " + SystemClock.uptimeMillis()); 6819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 6829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.println(prefix + "looper uninitialized"); 6839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 6849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper.dump(pw, prefix + " "); 6859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 6899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 690588d8560b3fabcbc0d90c63f386b2fa0d56643deKristian Monsen return "Handler (" + getClass().getName() + ") {" 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + Integer.toHexString(System.identityHashCode(this)) 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "}"; 6939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final IMessenger getIMessenger() { 6969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project synchronized (mQueue) { 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mMessenger != null) { 6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMessenger; 6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMessenger = new MessengerImpl(); 7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMessenger; 7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 704333b8cba996c8ebb8ca55ebfc5cc536bdd64af94Brad Fitzpatrick 7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final class MessengerImpl extends IMessenger.Stub { 7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void send(Message msg) { 7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Handler.this.sendMessage(msg); 7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 710333b8cba996c8ebb8ca55ebfc5cc536bdd64af94Brad Fitzpatrick 711ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy private static Message getPostMessage(Runnable r) { 7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message m = Message.obtain(); 7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.callback = r; 7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return m; 7159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 717ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy private static Message getPostMessage(Runnable r, Object token) { 7189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message m = Message.obtain(); 7199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.obj = token; 7209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.callback = r; 7219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return m; 7229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 724ba6be8a62dcdb3ffd210cd36b9af4e3a658eac47Romain Guy private static void handleCallback(Message message) { 7259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project message.callback.run(); 7269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final MessageQueue mQueue; 7299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Looper mLooper; 7309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Callback mCallback; 731109025d778c12d78f8585920447320aaf0f1d2f8Jeff Brown final boolean mAsynchronous; 7329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IMessenger mMessenger; 733c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 734c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown private static final class BlockingRunnable implements Runnable { 735c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown private final Runnable mTask; 736c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown private boolean mDone; 737c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 738c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown public BlockingRunnable(Runnable task) { 739c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown mTask = task; 740c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 741c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 742c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown @Override 743c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown public void run() { 744c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown try { 745c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown mTask.run(); 746c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } finally { 747c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown synchronized (this) { 748c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown mDone = true; 749c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown notifyAll(); 750c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 751c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 752c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 753c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 7544ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown public boolean postAndWait(Handler handler, long timeout) { 755c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown if (!handler.post(this)) { 756c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown return false; 757c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 758c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown 759c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown synchronized (this) { 7604ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown if (timeout > 0) { 7614ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown final long expirationTime = SystemClock.uptimeMillis() + timeout; 7624ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown while (!mDone) { 7634ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown long delay = expirationTime - SystemClock.uptimeMillis(); 7644ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown if (delay <= 0) { 7654ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown return false; // timeout 7664ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 7674ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown try { 7684ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown wait(delay); 7694ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } catch (InterruptedException ex) { 7704ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 7714ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 7724ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } else { 7734ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown while (!mDone) { 7744ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown try { 7754ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown wait(); 7764ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } catch (InterruptedException ex) { 7774ed8fe75e1dde1a2b9576f3862aecc5a572c56b5Jeff Brown } 778c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 779c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 780c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 781c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown return true; 782c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 783c53abc4d42a707caddf7ec9bb7d041125a09dbd7Jeff Brown } 7849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 785