Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!
added in API level 1

ServiceConnection

public interface ServiceConnection

android.content.ServiceConnection


Interface for monitoring the state of an application service. See Service and Context.bindService() for more information.

Like many callbacks from the system, the methods on this class are called from the main thread of your process.

Summary

Public methods

default void onBindingDied(ComponentName name)

Called when the binding to this connection is dead.

default void onNullBinding(ComponentName name)

Called when the service being bound has returned null from its onBind() method.

abstract void onServiceConnected(ComponentName name, IBinder service)

Called when a connection to the Service has been established, with the IBinder of the communication channel to the Service.

abstract void onServiceDisconnected(ComponentName name)

Called when a connection to the Service has been lost.

Public methods

onBindingDied

added in API level 26
public void onBindingDied (ComponentName name)

Called when the binding to this connection is dead. This means the interface will never receive another connection. The application will need to unbind and rebind the connection to activate it again. This may happen, for example, if the application hosting the service it is bound to has been updated.

Parameters
name ComponentName: The concrete component name of the service whose connection is dead.

onNullBinding

added in API level 28
public void onNullBinding (ComponentName name)

Called when the service being bound has returned null from its onBind() method. This indicates that the attempting service binding represented by this ServiceConnection will never become usable.

The app which requested the binding must still call Context.unbindService(ServiceConnection) to release the tracking resources associated with this ServiceConnection even if this callback was invoked following Context.bindService() bindService().

Parameters
name ComponentName: The concrete component name of the service whose binding has been rejected by the Service implementation.

onServiceConnected

added in API level 1
public abstract void onServiceConnected (ComponentName name, 
                IBinder service)

Called when a connection to the Service has been established, with the IBinder of the communication channel to the Service.

Note: If the system has started to bind your client app to a service, it's possible that your app will never receive this callback. Your app won't receive a callback if there's an issue with the service, such as the service crashing while being created.

Parameters
name ComponentName: The concrete component name of the service that has been connected.

service IBinder: The IBinder of the Service's communication channel, which you can now make calls on.

onServiceDisconnected

added in API level 1
public abstract void onServiceDisconnected (ComponentName name)

Called when a connection to the Service has been lost. This typically happens when the process hosting the service has crashed or been killed. This does not remove the ServiceConnection itself -- this binding to the service will remain active, and you will receive a call to onServiceConnected(ComponentName, IBinder) when the Service is next running.

Parameters
name ComponentName: The concrete component name of the service whose connection has been lost.