FileDocCategorySizeDatePackage
BroadcastReceiver.javaAPI DocAndroid 1.5 API19043Wed May 06 22:41:54 BST 2009android.content

BroadcastReceiver

public abstract class BroadcastReceiver extends Object
Base class for code that will receive intents sent by sendBroadcast(). You can either dynamically register an instance of this class with {@link Context#registerReceiver Context.registerReceiver()} or statically publish an implementation through the {@link android.R.styleable#AndroidManifestReceiver <receiver>} tag in your AndroidManifest.xml. Note:    If registering a receiver in your {@link android.app.Activity#onResume() Activity.onResume()} implementation, you should unregister it in {@link android.app.Activity#onPause() Activity.onPause()}. (You won't receive intents when paused, and this will cut down on unnecessary system overhead). Do not unregister in {@link android.app.Activity#onSaveInstanceState(android.os.Bundle) Activity.onSaveInstanceState()}, because this won't be called if the user moves back in the history stack.

There are two major classes of broadcasts that can be received:

  • Normal broadcasts (sent with {@link Context#sendBroadcast(Intent) Context.sendBroadcast}) are completely asynchronous. All receivers of the broadcast are run in an undefined order, often at the same time. This is more efficient, but means that receivers cannot use the result or abort APIs included here.
  • Ordered broadcasts (sent with {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast}) are delivered to one receiver at a time. As each receiver executes in turn, it can propagate a result to the next receiver, or it can completely abort the broadcast so that it won't be passed to other receivers. The order receivers run in can be controlled with the {@link android.R.styleable#AndroidManifestIntentFilter_priority android:priority} attribute of the matching intent-filter; receivers with the same priority will be run in an arbitrary order.

Even in the case of normal broadcasts, the system may in some situations revert to delivering the broadcast one receiver at a time. In particular, for receivers that may require the creation of a process, only one will be run at a time to avoid overloading the system with new processes. In this situation, however, the non-ordered semantics hold: these receivers still cannot return results or abort their broadcast.

Note that, although the Intent class is used for sending and receiving these broadcasts, the Intent broadcast mechanism here is completely separate from Intents that are used to start Activities with {@link Context#startActivity Context.startActivity()}. There is no way for a BroadcastReceiver to see or capture Intents used with startActivity(); likewise, when you broadcast an Intent, you will never find or start an Activity. These two operations are semantically very different: starting an Activity with an Intent is a foreground operation that modifies what the user is currently interacting with; broadcasting an Intent is a background operation that the user is not normally aware of.

The BroadcastReceiver class (when launched as a component through a manifest's {@link android.R.styleable#AndroidManifestReceiver <receiver>} tag) is an important part of an application's overall lifecycle.

Topics covered here:

  1. Receiver Lifecycle
  2. Permissions
  3. Process Lifecycle

Receiver Lifecycle

A BroadcastReceiver object is only valid for the duration of the call to {@link #onReceive}. Once your code returns from this function, the system considers the object to be finished and no longer active.

This has important repercussions to what you can do in an {@link #onReceive} implementation: anything that requires asynchronous operation is not available, because you will need to return from the function to handle the asynchronous operation, but at that point the BroadcastReceiver is no longer active and thus the system is free to kill its process before the asynchronous operation completes.

In particular, you may not show a dialog or bind to a service from within a BroadcastReceiver. For the former, you should instead use the {@link android.app.NotificationManager} API. For the latter, you can use {@link android.content.Context#startService Context.startService()} to send a command to the service.

Permissions

Access permissions can be enforced by either the sender or receiver of an Intent.

To enforce a permission when sending, you supply a non-null permission argument to {@link Context#sendBroadcast(Intent, String)} or {@link Context#sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, Bundle)}. Only receivers who have been granted this permission (by requesting it with the {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} tag in their AndroidManifest.xml) will be able to receive the broadcast.

To enforce a permission when receiving, you supply a non-null permission when registering your receiver -- either when calling {@link Context#registerReceiver(BroadcastReceiver, IntentFilter, String, android.os.Handler)} or in the static {@link android.R.styleable#AndroidManifestReceiver <receiver>} tag in your AndroidManifest.xml. Only broadcasters who have been granted this permission (by requesting it with the {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} tag in their AndroidManifest.xml) will be able to send an Intent to the receiver.

See the Security and Permissions document for more information on permissions and security in general.

Process Lifecycle

A process that is currently executing a BroadcastReceiver (that is, currently running the code in its {@link #onReceive} method) is considered to be a foreground process and will be kept running by the system except under cases of extreme memory pressure.

Once you return from onReceive(), the BroadcastReceiver is no longer active, and its hosting process is only as important as any other application components that are running in it. This is especially important because if that process was only hosting the BroadcastReceiver (a common case for applications that the user has never or not recently interacted with), then upon returning from onReceive() the system will consider its process to be empty and aggressively kill it so that resources are available for other more important processes.

This means that for longer-running operations you will often use a {@link android.app.Service} in conjunction with a BroadcastReceiver to keep the containing process active for the entire time of your operation.

Fields Summary
private int
mResultCode
private String
mResultData
private android.os.Bundle
mResultExtras
private boolean
mAbortBroadcast
private boolean
mDebugUnregister
private boolean
mOrderedHint
Constructors Summary
public BroadcastReceiver()

    
Methods Summary
public final voidabortBroadcast()
Sets the flag indicating that this receiver should abort the current broadcast; only works with broadcasts sent through {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast}. This will prevent any other broadcast receivers from receiving the broadcast. It will still call {@link #onReceive} of the BroadcastReceiver that the caller of {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast} passed in.

This method does not work with non-ordered broadcasts such as those sent with {@link Context#sendBroadcast(Intent) Context.sendBroadcast}

        checkSynchronousHint();
        mAbortBroadcast = true;
    
voidcheckSynchronousHint()

        if (mOrderedHint) {
            return;
        }
        RuntimeException e = new RuntimeException(
                "BroadcastReceiver trying to return result during a non-ordered broadcast");
        e.fillInStackTrace();
        Log.e("BroadcastReceiver", e.getMessage(), e);
    
public final voidclearAbortBroadcast()
Clears the flag indicating that this receiver should abort the current broadcast.

        mAbortBroadcast = false;
    
public final booleangetAbortBroadcast()
Returns the flag indicating whether or not this receiver should abort the current broadcast.

return
True if the broadcast should be aborted.

        return mAbortBroadcast;
    
public final booleangetDebugUnregister()
Return the last value given to {@link #setDebugUnregister}.

        return mDebugUnregister;
    
public final intgetResultCode()
Retrieve the current result code, as set by the previous receiver.

return
int The current result code.

        return mResultCode;
    
public final java.lang.StringgetResultData()
Retrieve the current result data, as set by the previous receiver. Often this is null.

return
String The current result data; may be null.

        return mResultData;
    
public final android.os.BundlegetResultExtras(boolean makeMap)
Retrieve the current result extra data, as set by the previous receiver. Any changes you make to the returned Map will be propagated to the next receiver.

param
makeMap If true then a new empty Map will be made for you if the current Map is null; if false you should be prepared to receive a null Map.
return
Map The current extras map.

        Bundle e = mResultExtras;
        if (!makeMap) return e;
        if (e == null) mResultExtras = e = new Bundle();
        return e;
    
public abstract voidonReceive(Context context, Intent intent)
This method is called when the BroadcastReceiver is receiving an Intent broadcast. During this time you can use the other methods on BroadcastReceiver to view/modify the current result values. The function is normally called within the main thread of its process, so you should never perform long-running operations in it (there is a timeout of 10 seconds that the system allows before considering the receiver to be blocked and a candidate to be killed). You cannot launch a popup dialog in your implementation of onReceive().

If this BroadcastReceiver was launched through a <receiver> tag, then the object is no longer alive after returning from this function. This means you should not perform any operations that return a result to you asynchronously -- in particular, for interacting with services, you should use {@link Context#startService(Intent)} instead of {@link Context#bindService(Intent, ServiceConnection, int)}. If you wish to interact with a service that is already running, you can use {@link #peekService}.

The Intent filters used in {@link android.content.Context#registerReceiver} and in application manifests are not guaranteed to be exclusive. They are hints to the operating system about how to find suitable recipients. It is possible for senders to force delivery to specific recipients, bypassing filter resolution. For this reason, {@link #onReceive(Context, Intent) onReceive()} implementations should respond only to known actions, ignoring any unexpected Intents that they may receive.

param
context The Context in which the receiver is running.
param
intent The Intent being received.

public android.os.IBinderpeekService(Context myContext, Intent service)
Provide a binder to an already-running service. This method is synchronous and will not start the target service if it is not present, so it is safe to call from {@link #onReceive}.

param
myContext The Context that had been passed to {@link #onReceive(Context, Intent)}
param
service The Intent indicating the service you wish to use. See {@link Context#startService(Intent)} for more information.

        IActivityManager am = ActivityManagerNative.getDefault();
        IBinder binder = null;
        try {
            binder = am.peekService(service, service.resolveTypeIfNeeded(
                    myContext.getContentResolver()));
        } catch (RemoteException e) {
        }
        return binder;
    
public final voidsetDebugUnregister(boolean debug)
Control inclusion of debugging help for mismatched calls to {@ Context#registerReceiver(BroadcastReceiver, IntentFilter) Context.registerReceiver()}. If called with true, before given to registerReceiver(), then the callstack of the following {@link Context#unregisterReceiver(BroadcastReceiver) Context.unregisterReceiver()} call is retained, to be printed if a later incorrect unregister call is made. Note that doing this requires retaining information about the BroadcastReceiver for the lifetime of the app, resulting in a leak -- this should only be used for debugging.

        mDebugUnregister = debug;
    
public final voidsetOrderedHint(boolean isOrdered)
For internal use, sets the hint about whether this BroadcastReceiver is running in ordered mode.

        mOrderedHint = isOrdered;
    
public final voidsetResult(int code, java.lang.String data, android.os.Bundle extras)
Change all of the result data returned from this broadcasts; only works with broadcasts sent through {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast}. All current result data is replaced by the value given to this method.

This method does not work with non-ordered broadcasts such as those sent with {@link Context#sendBroadcast(Intent) Context.sendBroadcast}

param
code The new result code. Often uses the Activity {@link android.app.Activity#RESULT_CANCELED} and {@link android.app.Activity#RESULT_OK} constants, though the actual meaning of this value is ultimately up to the broadcaster.
param
data The new result data. This is an arbitrary string whose interpretation is up to the broadcaster; may be null.
param
extras The new extra data map. This is a Bundle holding arbitrary data, whose interpretation is up to the broadcaster. Can be set to null. This completely replaces the current map (if any).

        checkSynchronousHint();
        mResultCode = code;
        mResultData = data;
        mResultExtras = extras;
    
public final voidsetResultCode(int code)
Change the current result code of this broadcast; only works with broadcasts sent through {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast}. Often uses the Activity {@link android.app.Activity#RESULT_CANCELED} and {@link android.app.Activity#RESULT_OK} constants, though the actual meaning of this value is ultimately up to the broadcaster.

This method does not work with non-ordered broadcasts such as those sent with {@link Context#sendBroadcast(Intent) Context.sendBroadcast}

param
code The new result code.
see
#setResult(int, String, Bundle)

        checkSynchronousHint();
        mResultCode = code;
    
public final voidsetResultData(java.lang.String data)
Change the current result data of this broadcast; only works with broadcasts sent through {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast}. This is an arbitrary string whose interpretation is up to the broadcaster.

This method does not work with non-ordered broadcasts such as those sent with {@link Context#sendBroadcast(Intent) Context.sendBroadcast}

param
data The new result data; may be null.
see
#setResult(int, String, Bundle)

        checkSynchronousHint();
        mResultData = data;
    
public final voidsetResultExtras(android.os.Bundle extras)
Change the current result extras of this broadcast; only works with broadcasts sent through {@link Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast}. This is a Bundle holding arbitrary data, whose interpretation is up to the broadcaster. Can be set to null. Calling this method completely replaces the current map (if any).

This method does not work with non-ordered broadcasts such as those sent with {@link Context#sendBroadcast(Intent) Context.sendBroadcast}

param
extras The new extra data map; may be null.
see
#setResult(int, String, Bundle)

        checkSynchronousHint();
        mResultExtras = extras;