util.service

Class ServiceConnector

java.lang.Object

util.service.ServiceConnector

public final class ServiceConnector
extends java.lang.Object

ServiceConnector makes it easy to connect to remote android aidl services. It manages the process of dealing with ServiceConnection leaving you to simply focus on what to do with the service objects

To use a ServiceConnector,

1. Declare the remote IInterface as instance fields, and annotate it with @ServiceInfo ex:

   
      @ServiceInfo(serviceIntent="com.myintent.MY_SERVICE")
      private IMYService myService;
    

2. (Optional) If you want to know when the service is connected/disconnected, add callback methods and annotate them with @ServiceConnectionCallback

   
      @ServiceConnectionCallback
     public void onServiceConnectionChanged(String serviceIntent, boolean connected) {
     }
    

3. 
    Call bind(Object, Context)
    

See Also:

ServiceConnector

Method Summary

Modifier and Type	Method and Description
static void	bind(java.lang.Object target, Context context) Call this to process the given target object to look for any IInterface fields annotated with ServiceInfo, and if so connects to those services.
static boolean	isAllConnected() Returns true if all the annotated services are connected.
static boolean	isConnected(java.lang.String serviceIntent) Returns true if connected with a service of the given intent.
static void	setEnableDebug(boolean enableDebug) Call to enable or disable debug logs
static void	unbind(java.lang.Object target) Disconnects from all the services bounded to this target.
static void	waitForAllConnected(long timeout) Blocks for up to the given timeout for the connection with all the services
static void	waitForConnected(long timeout, java.lang.String serviceIntent) Blocks for up to the given timeout for the connection to the given service.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

bind

public static void bind(java.lang.Object target,
                        Context context)

Call this to process the given target object to look for any IInterface fields annotated with ServiceInfo, and if so connects to those services. Those fields will get initialized with the remote IInterface service objects when the service is successfully connected.

Parameters:

target - The object to analyze

context - Context used to connect to service

unbind

public static void unbind(java.lang.Object target)

Disconnects from all the services bounded to this target. Any services that are no more bounded to any other targets will be disconnected.

Parameters:

target - The target used to bind.

isAllConnected

public static boolean isAllConnected()

Returns true if all the annotated services are connected.

Returns:

if all services are connected

isConnected

public static boolean isConnected(java.lang.String serviceIntent)

Returns true if connected with a service of the given intent.

Parameters:

serviceIntent - The intent of service to check for

waitForConnected

public static void waitForConnected(long timeout,
                                    java.lang.String serviceIntent)
                             throws java.lang.InterruptedException

Blocks for up to the given timeout for the connection to the given service.

Parameters:

timeout - Maximum timeout in ms to wait for. 0 Waits until service is connected

serviceIntent - The service intent

Throws:

java.lang.InterruptedException

waitForAllConnected

public static void waitForAllConnected(long timeout)
                                throws java.lang.InterruptedException

Blocks for up to the given timeout for the connection with all the services

Parameters:

timeout - Maximum timeout in ms to wait for. 0 Waits until service is connected

Throws:

java.lang.InterruptedException

setEnableDebug

public static void setEnableDebug(boolean enableDebug)

Call to enable or disable debug logs

Parameters:

enableDebug - Enable or disable