FileDocCategorySizeDatePackage
Service.javaAPI DocAndroid 1.5 API16294Wed May 06 22:41:54 BST 2009android.app

Service

public abstract class Service extends android.content.ContextWrapper implements android.content.ComponentCallbacks
A Service is an application component that runs in the background, not interacting with the user, for an indefinite period of time. Each service class must have a corresponding {@link android.R.styleable#AndroidManifestService <service>} declaration in its package's AndroidManifest.xml. Services can be started with {@link android.content.Context#startService Context.startService()} and {@link android.content.Context#bindService Context.bindService()}.

Note that services, like other application objects, run in the main thread of their hosting process. This means that, if your service is going to do any CPU intensive (such as MP3 playback) or blocking (such as networking) operations, it should spawn its own thread in which to do that work. More information on this can be found in Application Fundamentals: Processes and Threads.

The Service class is an important part of an application's overall lifecycle.

Topics covered here:

  1. Service Lifecycle
  2. Permissions
  3. Process Lifecycle

Service Lifecycle

There are two reasons that a service can be run by the system. If someone calls {@link android.content.Context#startService Context.startService()} then the system will retrieve the service (creating it and calling its {@link #onCreate} method if needed) and then call its {@link #onStart} method with the arguments supplied by the client. The service will at this point continue running until {@link android.content.Context#stopService Context.stopService()} or {@link #stopSelf()} is called. Note that multiple calls to Context.startService() do not nest (though they do result in multiple corresponding calls to onStart()), so no matter how many times it is started a service will be stopped once Context.stopService() or stopSelf() is called.

Clients can also use {@link android.content.Context#bindService Context.bindService()} to obtain a persistent connection to a service. This likewise creates the service if it is not already running (calling {@link #onCreate} while doing so), but does not call onStart(). The client will receive the {@link android.os.IBinder} object that the service returns from its {@link #onBind} method, allowing the client to then make calls back to the service. The service will remain running as long as the connection is established (whether or not the client retains a reference on the service's IBinder). Usually the IBinder returned is for a complex interface that has been written in aidl.

A service can be both started and have connections bound to it. In such a case, the system will keep the service running as long as either it is started or there are one or more connections to it with the {@link android.content.Context#BIND_AUTO_CREATE Context.BIND_AUTO_CREATE} flag. Once neither of these situations hold, the service's {@link #onDestroy} method is called and the service is effectively terminated. All cleanup (stopping threads, unregistering receivers) should be complete upon returning from onDestroy().

Permissions

Global access to a service can be enforced when it is declared in its manifest's {@link android.R.styleable#AndroidManifestService <service>} tag. By doing so, other applications will need to declare a corresponding {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} element in their own manifest to be able to start, stop, or bind to the service.

In addition, a service can protect individual IPC calls into it with permissions, by calling the {@link #checkCallingPermission} method before executing the implementation of that call.

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

Process Lifecycle

The Android system will attempt to keep the process hosting a service around as long as the service has been started or has clients bound to it. When running low on memory and needing to kill existing processes, the priority of a process hosting the service will be the higher of the following possibilities:

  • If the service is currently executing code in its {@link #onCreate onCreate()}, {@link #onStart onStart()}, or {@link #onDestroy onDestroy()} methods, then the hosting process will be a foreground process to ensure this code can execute without being killed.

  • If the service has been started, then its hosting process is considered to be less important than any processes that are currently visible to the user on-screen, but more important than any process not visible. Because only a few processes are generally visible to the user, this means that the service should not be killed except in extreme low memory conditions.

  • If there are clients bound to the service, then the service's hosting process is never less important than the most important client. That is, if one of its clients is visible to the user, then the service itself is considered to be visible.

Note this means that most of the time your service is running, it may be killed by the system if it is under heavy memory pressure. If this happens, the system will later try to restart the service. An important consequence of this is that if you implement {@link #onStart onStart()} to schedule work to be done asynchronously or in another thread, then you may want to write information about that work into persistent storage during the onStart() call so that it does not get lost if the service later gets killed.

Other application components running in the same process as the service (such as an {@link android.app.Activity}) can, of course, increase the importance of the overall process beyond just the importance of the service itself.

Fields Summary
private static final String
TAG
private ActivityThread
mThread
private String
mClassName
private android.os.IBinder
mToken
private Application
mApplication
private IActivityManager
mActivityManager
Constructors Summary
public Service()


      
        super(null);
    
Methods Summary
public final voidattach(android.content.Context context, ActivityThread thread, java.lang.String className, android.os.IBinder token, Application application, java.lang.Object activityManager)

hide

        attachBaseContext(context);
        mThread = thread;           // NOTE:  unused - remove?
        mClassName = className;
        mToken = token;
        mApplication = application;
        mActivityManager = (IActivityManager)activityManager;
    
protected voiddump(java.io.FileDescriptor fd, java.io.PrintWriter writer, java.lang.String[] args)
Print the Service's state into the given stream. This gets invoked if you run "adb shell dumpsys activity service ". This is distinct from "dumpsys ", which only works for named system services and which invokes the {@link IBinder#dump} method on the {@link IBinder} interface registered with ServiceManager.

param
fd The raw file descriptor that the dump is being sent to.
param
writer The PrintWriter to which you should dump your state. This will be closed for you after you return.
param
args additional arguments to the dump request.

        writer.println("nothing to dump");
    
protected voidfinalize()

        super.finalize();
        //Log.i("Service", "Finalizing Service: " + this);
    
public final ApplicationgetApplication()
Return the application that owns this service.

        return mApplication;
    
final java.lang.StringgetClassName()

        return mClassName;
    
public abstract android.os.IBinderonBind(android.content.Intent intent)
Return the communication channel to the service. May return null if clients can not bind to the service. The returned {@link android.os.IBinder} is usually for a complex interface that has been described using aidl.

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process. More information about this can be found in Application Fundamentals: Processes and Threads.

param
intent The Intent that was used to bind to this service, as given to {@link android.content.Context#bindService Context.bindService}. Note that any extras that were included with the Intent at that point will not be seen here.
return
Return an IBinder through which clients can call on to the service.

public voidonConfigurationChanged(android.content.res.Configuration newConfig)

    
public voidonCreate()
Called by the system when the service is first created. Do not call this method directly.

    
public voidonDestroy()
Called by the system to notify a Service that it is no longer used and is being removed. The service should clean up an resources it holds (threads, registered receivers, etc) at this point. Upon return, there will be no more calls in to this Service object and it is effectively dead. Do not call this method directly.

    
public voidonLowMemory()

    
public voidonRebind(android.content.Intent intent)
Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its {@link #onUnbind}. This will only be called if the implementation of {@link #onUnbind} was overridden to return true.

param
intent The Intent that was used to bind to this service, as given to {@link android.content.Context#bindService Context.bindService}. Note that any extras that were included with the Intent at that point will not be seen here.

    
public voidonStart(android.content.Intent intent, int startId)
Called by the system every time a client explicitly starts the service by calling {@link android.content.Context#startService}, providing the arguments it supplied and a unique integer token representing the start request. Do not call this method directly.

param
intent The Intent supplied to {@link android.content.Context#startService}, as given.
param
startId A unique integer representing this specific request to start. Use with {@link #stopSelfResult(int)}.
see
#stopSelfResult(int)

    
public booleanonUnbind(android.content.Intent intent)
Called when all clients have disconnected from a particular interface published by the service. The default implementation does nothing and returns false.

param
intent The Intent that was used to bind to this service, as given to {@link android.content.Context#bindService Context.bindService}. Note that any extras that were included with the Intent at that point will not be seen here.
return
Return true if you would like to have the service's {@link #onRebind} method later called when new clients bind to it.

        return false;
    
public final voidsetForeground(boolean isForeground)
Control whether this service is considered to be a foreground service. By default services are background, meaning that if the system needs to kill them to reclaim more memory (such as to display a large page in a web browser), they can be killed without too much harm. You can set this flag if killing your service would be disruptive to the user: such as if your service is performing background music playback, so the user would notice if their music stopped playing.

param
isForeground Determines whether this service is considered to be foreground (true) or background (false).

        if (mActivityManager == null) {
            return;
        }
        try {
            mActivityManager.setServiceForeground(
                    new ComponentName(this, mClassName), mToken, isForeground);
        } catch (RemoteException ex) {
        }
    
public final voidstopSelf()
Stop the service, if it was previously started. This is the same as calling {@link android.content.Context#stopService} for this particular service.

see
#stopSelfResult(int)

        stopSelf(-1);
    
public final voidstopSelf(int startId)
Old version of {@link #stopSelfResult} that doesn't return a result.

see
#stopSelfResult

        if (mActivityManager == null) {
            return;
        }
        try {
            mActivityManager.stopServiceToken(
                    new ComponentName(this, mClassName), mToken, startId);
        } catch (RemoteException ex) {
        }
    
public final booleanstopSelfResult(int startId)
Stop the service if the most recent time it was started was startId. This is the same as calling {@link android.content.Context#stopService} for this particular service but allows you to safely avoid stopping if there is a start request from a client that you haven't yet seen in {@link #onStart}.

param
startId The most recent start identifier received in {@link #onStart}.
return
Returns true if the startId matches the last start request and the service will be stopped, else false.
see
#stopSelf()

        if (mActivityManager == null) {
            return false;
        }
        try {
            return mActivityManager.stopServiceToken(
                    new ComponentName(this, mClassName), mToken, startId);
        } catch (RemoteException ex) {
        }
        return false;