java.lang.Object | |||
↳ | android.content.Context | ||
↳ | android.content.ContextWrapper | ||
↳ | android.app.Service |
Known Direct Subclasses |
Known Indirect Subclasses |
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
<service>
declaration in its package's AndroidManifest.xml
. Services
can be started with
Context.startService()
and
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:
There are two reasons that a service can be run by the system. If someone
calls Context.startService()
then the system will
retrieve the service (creating it and calling its onCreate()
method
if needed) and then call its onStartCommand(Intent, int, int)
method with the
arguments supplied by the client. The service will at this point continue
running until Context.stopService()
or
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 stopSelf(int)
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(): START_STICKY
is used for services that are
explicitly started and stopped as needed, while START_NOT_STICKY
or 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()
to
obtain a persistent connection to a service. This likewise creates the
service if it is not already running (calling onCreate()
while
doing so), but does not call onStartCommand(). The client will receive the
IBinder
object that the service returns from its
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
Context.BIND_AUTO_CREATE
flag. Once neither
of these situations hold, the service's onDestroy()
method is called
and the service is effectively terminated. All cleanup (stopping threads,
unregistering receivers) should be complete upon returning from onDestroy().
Global access to a service can be enforced when it is declared in its
manifest's <service>
tag. By doing so, other applications will need to declare a corresponding
<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
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.
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
onCreate()
, onStartCommand()
,
or 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.
A started service can use the startForeground(int, 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 onStartCommand()
to schedule work to be done asynchronously or in another thread, then you
may want to use 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.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | START_CONTINUATION_MASK | Bits returned by onStartCommand(Intent, int, int) describing how to continue
the service if it is killed. |
|||||||||
int | START_FLAG_REDELIVERY | This flag is set in onStartCommand(Intent, int, int) if the Intent is a
re-delivery of a previously delivered intent, because the service
had previously returned START_REDELIVER_INTENT but had been
killed before calling stopSelf(int) for that Intent. |
|||||||||
int | START_FLAG_RETRY | This flag is set in onStartCommand(Intent, int, int) if the Intent is a
a retry because the original attempt never got to or returned from
onStartCommand(Intent, int, int) . |
|||||||||
int | START_NOT_STICKY | Constant to return from onStartCommand(Intent, int, int) : if this service's
process is killed while it is started (after returning from
onStartCommand(Intent, int, int) ), and there are no new start intents to
deliver to it, then take the service out of the started state and
don't recreate until a future explicit call to
Context.startService(Intent) . |
|||||||||
int | START_REDELIVER_INTENT | Constant to return from onStartCommand(Intent, int, int) : if this service's
process is killed while it is started (after returning from
onStartCommand(Intent, int, int) ), then it will be scheduled for a restart
and the last delivered Intent re-delivered to it again via
onStartCommand(Intent, int, int) . |
|||||||||
int | START_STICKY | Constant to return from onStartCommand(Intent, int, int) : if this service's
process is killed while it is started (after returning from
onStartCommand(Intent, int, int) ), then leave it in the started state but
don't retain this delivered intent. |
|||||||||
int | START_STICKY_COMPATIBILITY | Constant to return from onStartCommand(Intent, int, int) : compatibility
version of START_STICKY that does not guarantee that
onStartCommand(Intent, int, int) will be called again after being killed. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.content.Context
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return the application that owns this service.
| |||||||||||
Return the communication channel to the service.
| |||||||||||
Called by the system when the device configuration changes while your
component is running.
| |||||||||||
Called by the system when the service is first created.
| |||||||||||
Called by the system to notify a Service that it is no longer used and is being removed.
| |||||||||||
This is called when the overall system is running low on memory, and
would like actively running process to try to tighten their belt.
| |||||||||||
Called when new clients have connected to the service, after it had
previously been notified that all had disconnected in its
onUnbind(Intent) . | |||||||||||
This method is deprecated.
Implement
onStartCommand(Intent, int, int) instead.
| |||||||||||
Called by the system every time a client explicitly starts the service by calling
startService(Intent) , providing the arguments it supplied and a
unique integer token representing the start request. | |||||||||||
Called when all clients have disconnected from a particular interface
published by the service.
| |||||||||||
This method is deprecated.
This is a now a no-op, use
startForeground(int, Notification) instead. This method
has been turned into a no-op rather than simply being deprecated
because analysis of numerous poorly behaving devices has shown that
increasingly often the trouble is being caused in part by applications
that are abusing it. Thus, given a choice between introducing
problems in existing applications using this API (by allowing them to
be killed when they would like to avoid it), vs allowing the performance
of the entire system to be decreased, this method was deemed less
important.
| |||||||||||
Make this service run in the foreground, supplying the ongoing
notification to be shown to the user while in this state.
| |||||||||||
Remove this service from foreground state, allowing it to be killed if
more memory is needed.
| |||||||||||
Stop the service, if it was previously started.
| |||||||||||
Old version of
stopSelfResult(int) that doesn't return a result. | |||||||||||
Stop the service if the most recent time it was started was
startId.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Print the Service's state into the given stream.
| |||||||||||
Is called before the object's memory is being reclaimed by the VM.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class android.content.ContextWrapper
| |||||||||||
From class android.content.Context
| |||||||||||
From class java.lang.Object
| |||||||||||
From interface android.content.ComponentCallbacks
|
Bits returned by onStartCommand(Intent, int, int)
describing how to continue
the service if it is killed. May be START_STICKY
,
START_NOT_STICKY
, START_REDELIVER_INTENT
,
or START_STICKY_COMPATIBILITY
.
This flag is set in onStartCommand(Intent, int, int)
if the Intent is a
re-delivery of a previously delivered intent, because the service
had previously returned START_REDELIVER_INTENT
but had been
killed before calling stopSelf(int)
for that Intent.
This flag is set in onStartCommand(Intent, int, int)
if the Intent is a
a retry because the original attempt never got to or returned from
onStartCommand(Intent, int, int)
.
Constant to return from onStartCommand(Intent, int, int)
: if this service's
process is killed while it is started (after returning from
onStartCommand(Intent, int, int)
), and there are no new start intents to
deliver to it, then take the service out of the started state and
don't recreate until a future explicit call to
Context.startService(Intent)
. The
service will not receive a onStartCommand(Intent, int, int)
call with a null Intent because it will not be re-started if there
are no pending Intents to deliver.
This mode makes sense for things that want to do some work as a
result of being started, but can be stopped when under memory pressure
and will explicit start themselves again later to do more work. An
example of such a service would be one that polls for data from
a server: it could schedule an alarm to poll every N minutes by having
the alarm start its service. When its onStartCommand(Intent, int, int)
is
called from the alarm, it schedules a new alarm for N minutes later,
and spawns a thread to do its networking. If its process is killed
while doing that check, the service will not be restarted until the
alarm goes off.
Constant to return from onStartCommand(Intent, int, int)
: if this service's
process is killed while it is started (after returning from
onStartCommand(Intent, int, int)
), then it will be scheduled for a restart
and the last delivered Intent re-delivered to it again via
onStartCommand(Intent, int, int)
. This Intent will remain scheduled for
redelivery until the service calls stopSelf(int)
with the
start ID provided to onStartCommand(Intent, int, int)
. The
service will not receive a onStartCommand(Intent, int, int)
call with a null Intent because it will will only be re-started if
it is not finished processing all Intents sent to it (and any such
pending events will be delivered at the point of restart).
Constant to return from onStartCommand(Intent, int, int)
: if this service's
process is killed while it is started (after returning from
onStartCommand(Intent, int, int)
), then leave it in the started state but
don't retain this delivered intent. Later the system will try to
re-create the service. Because it is in the started state, it will
guarantee to call onStartCommand(Intent, int, int)
after creating the new
service instance; if there are not any pending start commands to be
delivered to the service, it will be called with a null intent
object, so you must take care to check for this.
This mode makes sense for things that will be explicitly started and stopped to run for arbitrary periods of time, such as a service performing background music playback.
Constant to return from onStartCommand(Intent, int, int)
: compatibility
version of START_STICKY
that does not guarantee that
onStartCommand(Intent, int, int)
will be called again after being killed.
Return the application that owns this service.
Return the communication channel to the service. May return null if
clients can not bind to the service. The returned
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.
intent | The Intent that was used to bind to this service,
as given to Context.bindService . Note that any extras that were included with
the Intent at that point will not be seen here. |
---|
Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources.
At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.
newConfig | The new device configuration. |
---|
Called by the system when the service is first created. Do not call this method directly.
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.
This is called when the overall system is running low on memory, and would like actively running process to try to tighten their belt. While the exact point at which this will be called is not defined, generally it will happen around the time all background process have been killed, that is before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.
Applications that want to be nice can implement this method to release any caches or other unnecessary resources they may be holding on to. The system will perform a gc for you after returning from this method.
Called when new clients have connected to the service, after it had
previously been notified that all had disconnected in its
onUnbind(Intent)
. This will only be called if the implementation
of onUnbind(Intent)
was overridden to return true.
intent | The Intent that was used to bind to this service,
as given to Context.bindService . Note that any extras that were included with
the Intent at that point will not be seen here.
|
---|
Called by the system every time a client explicitly starts the service by calling
startService(Intent)
, providing the arguments it supplied and a
unique integer token representing the start request. Do not call this method directly.
For backwards compatibility, the default implementation calls
onStart(Intent, int)
and returns either START_STICKY
or START_STICKY_COMPATIBILITY
.
intent | The Intent supplied to startService(Intent) ,
as given. This may be null if the service is being restarted after
its process has gone away, and it had previously returned anything
except START_STICKY_COMPATIBILITY . |
---|---|
flags | Additional data about this start request. Currently either
0, START_FLAG_REDELIVERY , or START_FLAG_RETRY . |
startId | A unique integer representing this specific request to
start. Use with stopSelfResult(int) . |
START_CONTINUATION_MASK
bits.Called when all clients have disconnected from a particular interface published by the service. The default implementation does nothing and returns false.
intent | The Intent that was used to bind to this service,
as given to Context.bindService . Note that any extras that were included with
the Intent at that point will not be seen here. |
---|
onRebind(Intent)
method later called when new clients bind to it.
This method is deprecated.
This is a now a no-op, use
startForeground(int, Notification)
instead. This method
has been turned into a no-op rather than simply being deprecated
because analysis of numerous poorly behaving devices has shown that
increasingly often the trouble is being caused in part by applications
that are abusing it. Thus, given a choice between introducing
problems in existing applications using this API (by allowing them to
be killed when they would like to avoid it), vs allowing the performance
of the entire system to be decreased, this method was deemed less
important.
Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state. 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.
id | The identifier for this notification as per
NotificationManager.notify(int, Notification) . |
---|---|
notification | The Notification to be displayed. |
Remove this service from foreground state, allowing it to be killed if more memory is needed.
removeNotification | If true, the notification previously provided
to startForeground(int, Notification) will be removed. Otherwise it will remain
until a later call removes it (or the service is destroyed). |
---|
Stop the service, if it was previously started. This is the same as
calling stopService(Intent)
for this particular service.
Old version of stopSelfResult(int)
that doesn't return a result.
Stop the service if the most recent time it was started was
startId. This is the same as calling stopService(Intent)
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 onStart(Intent, int)
.
Be careful about ordering of your calls to this function.. If you call this function with the most-recently received ID before you have called it for previously received IDs, the service will be immediately stopped anyway. If you may end up processing IDs out of order (such as by dispatching them on separate threads), then you are responsible for stopping them in the same order you received them.
startId | The most recent start identifier received in onStart(Intent, int) . |
---|
Print the Service's state into the given stream. This gets invoked if
you run "adb shell dumpsys activity service dump(FileDescriptor, String[])
method
on the IBinder
interface registered with ServiceManager.
fd | The raw file descriptor that the dump is being sent to. |
---|---|
writer | The PrintWriter to which you should dump your state. This will be closed for you after you return. |
args | additional arguments to the dump request. |
Is called before the object's memory is being reclaimed by the VM. This can only happen once the VM has detected, during a run of the garbage collector, that the object is no longer reachable by any thread of the running application.
The method can be used to free system resources or perform other cleanup
before the object is garbage collected. The default implementation of the
method is empty, which is also expected by the VM, but subclasses can
override finalize()
as required. Uncaught exceptions which are
thrown during the execution of this method cause it to terminate
immediately but are otherwise ignored.
Note that the VM does guarantee that finalize()
is called at most
once for any object, but it doesn't guarantee when (if at all) finalize()
will be called. For example, object B's finalize()
can delay the execution of object A's finalize()
method and
therefore it can delay the reclamation of A's memory. To be safe, use a
ReferenceQueue
, because it provides more control
over the way the VM deals with references during garbage collection.
Throwable |
---|