BroadcastReceiver.java revision 7871badd5d4d29d80207e9cc09a0681f26a151d0
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(). 317871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 327871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>If you don't need to send broadcasts across applications, consider using 337871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * this class with {@link android.support.v4.content.LocalBroadcastManager} instead 347871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * of the more general facilities described below. This will give you a much 357871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * more efficient implementation (no cross-process communication needed) and allow 367871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * you to avoid thinking about any security issues related to other applications 377871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * being able to receive or send your broadcasts. 387871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 397871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>You can either dynamically register an instance of this class with 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#registerReceiver Context.registerReceiver()} 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or statically publish an implementation through the 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestReceiver <receiver>} 437871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * tag in your <code>AndroidManifest.xml</code>. 447871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 457871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p><em><strong>Note:</strong></em> 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If registering a receiver in your 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onResume() Activity.onResume()} 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * implementation, you should unregister it in 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onPause() Activity.onPause()}. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (You won't receive intents when paused, 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and this will cut down on unnecessary system overhead). Do not unregister in 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#onSaveInstanceState(android.os.Bundle) Activity.onSaveInstanceState()}, 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * because this won't be called if the user moves back in the history 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * stack. 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>There are two major classes of broadcasts that can be received:</p> 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> <b>Normal broadcasts</b> (sent with {@link Context#sendBroadcast(Intent) 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}) are completely asynchronous. All receivers of the 60a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * broadcast are run in an undefined order, often at the same time. This is 61a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * more efficient, but means that receivers cannot use the result or abort 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * APIs included here. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> <b>Ordered broadcasts</b> (sent with {@link Context#sendOrderedBroadcast(Intent, String) 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}) are delivered to one receiver at a time. 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * As each receiver executes in turn, it can propagate a result to the next 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receiver, or it can completely abort the broadcast so that it won't be passed 67a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * to other receivers. The order receivers run in can be controlled with the 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestIntentFilter_priority 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * android:priority} attribute of the matching intent-filter; receivers with 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the same priority will be run in an arbitrary order. 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Even in the case of normal broadcasts, the system may in some 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * situations revert to delivering the broadcast one receiver at a time. In 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * particular, for receivers that may require the creation of a process, only 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one will be run at a time to avoid overloading the system with new processes. 77a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * In this situation, however, the non-ordered semantics hold: these receivers still 78a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * cannot return results or abort their broadcast.</p> 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Note that, although the Intent class is used for sending and receiving 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * these broadcasts, the Intent broadcast mechanism here is completely separate 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from Intents that are used to start Activities with 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#startActivity Context.startActivity()}. 84105925376f8d0f6b318c9938c7b83ef7fef094daThe Android Open Source Project * There is no way for a BroadcastReceiver 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to see or capture Intents used with startActivity(); likewise, when 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you broadcast an Intent, you will never find or start an Activity. 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * These two operations are semantically very different: starting an 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity with an Intent is a foreground operation that modifies what the 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user is currently interacting with; broadcasting an Intent is a background 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * operation that the user is not normally aware of. 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The BroadcastReceiver class (when launched as a component through 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a manifest's {@link android.R.styleable#AndroidManifestReceiver <receiver>} 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag) is an important part of an 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a href="{@docRoot}guide/topics/fundamentals.html#lcycles">application's overall lifecycle</a>.</p> 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Topics covered here: 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ol> 997871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <li><a href="#Security">Security</a> 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#ReceiverLifecycle">Receiver Lifecycle</a> 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><a href="#ProcessLifecycle">Process Lifecycle</a> 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ol> 103b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * 104b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <div class="special reference"> 105b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <h3>Developer Guides</h3> 106b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <p>For information about how to use this class to receive and resolve intents, read the 107b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a> 108b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * developer guide.</p> 109b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * </div> 110b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23Joe Fernandez * 1117871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <a name="Security"></a> 1127871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <h3>Security</h3> 1137871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1147871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>Receivers used with the {@link Context} APIs are by their nature a 1157871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * cross-application facility, so you must consider how other applications 1167871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * may be able to abuse your use of them. Some things to consider are: 1177871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1187871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <ul> 1197871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <li><p>The Intent namespace is global. Make sure that Intent action names and 1207871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * other strings are written in a namespace you own, or else you may inadvertantly 1217871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * conflict with other applications. 1227871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <li><p>When you use {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)}, 1237871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <em>any</em> application may send broadcasts to that registered receiver. You can 1247871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * control who can send broadcasts to it through permissions described below. 1257871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <li><p>When you publish a receiver in your application's manifest and specify 1267871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * intent-filters for it, any other application can send broadcasts to it regardless 1277871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * of the filters you specify. To prevent others from sending to it, make it 1287871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * unavailable to them with <code>android:exported="false"</code>. 1297871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <li><p>When you use {@link Context#sendBroadcast(Intent)} or related methods, 1307871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * normally any other application can receive these broadcasts. You can control who 1317871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * can receive such broadcasts through permissions described below. Alternatively, 1327871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * starting with {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, you 1337871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * can also safely restrict the broadcast to a single application with 1347871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * {@link Intent#setPackage(String) Intent.setPackage} 1357871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * </ul> 1367871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1377871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>None of these issues exist when using 1387871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * {@link android.support.v4.content.LocalBroadcastManager}, since intents 1397871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * broadcast it never go outside of the current process. 1407871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Access permissions can be enforced by either the sender or receiver 1427871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * of a broadcast. 1437871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>To enforce a permission when sending, you supply a non-null 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>permission</var> argument to 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendBroadcast(Intent, String)} or 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, Bundle)}. 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Only receivers who have been granted this permission 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (by requesting it with the 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in their <code>AndroidManifest.xml</code>) will be able to receive 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the broadcast. 1537871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>To enforce a permission when receiving, you supply a non-null 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>permission</var> when registering your receiver -- either when calling 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter, String, android.os.Handler)} 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or in the static 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestReceiver <receiver>} 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in your <code>AndroidManifest.xml</code>. Only broadcasters who have 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * been granted this permission (by requesting it with the 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * tag in their <code>AndroidManifest.xml</code>) will be able to send an 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent to the receiver. 1647871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a> 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * document for more information on permissions and security in general. 1677871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1687871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <a name="ReceiverLifecycle"></a> 1697871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <h3>Receiver Lifecycle</h3> 1707871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1717871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>A BroadcastReceiver object is only valid for the duration of the call 1727871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * to {@link #onReceive}. Once your code returns from this function, 1737871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * the system considers the object to be finished and no longer active. 1747871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1757871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>This has important repercussions to what you can do in an 1767871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * {@link #onReceive} implementation: anything that requires asynchronous 1777871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * operation is not available, because you will need to return from the 1787871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * function to handle the asynchronous operation, but at that point the 1797871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * BroadcastReceiver is no longer active and thus the system is free to kill 1807871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * its process before the asynchronous operation completes. 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1827871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * <p>In particular, you may <i>not</i> show a dialog or bind to a service from 1837871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * within a BroadcastReceiver. For the former, you should instead use the 1847871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * {@link android.app.NotificationManager} API. For the latter, you can 1857871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * use {@link android.content.Context#startService Context.startService()} to 1867871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * send a command to the service. 1877871badd5d4d29d80207e9cc09a0681f26a151d0Dianne Hackborn * 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <a name="ProcessLifecycle"></a> 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Process Lifecycle</h3> 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 191105925376f8d0f6b318c9938c7b83ef7fef094daThe Android Open Source Project * <p>A process that is currently executing a BroadcastReceiver (that is, 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * currently running the code in its {@link #onReceive} method) is 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * considered to be a foreground process and will be kept running by the 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * system except under cases of extreme memory pressure. 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Once you return from onReceive(), the BroadcastReceiver is no longer 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * active, and its hosting process is only as important as any other application 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * components that are running in it. This is especially important because if 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that process was only hosting the BroadcastReceiver (a common case for 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * applications that the user has never or not recently interacted with), then 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * upon returning from onReceive() the system will consider its process 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to be empty and aggressively kill it so that resources are available for other 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * more important processes. 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This means that for longer-running operations you will often use 206a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * a {@link android.app.Service} in conjunction with a BroadcastReceiver to keep 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the containing process active for the entire time of your operation. 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic abstract class BroadcastReceiver { 210e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn private PendingResult mPendingResult; 211e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn private boolean mDebugUnregister; 212e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 213e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 214e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * State for a result that is pending for a broadcast receiver. Returned 215e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * by {@link BroadcastReceiver#goAsync() goAsync()} 216e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * while in {@link BroadcastReceiver#onReceive BroadcastReceiver.onReceive()}. 217327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * This allows you to return from onReceive() without having the broadcast 218327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * terminate; you must call {@link #finish()} once you are done with the 219327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * broadcast. This allows you to process the broadcast off of the main 220327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * thread of your app. 221327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * 222327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * <p>Note on threading: the state inside of this class is not itself 223327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * thread-safe, however you can use it from any thread if you properly 224327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * sure that you do not have races. Typically this means you will hand 225327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * the entire object to another thread, which will be solely responsible 226327fbd2c8fa294b919475feb4c74a74ee1981e02Dianne Hackborn * for setting any results and finally calling {@link #finish()}. 227e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 228e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static class PendingResult { 229e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 230e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static final int TYPE_COMPONENT = 0; 231e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 232e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static final int TYPE_REGISTERED = 1; 233e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 234e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public static final int TYPE_UNREGISTERED = 2; 235e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 236e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final int mType; 237e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final boolean mOrderedHint; 238e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final boolean mInitialStickyHint; 239e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final IBinder mToken; 240e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 241e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn int mResultCode; 242e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn String mResultData; 243e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Bundle mResultExtras; 244e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn boolean mAbortBroadcast; 245e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn boolean mFinished; 246e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 247e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 248e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public PendingResult(int resultCode, String resultData, Bundle resultExtras, 249e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn int type, boolean ordered, boolean sticky, IBinder token) { 250e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultCode = resultCode; 251e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultData = resultData; 252e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras = resultExtras; 253e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mType = type; 254e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mOrderedHint = ordered; 255e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mInitialStickyHint = sticky; 256e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mToken = token; 257e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 258e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 259e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 260e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResultCode(int) 261e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResultCode(int)} for 262e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 263e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 264e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResultCode(int code) { 265e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 266e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultCode = code; 267e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 268e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 269e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 270e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getResultCode() 271e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getResultCode()} for 272e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 273e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 274e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final int getResultCode() { 275e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mResultCode; 276e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 277e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 278e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 279e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResultData(String) 280e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResultData(String)} for 281e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 282e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 283e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResultData(String data) { 284e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 285e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultData = data; 286e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 287e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 288e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 289e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getResultData() 290e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getResultData()} for 291e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 292e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 293e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final String getResultData() { 294e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mResultData; 295e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 296e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 297e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 298e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResultExtras(Bundle) 299e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResultExtras(Bundle)} for 300e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 301e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 302e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResultExtras(Bundle extras) { 303e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 304e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras = extras; 305e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 306e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 307e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 308e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getResultExtras(boolean) 309e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getResultExtras(boolean)} for 310e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 311e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 312e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final Bundle getResultExtras(boolean makeMap) { 313e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Bundle e = mResultExtras; 314e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (!makeMap) return e; 315e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (e == null) mResultExtras = e = new Bundle(); 316e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return e; 317e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 318e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 319e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 320e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#setResult(int, String, Bundle) 321e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.setResult(int, String, Bundle)} for 322e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 323e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 324e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setResult(int code, String data, Bundle extras) { 325e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 326e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultCode = code; 327e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultData = data; 328e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras = extras; 329e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 330e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 331e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 332e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#getAbortBroadcast() 333e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.getAbortBroadcast()} for 334e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 335e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 336e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final boolean getAbortBroadcast() { 337e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mAbortBroadcast; 338e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 339e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 340e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 341e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#abortBroadcast() 342e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.abortBroadcast()} for 343e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 344e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 345e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void abortBroadcast() { 346e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn checkSynchronousHint(); 347e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mAbortBroadcast = true; 348e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 349e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 350e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 351e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Version of {@link BroadcastReceiver#clearAbortBroadcast() 352e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * BroadcastReceiver.clearAbortBroadcast()} for 353e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * asynchronous broadcast handling. 354e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 355e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void clearAbortBroadcast() { 356e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mAbortBroadcast = false; 357e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 358e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 359e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 360e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Finish the broadcast. The current result will be sent and the 361e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * next broadcast will proceed. 362e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 363e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void finish() { 364e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mType == TYPE_COMPONENT) { 365e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final IActivityManager mgr = ActivityManagerNative.getDefault(); 366e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (QueuedWork.hasPendingWork()) { 367e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // If this is a broadcast component, we need to make sure any 368e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // queued work is complete before telling AM we are done, so 369e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // we don't have our process killed before that. We now know 370e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // there is pending work; put another piece of work at the end 371e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // of the list to finish the broadcast, so we don't block this 372e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // thread (which may be the main thread) to have it finished. 373e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // 374e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // Note that we don't need to use QueuedWork.add() with the 375e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // runnable, since we know the AM is waiting for us until the 376e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // executor gets to it. 377e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn QueuedWork.singleThreadExecutor().execute( new Runnable() { 378e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn @Override public void run() { 379e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (ActivityThread.DEBUG_BROADCAST) Slog.i(ActivityThread.TAG, 380e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "Finishing broadcast after work to component " + mToken); 381e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn sendFinished(mgr); 382e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 383e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn }); 384e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } else { 385e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (ActivityThread.DEBUG_BROADCAST) Slog.i(ActivityThread.TAG, 386e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "Finishing broadcast to component " + mToken); 387e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn sendFinished(mgr); 388e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 389e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } else if (mOrderedHint && mType != TYPE_UNREGISTERED) { 390e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (ActivityThread.DEBUG_BROADCAST) Slog.i(ActivityThread.TAG, 391e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "Finishing broadcast to " + mToken); 392e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn final IActivityManager mgr = ActivityManagerNative.getDefault(); 393e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn sendFinished(mgr); 394e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 395e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 396e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 397e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 398e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public void setExtrasClassLoader(ClassLoader cl) { 399e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mResultExtras != null) { 400e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mResultExtras.setClassLoader(cl); 401e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 402e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 403e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 404e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** @hide */ 405e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public void sendFinished(IActivityManager am) { 406e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn synchronized (this) { 407e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mFinished) { 408e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn throw new IllegalStateException("Broadcast already finished"); 409e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 410e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mFinished = true; 411e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 412e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn try { 4139ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn if (mResultExtras != null) { 4149ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn mResultExtras.setAllowFds(false); 4159ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn } 416e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mOrderedHint) { 417e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn am.finishReceiver(mToken, mResultCode, mResultData, mResultExtras, 418e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mAbortBroadcast); 419e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } else { 420e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // This broadcast was sent to a component; it is not ordered, 421e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // but we still need to tell the activity manager we are done. 422e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn am.finishReceiver(mToken, 0, null, null, false); 423e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 424e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } catch (RemoteException ex) { 425e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 426e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 427e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 428e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 429e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn void checkSynchronousHint() { 430e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // Note that we don't assert when receiving the initial sticky value, 431e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // since that may have come from an ordered broadcast. We'll catch 432e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // them later when the real broadcast happens again. 433e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mOrderedHint || mInitialStickyHint) { 434e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return; 435e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 436e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn RuntimeException e = new RuntimeException( 437e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn "BroadcastReceiver trying to return result during a non-ordered broadcast"); 438e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn e.fillInStackTrace(); 439e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Log.e("BroadcastReceiver", e.getMessage(), e); 440e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 441e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 442e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public BroadcastReceiver() { 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This method is called when the BroadcastReceiver is receiving an Intent 4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcast. During this time you can use the other methods on 4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * BroadcastReceiver to view/modify the current result values. The function 450a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * is normally called within the main thread of its process, so you should 4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * never perform long-running operations in it (there is a timeout of 4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10 seconds that the system allows before considering the receiver to 4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be blocked and a candidate to be killed). You cannot launch a popup dialog 4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in your implementation of onReceive(). 4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>If this BroadcastReceiver was launched through a <receiver> tag, 4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * then the object is no longer alive after returning from this 4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * function.</b> This means you should not perform any operations that 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return a result to you asynchronously -- in particular, for interacting 4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with services, you should use 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#startService(Intent)} instead of 4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#bindService(Intent, ServiceConnection, int)}. If you wish 4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to interact with a service that is already running, you can use 4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #peekService}. 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 466a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * <p>The Intent filters used in {@link android.content.Context#registerReceiver} 467a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * and in application manifests are <em>not</em> guaranteed to be exclusive. They 468a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * are hints to the operating system about how to find suitable recipients. It is 469a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * possible for senders to force delivery to specific recipients, bypassing filter 470a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * resolution. For this reason, {@link #onReceive(Context, Intent) onReceive()} 471a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * implementations should respond only to known actions, ignoring any unexpected 472a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * Intents that they may receive. 473a34df8a2ba450b2c2ad83ccbbac30b80e2706bb2Chris Tate * 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param context The Context in which the receiver is running. 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent The Intent being received. 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public abstract void onReceive(Context context, Intent intent); 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 480e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * This can be called by an application in {@link #onReceive} to allow 481e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * it to keep the broadcast active after returning from that function. 482e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * This does <em>not</em> change the expectation of being relatively 483e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * responsive to the broadcast (finishing it within 10s), but does allow 484e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * the implementation to move work related to it over to another thread 485e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * to avoid glitching the main UI thread due to disk IO. 486e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * 487e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * @return Returns a {@link PendingResult} representing the result of 488e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * the active broadcast. The BroadcastRecord itself is no longer active; 489e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * all data and other interaction must go through {@link PendingResult} 490e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * APIs. The {@link PendingResult#finish PendingResult.finish()} method 491e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * must be called once processing of the broadcast is done. 492e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 493e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final PendingResult goAsync() { 494e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn PendingResult res = mPendingResult; 495e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult = null; 496e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return res; 497e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 498e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 499e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Provide a binder to an already-running service. This method is synchronous 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and will not start the target service if it is not present, so it is safe 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to call from {@link #onReceive}. 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param myContext The Context that had been passed to {@link #onReceive(Context, Intent)} 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param service The Intent indicating the service you wish to use. See {@link 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context#startService(Intent)} for more information. 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public IBinder peekService(Context myContext, Intent service) { 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IActivityManager am = ActivityManagerNative.getDefault(); 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IBinder binder = null; 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 5129ecebbfbf768fd63e9a6c9a09c86d81c7737ee2dDianne Hackborn service.setAllowFds(false); 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project binder = am.peekService(service, service.resolveTypeIfNeeded( 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project myContext.getContentResolver())); 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (RemoteException e) { 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return binder; 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the current result code of this broadcast; only works with 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcasts sent through 5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 5249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. Often uses the 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity {@link android.app.Activity#RESULT_CANCELED} and 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#RESULT_OK} constants, though the 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * actual meaning of this value is ultimately up to the broadcaster. 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 529e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * <p class="note">This method does not work with non-ordered broadcasts such 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 531e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * Context.sendBroadcast}</p> 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param code The new result code. 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setResult(int, String, Bundle) 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResultCode(int code) { 5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 539e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultCode = code; 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current result code, as set by the previous receiver. 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return int The current result code. 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final int getResultCode() { 548e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mResultCode : 0; 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the current result data of this broadcast; only works with 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcasts sent through 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. This is an arbitrary 5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * string whose interpretation is up to the broadcaster. 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param data The new result data; may be null. 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setResult(int, String, Bundle) 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResultData(String data) { 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 568e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultData = data; 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current result data, as set by the previous receiver. 5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Often this is null. 5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return String The current result data; may be null. 5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final String getResultData() { 578e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mResultData : null; 5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the current result extras of this broadcast; only works with 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcasts sent through 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. This is a Bundle 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * holding arbitrary data, whose interpretation is up to the 5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcaster. Can be set to null. Calling this method completely 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaces the current map (if any). 5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param extras The new extra data map; may be null. 5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setResult(int, String, Bundle) 5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResultExtras(Bundle extras) { 5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 600e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultExtras = extras; 6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current result extra data, as set by the previous receiver. 6059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Any changes you make to the returned Map will be propagated to the next 6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receiver. 6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param makeMap If true then a new empty Map will be made for you if the 6099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current Map is null; if false you should be prepared to 6109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * receive a null Map. 6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Map The current extras map. 6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final Bundle getResultExtras(boolean makeMap) { 615e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult == null) { 616e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return null; 617e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 618e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn Bundle e = mPendingResult.mResultExtras; 6199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!makeMap) return e; 620e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (e == null) mPendingResult.mResultExtras = e = new Bundle(); 6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return e; 6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change all of the result data returned from this broadcasts; only works 6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with broadcasts sent through 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. All current result data is replaced 6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * by the value given to this method. 6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 6349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param code The new result code. Often uses the 6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Activity {@link android.app.Activity#RESULT_CANCELED} and 6379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.app.Activity#RESULT_OK} constants, though the 6389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * actual meaning of this value is ultimately up to the broadcaster. 6399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param data The new result data. This is an arbitrary 6409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * string whose interpretation is up to the broadcaster; may be null. 6419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param extras The new extra data map. This is a Bundle 6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * holding arbitrary data, whose interpretation is up to the 6439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcaster. Can be set to null. This completely 6449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaces the current map (if any). 6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setResult(int code, String data, Bundle extras) { 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 648e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultCode = code; 649e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultData = data; 650e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mResultExtras = extras; 6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the flag indicating whether or not this receiver should 6559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * abort the current broadcast. 6569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the broadcast should be aborted. 6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean getAbortBroadcast() { 660e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mAbortBroadcast : false; 6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the flag indicating that this receiver should abort the 6659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current broadcast; only works with broadcasts sent through 6669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 6679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast}. This will prevent 6689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * any other broadcast receivers from receiving the broadcast. It will still 6699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * call {@link #onReceive} of the BroadcastReceiver that the caller of 6709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#sendOrderedBroadcast(Intent, String) 6719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendOrderedBroadcast} passed in. 6729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>This method does not work with non-ordered broadcasts such 6749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as those sent with {@link Context#sendBroadcast(Intent) 6759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.sendBroadcast}</strong></p> 6769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void abortBroadcast() { 6789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkSynchronousHint(); 679e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mAbortBroadcast = true; 6809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Clears the flag indicating that this receiver should abort the current 6849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * broadcast. 6859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void clearAbortBroadcast() { 687e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult != null) { 688e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult.mAbortBroadcast = false; 689e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 6909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 69368d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * Returns true if the receiver is currently processing an ordered 69468d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * broadcast. 69568d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn */ 69668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn public final boolean isOrderedBroadcast() { 697e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mOrderedHint : false; 69868d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn } 69968d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn 70068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn /** 70168d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * Returns true if the receiver is currently processing the initial 70268d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * value of a sticky broadcast -- that is, the value that was last 70368d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * broadcast and is currently held in the sticky cache, so this is 70468d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn * not directly the result of a broadcast right now. 70568d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn */ 70668d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn public final boolean isInitialStickyBroadcast() { 707e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult != null ? mPendingResult.mInitialStickyHint : false; 70868d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn } 70968d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn 71068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn /** 7119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For internal use, sets the hint about whether this BroadcastReceiver is 7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * running in ordered mode. 7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setOrderedHint(boolean isOrdered) { 715e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn // Accidentally left in the SDK. 7169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 719e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * For internal use to set the result data that is active. @hide 72068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn */ 721e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final void setPendingResult(PendingResult result) { 722e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn mPendingResult = result; 723e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 724e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 725e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn /** 726e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn * For internal use to set the result data that is active. @hide 727e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn */ 728e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn public final PendingResult getPendingResult() { 729e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn return mPendingResult; 73068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn } 73168d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn 73268d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn /** 7339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control inclusion of debugging help for mismatched 7349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calls to {@ Context#registerReceiver(BroadcastReceiver, IntentFilter) 7359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.registerReceiver()}. 7369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If called with true, before given to registerReceiver(), then the 7379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * callstack of the following {@link Context#unregisterReceiver(BroadcastReceiver) 7389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.unregisterReceiver()} call is retained, to be printed if a later 7399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * incorrect unregister call is made. Note that doing this requires retaining 7409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information about the BroadcastReceiver for the lifetime of the app, 7419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * resulting in a leak -- this should only be used for debugging. 7429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final void setDebugUnregister(boolean debug) { 7449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDebugUnregister = debug; 7459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the last value given to {@link #setDebugUnregister}. 7499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean getDebugUnregister() { 7519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mDebugUnregister; 7529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void checkSynchronousHint() { 755e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult == null) { 756e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn throw new IllegalStateException("Call while result is not pending"); 757e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn } 758e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn 75968d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn // Note that we don't assert when receiving the initial sticky value, 76068d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn // since that may have come from an ordered broadcast. We'll catch 76168d881cf2d2b252f6f795cd64d43e316a1d736e5Dianne Hackborn // them later when the real broadcast happens again. 762e829fef63957a23b61cdb01bb692a17a041ff2dcDianne Hackborn if (mPendingResult.mOrderedHint || mPendingResult.mInitialStickyHint) { 7639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 7649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeException e = new RuntimeException( 7669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "BroadcastReceiver trying to return result during a non-ordered broadcast"); 7679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.fillInStackTrace(); 7689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e("BroadcastReceiver", e.getMessage(), e); 7699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 7719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 772