Android Guides | Samples

Android.App.Service Class

A Service is an application component representing either an application's desire to perform a longer-running operation while not interacting with the user or to supply functionality for other applications to use.

See Also: Service

Syntax

[Android.Runtime.Register("android/app/Service", DoNotGenerateAcw=true)]
public abstract class Service : ContextWrapper, IComponentCallbacks2, IDisposable

Remarks

A Service is an application component representing either an application's desire to perform a longer-running operation while not interacting with the user or to supply functionality for other applications to use. Each service class must have a corresponding NoType:android/R$styleable;Href=../../../reference/android/R.styleable.html#AndroidManifestService declaration in its package's AndroidManifest.xml. Services can be started with Context.StartService(Intent) and Context.BindService(Intent,IServiceConnection,IServiceConnection).

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 Processes and Threads. The NoType:android/app/IntentService;Href=../../../reference/android/app/IntentService.html class is available as a standard implementation of Service that has its own thread where it schedules its work to be done.

Topics covered here:

Developer Guides

For a detailed discussion about how to create services, read the Services developer guide.

What is a Service?

Most confusion about the Service class actually revolves around what it is not:

  • A Service is not a separate process. The Service object itself does not imply it is running in its own process; unless otherwise specified, it runs in the same process as the application it is part of.
  • A Service is not a thread. It is not a means itself to do work off of the main thread (to avoid Application Not Responding errors).

Thus a Service itself is actually very simple, providing two main features:

  • A facility for the application to tell the system about something it wants to be doing in the background (even when the user is not directly interacting with the application). This corresponds to calls to Context.StartService(Intent), which ask the system to schedule work for the service, to be run until the service or someone else explicitly stop it.
  • A facility for an application to expose some of its functionality to other applications. This corresponds to calls to Context.BindService(Intent,IServiceConnection,IServiceConnection), which allows a long-standing connection to be made to the service in order to interact with it.

When a Service component is actually created, for either of these reasons, all that the system actually does is instantiate the component and call its Service.OnCreate and any other appropriate callbacks on the main thread. It is up to the Service to implement these with the appropriate behavior, such as creating a secondary thread in which it does its work.

Note that because Service itself is so simple, you can make your interaction with it as simple or complicated as you want: from treating it as a local Java object that you make direct method calls on (as illustrated by ), to providing a full remoteable interface using AIDL.

Service Lifecycle

There are two reasons that a service can be run by the system. If someone calls Context.StartService(Intent) then the system will retrieve the service (creating it and calling its Service.OnCreate method if needed) and then call its Service.OnStartCommand(Intent,StartCommandFlags,StartCommandFlags) method with the arguments supplied by the client. The service will at this point continue running until Context.StopService(Intent) or Service.StopSelf is called. Note that multiple calls to Context.startService() do not nest (though they do result in multiple corresponding calls to onStartCommand()), so no matter how many times it is started a service will be stopped once Context.stopService() or stopSelf() is called; however, services can use their Service.StopSelf(Int32) method to ensure the service is not stopped until started intents have been processed.

For started services, there are two additional major modes of operation they can decide to run in, depending on the value they return from onStartCommand(): Service.START_STICKY is used for services that are explicitly started and stopped as needed, while Service.START_NOT_STICKY or Service.START_REDELIVER_INTENT are used for services that should only remain running while processing any commands sent to them. See the linked documentation for more detail on the semantics.

Clients can also use Context.BindService(Intent,IServiceConnection,IServiceConnection) to obtain a persistent connection to a service. This likewise creates the service if it is not already running (calling Service.OnCreate while doing so), but does not call onStartCommand(). The client will receive the BinderConsts object that the service returns from its Service.OnBind(Intent) 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 Android.Content.Context.BIND_AUTO_CREATE flag. Once neither of these situations hold, the service's Service.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 NoType:android/R$styleable;Href=../../../reference/android/R.styleable.html#AndroidManifestService tag. By doing so, other applications will need to declare a corresponding NoType:android/R$styleable;Href=../../../reference/android/R.styleable.html#AndroidManifestUsesPermission element in their own manifest to be able to start, stop, or bind to the service.

As of NoType:android/os/Build$VERSION_CODES;Href=../../../reference/android/os/Build.VERSION_CODES.html#GINGERBREAD, when using Context.StartService(Intent), you can also set ActivityFlags.GrantReadUriPermission and/or ActivityFlags.GrantWriteUriPermission on the Intent. This will grant the Service temporary access to the specific URIs in the Intent. Access will remain until the Service has called Service.StopSelf(Int32) for that start command or a later one, or until the Service has been completely stopped. This works for granting access to the other apps that have not requested the permission protecting the Service, or even when the Service is not exported at all.

