FinalLody/EasyIPC

Custom Implementation of android IPC.

EasyIPC

Custom Implementation of Android IPC.

• forget aidl
• forget parcelable
• forget 10MB limit
• just add @EasyIPCMethod annotation and you are done

//This is your service
public class TestService extends EasyIPCService {

    @EasyIPCMethod
    public String test(String s, int a, MySerialisableObject myObj) {
        return s + a + myObj.toString();
    }
}

//this is your activity
public class ActivityTest extends Activity {
    private TestServiceClient serviceClient; //the TestServiceClient.java is generated for you
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        
        bindService(new Intent(this, TestService.class), new TestServiceClient.Connection() {
            @Override
            public void onServiceConnected(TestServiceClient client) {
                serviceClient = client;
                System.out.println(client.test("", 1, new MySerialisableObject());
            }

            @Override
            public void onServiceDisconnected() {
                serviceClient = null;
            }
        }, Context.BIND_AUTO_CREATE);
    }
    
    @Override
    protected void onDestroy() {
        if (serviceClient != null) {
            unbindService(serviceClient.getConnection());
        }
    }

Integration Guide

• Gradle

dependencies {
    compile "com.ym.easyipc:easyipc-api:1.+"
    provided "com.ym.easyipc:easyipc-api:1.+"
...

• Extend your service from EasyIPCService
• Mark the method in your service with @EasyIPCMethod
• In case you use any object as method args or retun param than make sure to mark it as Serializable
• build your project
• Use auto-generated (service_name + Client).java to access your service
• Enjoy xD

Listeners

//This is your listener interface
@EasyIPCListener
public interface IListener {

    @EasyIPCMethod
    void onResult(int result);
}

//This is your service, simply add methods to manage the listener and call an interface method on it whenever you need.
public class TestService extends EasyIPCService {
    private List<IListener> listeners = new ArrayList<IListener>();
    
    @EasyIPCMethod
    public void addListener(final IListener listener) {
        listeners.add(listener);
    }
    
    @EasyIPCMethod
    public void removeListener(IListener listener) {
        listeners.remove(listener);
    }
}

//client code, adding listener, you have to use the *listener_name* + Impl.java generated class
final IListenerImpl listener = new IListenerImpl() {
            @Override
            public void onResult(int result) {
                System.out.println("listener received: " + result);
            }
        };
        serviceClient.addListener(listener);
        
        ...
        serviceClient.removeListener(listener);
        listener.release(); //dont forget to release the listener!

Q&A

1. How can a remote app access my service?
   Just copy (service_name + Client).java to the client app and use it.
2. My IDE show a compilation error and can't find a (service_name + Client).java!
   The Client class is generated during compilation at the path build/intermediates/classes/release/. You can add that folder as a source to your project or just ignore the compilation error from IDE. Gradle should build it fine.