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 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your new thread. The given Runnable or Message will than 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 /** 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Default constructor associates this handler with the queue for the 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current thread. 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If there isn't one, this handler won't be able to receive messages. 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler() { 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (FIND_POTENTIAL_LEAKS) { 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Class<? extends Handler> klass = getClass(); 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) && 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (klass.getModifiers() & Modifier.STATIC) == 0) { 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w(TAG, "The following Handler class should be static or leaks might occur: " + 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project klass.getCanonicalName()); 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper = Looper.myLooper(); 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new RuntimeException( 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Can't create handler inside thread that has not called Looper.prepare()"); 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue = mLooper.mQueue; 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCallback = null; 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructor associates this handler with the queue for the 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current thread and takes a callback interface in which you can handle 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * messages. 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler(Callback callback) { 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (FIND_POTENTIAL_LEAKS) { 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Class<? extends Handler> klass = getClass(); 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) && 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (klass.getModifiers() & Modifier.STATIC) == 0) { 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w(TAG, "The following Handler class should be static or leaks might occur: " + 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project klass.getCanonicalName()); 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper = Looper.myLooper(); 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new RuntimeException( 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Can't create handler inside thread that has not called Looper.prepare()"); 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue = mLooper.mQueue; 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCallback = callback; 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Use the provided queue instead of the default one. 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler(Looper looper) { 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper = looper; 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue = looper.mQueue; 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCallback = null; 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Use the provided queue instead of the default one and take a callback 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * interface in which to handle messages. 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Handler(Looper looper, Callback callback) { 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper = looper; 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue = looper.mQueue; 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCallback = callback; 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns a new {@link android.os.Message Message} from the global message pool. More efficient than 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * creating and allocating new instances. The retrieved message has its handler set to this instance (Message.target == this). 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If you don't want that facility, just call Message.obtain() instead. 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage() 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this); 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what member of the returned Message. 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what) 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what); 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what and obj members 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of the returned Message. 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param obj Value to assign to the returned Message.obj field. 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, Object obj) 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, obj); 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what, arg1 and arg2 members of the returned 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Message. 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg1 Value to assign to the returned Message.arg1 field. 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg2 Value to assign to the returned Message.arg2 field. 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, int arg1, int arg2) 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, arg1, arg2); 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Same as {@link #obtainMessage()}, except that it also sets the what, obj, arg1,and arg2 values on the 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * returned Message. 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param what Value to assign to the returned Message.what field. 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg1 Value to assign to the returned Message.arg1 field. 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param arg2 Value to assign to the returned Message.arg2 field. 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param obj Value to assign to the returned Message.obj field. 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Message from the global message pool. 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Message obtainMessage(int what, int arg1, int arg2, Object obj) 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Message.obtain(this, what, arg1, arg2, obj); 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue. 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attached. 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean post(Runnable r) 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(getPostMessage(r), 0); 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time given by <var>uptimeMillis</var>. 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is attached. 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the callback should run, 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using the {@link android.os.SystemClock#uptimeMillis} time-base. 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- if 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtTime(Runnable r, long uptimeMillis) 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(getPostMessage(r), uptimeMillis); 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time given by <var>uptimeMillis</var>. 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler is attached. 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the callback should run, 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using the {@link android.os.SystemClock#uptimeMillis} time-base. 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- if 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see android.os.SystemClock#uptimeMillis 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtTime(Runnable r, Object token, long uptimeMillis) 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(getPostMessage(r, token), uptimeMillis); 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to be added to the message queue, to be run 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the specified amount of time elapses. 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The runnable will be run on the thread to which this handler 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is attached. 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param delayMillis The delay (in milliseconds) until the Runnable 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be executed. 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the Runnable was successfully placed in to the 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the Runnable will be processed -- 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if the looper is quit before the delivery time of the message 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postDelayed(Runnable r, long delayMillis) 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(getPostMessage(r), delayMillis); 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Posts a message to an object that implements Runnable. 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Causes the Runnable r to executed on the next iteration through the 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. The runnable will be run on the thread to which this 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * handler is attached. 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>This method is only for use in very special circumstances -- it 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily starve the message queue, cause ordering problems, or have 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other unexpected side-effects.</b> 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param r The Runnable that will be executed. 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean postAtFrontOfQueue(Runnable r) 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtFrontOfQueue(getPostMessage(r)); 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of Runnable r that are in the message queue. 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacks(Runnable r) 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, r, null); 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of Runnable <var>r</var> with Object 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>token</var> that are in the message queue. 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacks(Runnable r, Object token) 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, r, token); 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Pushes a message onto the end of the message queue after all pending messages 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the current time. It will be received in {@link #handleMessage}, 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the thread attached to this handler. 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message 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. 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessage(Message msg) 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(msg, 0); 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value. 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessage(int what) 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendEmptyMessageDelayed(what, 0); 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value, to be delivered 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the specified amount of time elapses. 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #sendMessageDelayed(android.os.Message, long) 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessageDelayed(int what, long delayMillis) { 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message msg = Message.obtain(); 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.what = what; 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageDelayed(msg, delayMillis); 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sends a Message containing only the what value, to be delivered 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at a specific time. 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #sendMessageAtTime(android.os.Message, long) 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendEmptyMessageAtTime(int what, long uptimeMillis) { 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message msg = Message.obtain(); 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.what = what; 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(msg, uptimeMillis); 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message into the message queue after all pending messages 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before (current time + delayMillis). You will receive it in 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #handleMessage}, in the thread attached to this handler. 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the message will be processed -- if 4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 4249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessageDelayed(Message msg, long delayMillis) 4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (delayMillis < 0) { 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project delayMillis = 0; 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sendMessageAtTime(msg, SystemClock.uptimeMillis() + delayMillis); 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message into the message queue after all pending messages 4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the absolute time (in milliseconds) <var>uptimeMillis</var>. 4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b> 4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You will receive it in {@link #handleMessage}, in the thread attached 4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to this handler. 4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uptimeMillis The absolute time at which the message should be 4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * delivered, using the 4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.os.SystemClock#uptimeMillis} time-base. 4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. Note that a 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * result of true does not mean the message will be processed -- if 4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the looper is quit before the delivery time of the message 4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * occurs then the message will be dropped. 4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean sendMessageAtTime(Message msg, long uptimeMillis) 4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean sent = false; 4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MessageQueue queue = mQueue; 4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (queue != null) { 4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.target = this; 4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sent = queue.enqueueMessage(msg, uptimeMillis); 4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project else { 4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this + " sendMessageAtTime() called with no mQueue"); 4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("Looper", e.getMessage(), e); 4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sent; 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enqueue a message at the front of the message queue, to be processed on 4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the next iteration of the message loop. You will receive it in 4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #handleMessage}, in the thread attached to this handler. 4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>This method is only for use in very special circumstances -- it 4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can easily starve the message queue, cause ordering problems, or have 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other unexpected side-effects.</b> 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns true if the message was successfully placed in to the 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. Returns false on failure, usually because the 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * looper processing the message queue is exiting. 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean sendMessageAtFrontOfQueue(Message msg) 4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean sent = false; 4829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MessageQueue queue = mQueue; 4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (queue != null) { 4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project msg.target = this; 4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sent = queue.enqueueMessage(msg, 0); 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project else { 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this + " sendMessageAtTime() called with no mQueue"); 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.w("Looper", e.getMessage(), e); 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sent; 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of messages with code 'what' that are in the 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * message queue. 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeMessages(int what) { 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, what, null, true); 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of messages with code 'what' and whose obj is 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 'object' that are in the message queue. 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeMessages(int what, Object object) { 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeMessages(this, what, object, true); 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove any pending posts of callbacks and sent messages whose 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>obj</var> is <var>token</var>. 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void removeCallbacksAndMessages(Object token) { 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mQueue.removeCallbacksAndMessages(this, token); 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check if there are any pending posts of messages with code 'what' in 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the message queue. 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasMessages(int what) { 5249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mQueue.removeMessages(this, what, null, false); 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check if there are any pending posts of messages with code 'what' and 5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * whose obj is 'object' in the message queue. 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean hasMessages(int what, Object object) { 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mQueue.removeMessages(this, what, object, false); 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // if we can get rid of this method, the handler need not remember its loop 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // we could instead export a getMessageQueue() method... 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Looper getLooper() { 5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLooper; 5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void dump(Printer pw, String prefix) { 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.println(prefix + this + " @ " + SystemClock.uptimeMillis()); 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLooper == null) { 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.println(prefix + "looper uninitialized"); 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLooper.dump(pw, prefix + " "); 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return "Handler{" 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + Integer.toHexString(System.identityHashCode(this)) 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "}"; 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final IMessenger getIMessenger() { 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project synchronized (mQueue) { 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mMessenger != null) { 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMessenger; 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMessenger = new MessengerImpl(); 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMessenger; 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final class MessengerImpl extends IMessenger.Stub { 5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void send(Message msg) { 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Handler.this.sendMessage(msg); 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final Message getPostMessage(Runnable r) { 5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message m = Message.obtain(); 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.callback = r; 5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return m; 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final Message getPostMessage(Runnable r, Object token) { 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Message m = Message.obtain(); 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.obj = token; 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m.callback = r; 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return m; 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final void handleCallback(Message message) { 5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project message.callback.run(); 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final MessageQueue mQueue; 5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Looper mLooper; 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Callback mCallback; 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IMessenger mMessenger; 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 595