In addition, a service can protect individual IPC calls into it with permissions, by calling the ContextWrapper.CheckCallingPermission(String) 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 Service.OnCreate, Service.OnStartCommand(Intent,StartCommandFlags,StartCommandFlags), or Service.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 low memory conditions. However, since the user is not directly aware of a background service, in that state it is considered a valid candidate to kill, and you should be prepared for this to happen. In particular, long-running services will be increasingly likely to kill and are guaranteed to be killed (and restarted if appropriate) if they remain started long enough.
  • 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. The way a client's importance impacts the service's importance can be adjusted through Android.Content.Context.BIND_ABOVE_CLIENT, Android.Content.Context.BIND_ALLOW_OOM_MANAGEMENT, Android.Content.Context.BIND_WAIVE_PRIORITY, Android.Content.Context.BIND_IMPORTANT, and Android.Content.Context.BIND_ADJUST_WITH_ACTIVITY.
  • A started service can use the Service.StartForeground(Int32,Notification) API to put the service in a foreground state, where the system considers it to be something the user is actively aware of and thus not a candidate for killing when low on memory. (It is still theoretically possible for the service to be killed under extreme memory pressure from the current foreground application, but in practice this should not be a concern.)

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 Service.OnStartCommand(Intent,StartCommandFlags,StartCommandFlags) to schedule work to be done asynchronously or in another thread, then you may want to use Service.START_FLAG_REDELIVERY to have the system re-deliver an Intent for you so that it does not get lost if your service is killed while processing it.

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

Local Service Sample

One of the most common uses of a Service is as a secondary component running alongside other parts of an application, in the same process as the rest of the components. All components of an .apk run in the same process unless explicitly stated otherwise, so this is a typical situation.

When used in this way, by assuming the components are in the same process, you can greatly simplify the interaction between them: clients of the service can simply cast the IBinder they receive from it to a concrete class published by the service.

An example of this use of a Service is shown here. First is the Service itself, publishing a custom class when bound:

With that done, one can now write client code that directly accesses the running service, such as:

java Example

private LocalService mBoundService;

private ServiceConnection mConnection = new ServiceConnection() {
    public void onServiceConnected(ComponentName className, IBinder service) {
        // This is called when the connection with the service has been
        // established, giving us the service object we can use to
        // interact with the service.  Because we have bound to a explicit
        // service that we know is running in our own process, we can
        // cast its IBinder to a concrete class and directly access it.
        mBoundService = ((LocalService.LocalBinder)service).getService();

        // Tell the user about this for our demo.
        Toast.makeText(Binding.this, R.string.local_service_connected,
                Toast.LENGTH_SHORT).show();
    }

    public void onServiceDisconnected(ComponentName className) {
        // This is called when the connection with the service has been
        // unexpectedly disconnected -- that is, its process crashed.
        // Because it is running in our same process, we should never
        // see this happen.
        mBoundService = null;
        Toast.makeText(Binding.this, R.string.local_service_disconnected,
                Toast.LENGTH_SHORT).show();
    }
};

void doBindService() {
    // Establish a connection with the service.  We use an explicit
    // class name because we want a specific service implementation that
    // we know will be running in our own process (and thus won't be
    // supporting component replacement by other applications).
    bindService(new Intent(Binding.this, 
            LocalService.class), mConnection, Context.BIND_AUTO_CREATE);
    mIsBound = true;
}

void doUnbindService() {
    if (mIsBound) {
        // Detach our existing connection.
        unbindService(mConnection);
        mIsBound = false;
    }
}

@Override
protected void onDestroy() {
    super.onDestroy();
    doUnbindService();
}

Remote Messenger Service Sample

If you need to be able to write a Service that can perform complicated communication with clients in remote processes (beyond simply the use of Context.StartService(Intent) to send commands to it), then you can use the Messenger class instead of writing full AIDL files.

An example of a Service that uses Messenger as its client interface is shown here. First is the Service itself, publishing a Messenger to an internal Handler when bound:

If we want to make this service run in a remote process (instead of the standard one for its .apk), we can use android:process in its manifest tag to specify one:

xml Example

<service android:name=".app.MessengerService"
        android:process=":remote" />

Note that the name "remote" chosen here is arbitrary, and you can use other names if you want additional processes. The ':' prefix appends the name to your package's standard process name.

With that done, clients can now bind to the service and send messages to it. Note that this allows clients to register with it to receive messages back as well:

java Example

/** Messenger for communicating with service. */
Messenger mService = null;
/** Flag indicating whether we have called bind on the service. */
boolean mIsBound;
/** Some text view we are using to show state information. */
TextView mCallbackText;

/**
 * Handler of incoming messages from service.
 */
class IncomingHandler extends Handler {
    @Override
    public void handleMessage(Message msg) {
        switch (msg.what) {
            case MessengerService.MSG_SET_VALUE:
                mCallbackText.setText("Received from service: " + msg.arg1);
                break;
            default:
                super.handleMessage(msg);
        }
    }
}

