BroadcastReceiver.java revision 9ecebbfbf768fd63e9a6c9a09c86d81c7737ee2d
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.content; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.ActivityManagerNative; 20e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackbornimport android.app.ActivityThread; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.IActivityManager; 22e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackbornimport android.app.QueuedWork; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.IBinder; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.RemoteException; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Log; 27e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackbornimport android.util.Slog; 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Base class for code that will receive intents sent by sendBroadcast(). 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You can either dynamically register an instance of this class with 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#registerReceiver Context.registerReceiver()} 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or statically publish an implementation through the 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestReceiver <receiver>} 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in your <code>AndroidManifest.xml</code>. <em><strong>Note:</strong></em> 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If registering a receiver in your 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onResume() Activity.onResume()} 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * implementation, you should unregister it in 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onPause() Activity.onPause()}. 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (You won't receive intents when paused, 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and this will cut down on unnecessary system overhead). Do not unregister in 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onSaveInstanceState(android.os.Bundle) Activity.onSaveInstanceState()}, 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * because this won't be called if the user moves back in the history 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * stack. 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>There are two major classes of broadcasts that can be received:</p> 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> <b>Normal broadcasts</b> (sent with {@link Context#sendBroadcast(Intent) 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}) are completely asynchronous. All receivers of the 50a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * broadcast are run in an undefined order, often at the same time. This is 51a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * more efficient, but means that receivers cannot use the result or abort 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * APIs included here. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> <b>Ordered broadcasts</b> (sent with {@link Context#sendOrderedBroadcast(Intent, String) 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}) are delivered to one receiver at a time. 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * As each receiver executes in turn, it can propagate a result to the next 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receiver, or it can completely abort the broadcast so that it won't be passed 57a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * to other receivers. The order receivers run in can be controlled with the 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestIntentFilter_priority 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:priority} attribute of the matching intent-filter; receivers with 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the same priority will be run in an arbitrary order. 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Even in the case of normal broadcasts, the system may in some 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * situations revert to delivering the broadcast one receiver at a time. In 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * particular, for receivers that may require the creation of a process, only 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one will be run at a time to avoid overloading the system with new processes. 67a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * In this situation, however, the non-ordered semantics hold: these receivers still 68a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * cannot return results or abort their broadcast.</p> 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Note that, although the Intent class is used for sending and receiving 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * these broadcasts, the Intent broadcast mechanism here is completely separate 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from Intents that are used to start Activities with 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#startActivity Context.startActivity()}. 74105925376f8d0f6b318c9938c7b83ef7fef094daThe Android Open Source Project * There is no way for a BroadcastReceiver 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to see or capture Intents used with startActivity(); likewise, when 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you broadcast an Intent, you will never find or start an Activity. 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * These two operations are semantically very different: starting an 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity with an Intent is a foreground operation that modifies what the 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user is currently interacting with; broadcasting an Intent is a background 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * operation that the user is not normally aware of. 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The BroadcastReceiver class (when launched as a component through 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a manifest's {@link android.R.styleable#AndroidManifestReceiver <receiver>} 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag) is an important part of an 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/fundamentals.html#lcycles">application's overall lifecycle</a>.</p> 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Topics covered here: 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ol> 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#ReceiverLifecycle">Receiver Lifecycle</a> 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#Permissions">Permissions</a> 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#ProcessLifecycle">Process Lifecycle</a> 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ol> 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="ReceiverLifecycle"></a> 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Receiver Lifecycle</h3> 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>A BroadcastReceiver object is only valid for the duration of the call 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to {@link #onReceive}. Once your code returns from this function, 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the system considers the object to be finished and no longer active. 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This has important repercussions to what you can do in an 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #onReceive} implementation: anything that requires asynchronous 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * operation is not available, because you will need to return from the 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * function to handle the asynchronous operation, but at that point the 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * BroadcastReceiver is no longer active and thus the system is free to kill 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * its process before the asynchronous operation completes. 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>In particular, you may <i>not</i> show a dialog or bind to a service from 109105925376f8d0f6b318c9938c7b83ef7fef094daThe Android Open Source Project * within a BroadcastReceiver. For the former, you should instead use the 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.NotificationManager} API. For the latter, you can 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * use {@link android.content.Context#startService Context.startService()} to 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * send a command to the service. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="Permissions"></a> 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Permissions</h3> 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Access permissions can be enforced by either the sender or receiver 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of an Intent. 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>To enforce a permission when sending, you supply a non-null 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>permission</var> argument to 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendBroadcast(Intent, String)} or 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, Bundle)}. 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Only receivers who have been granted this permission 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (by requesting it with the 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in their <code>AndroidManifest.xml</code>) will be able to receive 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the broadcast. 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>To enforce a permission when receiving, you supply a non-null 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>permission</var> when registering your receiver -- either when calling 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter, String, android.os.Handler)} 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or in the static 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestReceiver <receiver>} 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in your <code>AndroidManifest.xml</code>. Only broadcasters who have 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * been granted this permission (by requesting it with the 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in their <code>AndroidManifest.xml</code>) will be able to send an 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent to the receiver. 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a> 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * document for more information on permissions and security in general. 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="ProcessLifecycle"></a> 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Process Lifecycle</h3> 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 147105925376f8d0f6b318c9938c7b83ef7fef094daThe Android Open Source Project * <p>A process that is currently executing a BroadcastReceiver (that is, 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * currently running the code in its {@link #onReceive} method) is 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * considered to be a foreground process and will be kept running by the 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * system except under cases of extreme memory pressure. 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Once you return from onReceive(), the BroadcastReceiver is no longer 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * active, and its hosting process is only as important as any other application 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * components that are running in it. This is especially important because if 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that process was only hosting the BroadcastReceiver (a common case for 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * applications that the user has never or not recently interacted with), then 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * upon returning from onReceive() the system will consider its process 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to be empty and aggressively kill it so that resources are available for other 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * more important processes. 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This means that for longer-running operations you will often use 162a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * a {@link android.app.Service} in conjunction with a BroadcastReceiver to keep 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the containing process active for the entire time of your operation. 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic abstract class BroadcastReceiver { 166e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn private PendingResult mPendingResult; 167e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn private boolean mDebugUnregister; 168e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 169e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 170e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * State for a result that is pending for a broadcast receiver. Returned 171e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * by {@link BroadcastReceiver#goAsync() goAsync()} 172e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * while in {@link BroadcastReceiver#onReceive BroadcastReceiver.onReceive()}. 173327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * This allows you to return from onReceive() without having the broadcast 174327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * terminate; you must call {@link #finish()} once you are done with the 175327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * broadcast. This allows you to process the broadcast off of the main 176327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * thread of your app. 177327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * 178327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * <p>Note on threading: the state inside of this class is not itself 179327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * thread-safe, however you can use it from any thread if you properly 180327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * sure that you do not have races. Typically this means you will hand 181327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * the entire object to another thread, which will be solely responsible 182327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * for setting any results and finally calling {@link #finish()}. 183e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 184e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static class PendingResult { 185e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 186e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static final int TYPE_COMPONENT = 0; 187e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 188e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static final int TYPE_REGISTERED = 1; 189e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 190e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static final int TYPE_UNREGISTERED = 2; 191e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 192e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final int mType; 193e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final boolean mOrderedHint; 194e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final boolean mInitialStickyHint; 195e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final IBinder mToken; 196e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 197e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn int mResultCode; 198e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn String mResultData; 199e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Bundle mResultExtras; 200e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn boolean mAbortBroadcast; 201e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn boolean mFinished; 202e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 203e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 204e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public PendingResult(int resultCode, String resultData, Bundle resultExtras, 205e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn int type, boolean ordered, boolean sticky, IBinder token) { 206e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultCode = resultCode; 207e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultData = resultData; 208e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras = resultExtras; 209e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mType = type; 210e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mOrderedHint = ordered; 211e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mInitialStickyHint = sticky; 212e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mToken = token; 213e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 214e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 215e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 216e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResultCode(int) 217e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResultCode(int)} for 218e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 219e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 220e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResultCode(int code) { 221e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 222e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultCode = code; 223e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 224e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 225e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 226e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getResultCode() 227e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getResultCode()} for 228e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 229e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 230e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final int getResultCode() { 231e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mResultCode; 232e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 233e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 234e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 235e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResultData(String) 236e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResultData(String)} for 237e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 238e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 239e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResultData(String data) { 240e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 241e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultData = data; 242e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 243e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 244e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 245e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getResultData() 246e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getResultData()} for 247e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 248e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 249e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final String getResultData() { 250e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mResultData; 251e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 252e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 253e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 254e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResultExtras(Bundle) 255e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResultExtras(Bundle)} for 256e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 257e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 258e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResultExtras(Bundle extras) { 259e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 260e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras = extras; 261e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 262e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 263e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 264e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getResultExtras(boolean) 265e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getResultExtras(boolean)} for 266e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 267e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 268e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final Bundle getResultExtras(boolean makeMap) { 269e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Bundle e = mResultExtras; 270e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (!makeMap) return e; 271e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (e == null) mResultExtras = e = new Bundle(); 272e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return e; 273e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 274e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 275e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 276e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResult(int, String, Bundle) 277e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResult(int, String, Bundle)} for 278e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 279e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 280e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResult(int code, String data, Bundle extras) { 281e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 282e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultCode = code; 283e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultData = data; 284e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras = extras; 285e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 286e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 287e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 288e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getAbortBroadcast() 289e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getAbortBroadcast()} for 290e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 291e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 292e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final boolean getAbortBroadcast() { 293e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mAbortBroadcast; 294e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 295e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 296e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 297e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#abortBroadcast() 298e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.abortBroadcast()} for 299e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 300e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 301e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void abortBroadcast() { 302e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 303e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mAbortBroadcast = true; 304e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 305e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 306e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 307e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#clearAbortBroadcast() 308e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.clearAbortBroadcast()} for 309e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 310e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 311e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void clearAbortBroadcast() { 312e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mAbortBroadcast = false; 313e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 314e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 315e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 316e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Finish the broadcast. The current result will be sent and the 317e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * next broadcast will proceed. 318e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 319e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void finish() { 320e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mType == TYPE_COMPONENT) { 321e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final IActivityManager mgr = ActivityManagerNative.getDefault(); 322e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (QueuedWork.hasPendingWork()) { 323e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // If this is a broadcast component, we need to make sure any 324e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // queued work is complete before telling AM we are done, so 325e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // we don't have our process killed before that. We now know 326e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // there is pending work; put another piece of work at the end 327e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // of the list to finish the broadcast, so we don't block this 328e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // thread (which may be the main thread) to have it finished. 329e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // 330e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // Note that we don't need to use QueuedWork.add() with the 331e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // runnable, since we know the AM is waiting for us until the 332e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // executor gets to it. 333e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn QueuedWork.singleThreadExecutor().execute( new Runnable() { 334e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn @Override public void run() { 335e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (ActivityThread.DEBUG_BROADCAST) Slog.i(ActivityThread.TAG, 336e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "Finishing broadcast after work to component " + mToken); 337e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn sendFinished(mgr); 338e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 339e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn }); 340e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } else { 341e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (ActivityThread.DEBUG_BROADCAST) Slog.i(ActivityThread.TAG, 342e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "Finishing broadcast to component " + mToken); 343e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn sendFinished(mgr); 344e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 345e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } else if (mOrderedHint && mType != TYPE_UNREGISTERED) { 346e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (ActivityThread.DEBUG_BROADCAST) Slog.i(ActivityThread.TAG, 347e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "Finishing broadcast to " + mToken); 348e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final IActivityManager mgr = ActivityManagerNative.getDefault(); 349e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn sendFinished(mgr); 350e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 351e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 352e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 353e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 354e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public void setExtrasClassLoader(ClassLoader cl) { 355e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mResultExtras != null) { 356e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras.setClassLoader(cl); 357e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 358e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 359e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 360e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 361e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public void sendFinished(IActivityManager am) { 362e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn synchronized (this) { 363e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mFinished) { 364e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn throw new IllegalStateException("Broadcast already finished"); 365e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 366e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mFinished = true; 367e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 368e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn try { 3699ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn if (mResultExtras != null) { 3709ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn mResultExtras.setAllowFds(false); 3719ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn } 372e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mOrderedHint) { 373e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn am.finishReceiver(mToken, mResultCode, mResultData, mResultExtras, 374e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mAbortBroadcast); 375e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } else { 376e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // This broadcast was sent to a component; it is not ordered, 377e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // but we still need to tell the activity manager we are done. 378e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn am.finishReceiver(mToken, 0, null, null, false); 379e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 380e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } catch (RemoteException ex) { 381e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 382e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 383e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 384e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 385e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn void checkSynchronousHint() { 386e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // Note that we don't assert when receiving the initial sticky value, 387e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // since that may have come from an ordered broadcast. We'll catch 388e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // them later when the real broadcast happens again. 389e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mOrderedHint || mInitialStickyHint) { 390e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return; 391e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 392e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn RuntimeException e = new RuntimeException( 393e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "BroadcastReceiver trying to return result during a non-ordered broadcast"); 394e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn e.fillInStackTrace(); 395e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Log.e("BroadcastReceiver", e.getMessage(), e); 396e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 397e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 398e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public BroadcastReceiver() { 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This method is called when the BroadcastReceiver is receiving an Intent 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcast. During this time you can use the other methods on 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * BroadcastReceiver to view/modify the current result values. The function 406a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * is normally called within the main thread of its process, so you should 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * never perform long-running operations in it (there is a timeout of 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10 seconds that the system allows before considering the receiver to 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be blocked and a candidate to be killed). You cannot launch a popup dialog 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in your implementation of onReceive(). 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>If this BroadcastReceiver was launched through a <receiver> tag, 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * then the object is no longer alive after returning from this 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * function.</b> This means you should not perform any operations that 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return a result to you asynchronously -- in particular, for interacting 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with services, you should use 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#startService(Intent)} instead of 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#bindService(Intent, ServiceConnection, int)}. If you wish 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to interact with a service that is already running, you can use 4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #peekService}. 4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 422a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * <p>The Intent filters used in {@link android.content.Context#registerReceiver} 423a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * and in application manifests are <em>not</em> guaranteed to be exclusive. They 424a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * are hints to the operating system about how to find suitable recipients. It is 425a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * possible for senders to force delivery to specific recipients, bypassing filter 426a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * resolution. For this reason, {@link #onReceive(Context, Intent) onReceive()} 427a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * implementations should respond only to known actions, ignoring any unexpected 428a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * Intents that they may receive. 429a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param context The Context in which the receiver is running. 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent The Intent being received. 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public abstract void onReceive(Context context, Intent intent); 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 436e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * This can be called by an application in {@link #onReceive} to allow 437e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * it to keep the broadcast active after returning from that function. 438e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * This does <em>not</em> change the expectation of being relatively 439e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * responsive to the broadcast (finishing it within 10s), but does allow 440e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * the implementation to move work related to it over to another thread 441e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * to avoid glitching the main UI thread due to disk IO. 442e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * 443e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * @return Returns a {@link PendingResult} representing the result of 444e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * the active broadcast. The BroadcastRecord itself is no longer active; 445e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * all data and other interaction must go through {@link PendingResult} 446e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * APIs. The {@link PendingResult#finish PendingResult.finish()} method 447e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * must be called once processing of the broadcast is done. 448e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 449e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final PendingResult goAsync() { 450e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn PendingResult res = mPendingResult; 451e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult = null; 452e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return res; 453e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 454e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 455e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Provide a binder to an already-running service. This method is synchronous 4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and will not start the target service if it is not present, so it is safe 4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to call from {@link #onReceive}. 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param myContext The Context that had been passed to {@link #onReceive(Context, Intent)} 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param service The Intent indicating the service you wish to use. See {@link 4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context#startService(Intent)} for more information. 4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public IBinder peekService(Context myContext, Intent service) { 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IActivityManager am = ActivityManagerNative.getDefault(); 4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IBinder binder = null; 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 4689ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn service.setAllowFds(false); 4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project binder = am.peekService(service, service.resolveTypeIfNeeded( 4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project myContext.getContentResolver())); 4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (RemoteException e) { 4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return binder; 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the current result code of this broadcast; only works with 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcasts sent through 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. Often uses the 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity {@link android.app.Activity#RESULT_CANCELED} and 4829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#RESULT_OK} constants, though the 4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * actual meaning of this value is ultimately up to the broadcaster. 4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 485e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * <p class="note">This method does not work with non-ordered broadcasts such 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 487e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Context.sendBroadcast}</p> 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param code The new result code. 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setResult(int, String, Bundle) 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResultCode(int code) { 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 495e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultCode = code; 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current result code, as set by the previous receiver. 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return int The current result code. 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final int getResultCode() { 504e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mResultCode : 0; 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the current result data of this broadcast; only works with 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcasts sent through 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. This is an arbitrary 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * string whose interpretation is up to the broadcaster. 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param data The new result data; may be null. 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setResult(int, String, Bundle) 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResultData(String data) { 5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 524e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultData = data; 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current result data, as set by the previous receiver. 5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Often this is null. 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return String The current result data; may be null. 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final String getResultData() { 534e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mResultData : null; 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the current result extras of this broadcast; only works with 5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcasts sent through 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. This is a Bundle 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * holding arbitrary data, whose interpretation is up to the 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcaster. Can be set to null. Calling this method completely 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaces the current map (if any). 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param extras The new extra data map; may be null. 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setResult(int, String, Bundle) 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResultExtras(Bundle extras) { 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 556e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultExtras = extras; 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current result extra data, as set by the previous receiver. 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Any changes you make to the returned Map will be propagated to the next 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receiver. 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param makeMap If true then a new empty Map will be made for you if the 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current Map is null; if false you should be prepared to 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receive a null Map. 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Map The current extras map. 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Bundle getResultExtras(boolean makeMap) { 571e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult == null) { 572e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return null; 573e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 574e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Bundle e = mPendingResult.mResultExtras; 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!makeMap) return e; 576e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (e == null) mPendingResult.mResultExtras = e = new Bundle(); 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return e; 5789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change all of the result data returned from this broadcasts; only works 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with broadcasts sent through 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. All current result data is replaced 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * by the value given to this method. 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param code The new result code. Often uses the 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity {@link android.app.Activity#RESULT_CANCELED} and 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#RESULT_OK} constants, though the 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * actual meaning of this value is ultimately up to the broadcaster. 5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param data The new result data. This is an arbitrary 5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * string whose interpretation is up to the broadcaster; may be null. 5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param extras The new extra data map. This is a Bundle 5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * holding arbitrary data, whose interpretation is up to the 5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcaster. Can be set to null. This completely 6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaces the current map (if any). 6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResult(int code, String data, Bundle extras) { 6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 604e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultCode = code; 605e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultData = data; 606e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultExtras = extras; 6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the flag indicating whether or not this receiver should 6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * abort the current broadcast. 6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the broadcast should be aborted. 6149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean getAbortBroadcast() { 616e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mAbortBroadcast : false; 6179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the flag indicating that this receiver should abort the 6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current broadcast; only works with broadcasts sent through 6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. This will prevent 6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * any other broadcast receivers from receiving the broadcast. It will still 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * call {@link #onReceive} of the BroadcastReceiver that the caller of 6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast} passed in. 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void abortBroadcast() { 6349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 635e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mAbortBroadcast = true; 6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Clears the flag indicating that this receiver should abort the current 6409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcast. 6419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void clearAbortBroadcast() { 643e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult != null) { 644e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mAbortBroadcast = false; 645e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 64968d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * Returns true if the receiver is currently processing an ordered 65068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * broadcast. 65168d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn */ 65268d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn public final boolean isOrderedBroadcast() { 653e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mOrderedHint : false; 65468d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn } 65568d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn 65668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn /** 65768d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * Returns true if the receiver is currently processing the initial 65868d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * value of a sticky broadcast -- that is, the value that was last 65968d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * broadcast and is currently held in the sticky cache, so this is 66068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * not directly the result of a broadcast right now. 66168d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn */ 66268d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn public final boolean isInitialStickyBroadcast() { 663e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mInitialStickyHint : false; 66468d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn } 66568d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn 66668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn /** 6679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For internal use, sets the hint about whether this BroadcastReceiver is 6689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * running in ordered mode. 6699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setOrderedHint(boolean isOrdered) { 671e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // Accidentally left in the SDK. 6729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 675e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * For internal use to set the result data that is active. @hide 67668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn */ 677e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setPendingResult(PendingResult result) { 678e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult = result; 679e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 680e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 681e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 682e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * For internal use to set the result data that is active. @hide 683e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 684e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final PendingResult getPendingResult() { 685e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult; 68668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn } 68768d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn 68868d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn /** 6899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control inclusion of debugging help for mismatched 6909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calls to {@ Context#registerReceiver(BroadcastReceiver, IntentFilter) 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.registerReceiver()}. 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If called with true, before given to registerReceiver(), then the 6939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * callstack of the following {@link Context#unregisterReceiver(BroadcastReceiver) 6949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.unregisterReceiver()} call is retained, to be printed if a later 6959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * incorrect unregister call is made. Note that doing this requires retaining 6969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information about the BroadcastReceiver for the lifetime of the app, 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * resulting in a leak -- this should only be used for debugging. 6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setDebugUnregister(boolean debug) { 7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDebugUnregister = debug; 7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the last value given to {@link #setDebugUnregister}. 7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean getDebugUnregister() { 7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mDebugUnregister; 7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void checkSynchronousHint() { 711e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult == null) { 712e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn throw new IllegalStateException("Call while result is not pending"); 713e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 714e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 71568d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn // Note that we don't assert when receiving the initial sticky value, 71668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn // since that may have come from an ordered broadcast. We'll catch 71768d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn // them later when the real broadcast happens again. 718e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult.mOrderedHint || mPendingResult.mInitialStickyHint) { 7199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 7209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 7229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "BroadcastReceiver trying to return result during a non-ordered broadcast"); 7239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.fillInStackTrace(); 7249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e("BroadcastReceiver", e.getMessage(), e); 7259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 728