/**
 * Target we publish for clients to send messages to IncomingHandler.
 */
final Messenger mMessenger = new Messenger(new IncomingHandler());

/**
 * Class for interacting with the main interface of the service.
 */
private ServiceConnection mConnection = new ServiceConnection() {
    public void onServiceConnected(ComponentName className,
            IBinder service) {
        // This is called when the connection with the service has been
        // established, giving us the service object we can use to
        // interact with the service.  We are communicating with our
        // service through an IDL interface, so get a client-side
        // representation of that from the raw service object.
        mService = new Messenger(service);
        mCallbackText.setText("Attached.");

        // We want to monitor the service for as long as we are
        // connected to it.
        try {
            Message msg = Message.obtain(null,
                    MessengerService.MSG_REGISTER_CLIENT);
            msg.replyTo = mMessenger;
            mService.send(msg);

            // Give it some value as an example.
            msg = Message.obtain(null,
                    MessengerService.MSG_SET_VALUE, this.hashCode(), 0);
            mService.send(msg);
        } catch (RemoteException e) {
            // In this case the service has crashed before we could even
            // do anything with it; we can count on soon being
            // disconnected (and then reconnected if it can be restarted)
            // so there is no need to do anything here.
        }

        // As part of the sample, tell the user what happened.
        Toast.makeText(Binding.this, R.string.remote_service_connected,
                Toast.LENGTH_SHORT).show();
    }

    public void onServiceDisconnected(ComponentName className) {
        // This is called when the connection with the service has been
        // unexpectedly disconnected -- that is, its process crashed.
        mService = null;
        mCallbackText.setText("Disconnected.");

        // As part of the sample, tell the user what happened.
        Toast.makeText(Binding.this, R.string.remote_service_disconnected,
                Toast.LENGTH_SHORT).show();
    }
};

void doBindService() {
    // Establish a connection with the service.  We use an explicit
    // class name because there is no reason to be able to let other
    // applications replace our component.
    bindService(new Intent(Binding.this, 
            MessengerService.class), mConnection, Context.BIND_AUTO_CREATE);
    mIsBound = true;
    mCallbackText.setText("Binding.");
}

void doUnbindService() {
    if (mIsBound) {
        // If we have received the service, and hence registered with
        // it, then now is the time to unregister.
        if (mService != null) {
            try {
                Message msg = Message.obtain(null,
                        MessengerService.MSG_UNREGISTER_CLIENT);
                msg.replyTo = mMessenger;
                mService.send(msg);
            } catch (RemoteException e) {
                // There is nothing special we need to do if the service
                // has crashed.
            }
        }

        // Detach our existing connection.
        unbindService(mConnection);
        mIsBound = false;
        mCallbackText.setText("Unbinding.");
    }
}

[Android Documentation]

Requirements

Namespace: Android.App
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0
Since: Added in API level 1

The members of Android.App.Service are listed below.

See Also: ContextWrapper

Public Constructors

Protected Constructors

A constructor used when creating managed representations of JNI objects; called by the runtime.

Public Properties

[read-only]
ApplicationApplication. Return the application that owns this service.

Protected Properties

[read-only]
override
ThresholdClassIntPtr. This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
[read-only]
override
ThresholdTypeType. This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Public Methods

abstract
OnBind(Intent) : IBinder
Return the communication channel to the service.
OnConfigurationChanged(Configuration)
Called by the system when the device configuration changes while your component is running.
OnCreate()
Called by the system when the service is first created.
OnDestroy()
Called by the system to notify a Service that it is no longer used and is being removed.
OnLowMemory()
This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
OnRebind(Intent)
Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its Service.OnUnbind(Intent).
OnStart(Intent, Int32)
OnStartCommand(Intent, StartCommandFlags, Int32) : StartCommandResult
Called by the system every time a client explicitly starts the service by calling Context.StartService(Intent), providing the arguments it supplied and a unique integer token representing the start request.
OnTaskRemoved(Intent)
This is called if the service is currently running and the user has removed a task that comes from the service's application.
OnTrimMemory(TrimMemory)
Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
OnUnbind(Intent) : Boolean
Called when all clients have disconnected from a particular interface published by the service.
SetForeground(Boolean)
StartForeground(Int32, Notification)
Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.
StopForeground(Boolean)
Remove this service from foreground state, allowing it to be killed if more memory is needed.
StopSelf()
Stop the service, if it was previously started.
StopSelf(Int32)
Old version of Service.StopSelfResult(Int32) that doesn't return a result.
StopSelfResult(Int32) : Boolean
Stop the service if the most recent time it was started was startId.

Protected Methods

Dump(FileDescriptor, PrintWriter, String[])
Print the Service's state into the given stream.