Merge pull request kivy#1374 from AndreMiras/feature/service_auto_restart_fix_and_doc

inclement · web-flow · commit 098b55e3ebb5 · 2018-09-15T19:49:17.000+01:00
Fixes and clarifies services auto-restart
diff --git a/doc/source/services.rst b/doc/source/services.rst
@@ -8,9 +8,14 @@ possible to use normal multiprocessing on Android. Services are also
 the only way to run code when your app is not currently opened by the user.
 
 Services must be declared when building your APK. Each one
-will have its own main.py file with the Python script to be run. You
-can communicate with the service process from your app using e.g. `osc
-<https://pypi.python.org/pypi/python-osc>`__ or (a heavier option)
+will have its own main.py file with the Python script to be run.
+Please note that python-for-android explicitly runs services as separated
+processes by having a colon ":" in the beginning of the name assigned to
+the ``android:process`` attribute of the ``AndroidManifest.xml`` file.
+This is not the default behavior, see `Android service documentation
+<https://developer.android.com/guide/topics/manifest/service-element>`__.
+You can communicate with the service process from your app using e.g.
+`osc <https://pypi.python.org/pypi/python-osc>`__ or (a heavier option)
 `twisted <https://twistedmatrix.com/trac/>`__.
 
 Service creation
@@ -87,3 +92,14 @@ documented here but all accessible via calling other methods of the
     your service folder you must use e.g.  ``import service.module``
     instead of ``import module``, if the service file is in the
     ``service/`` folder.
+
+Service auto-restart
+~~~~~~~~~~~~~~~~~~~~
+
+It is possible to make services restart automatically when they exit by
+calling ``setAutoRestartService(True)`` on the service object.
+The call to this method should be done within the service code::
+
+    from jnius import autoclass
+    PythonService = autoclass('org.kivy.android.PythonService')
+    PythonService.mService.setAutoRestartService(True)
diff --git a/pythonforandroid/bootstraps/sdl2/build/src/main/java/org/kivy/android/PythonService.java b/pythonforandroid/bootstraps/sdl2/build/src/main/java/org/kivy/android/PythonService.java
@@ -130,6 +130,16 @@ public void onDestroy() {
         Process.killProcess(Process.myPid());
     }
 
+    /**
+     * Stops the task gracefully when killed.
+     * Calling stopSelf() will trigger a onDestroy() call from the system.
+     */
+    @Override
+    public void onTaskRemoved(Intent rootIntent) {
+        super.onTaskRemoved(rootIntent);
+        stopSelf();
+    }
+
     @Override
     public void run(){
         String app_root =  getFilesDir().getAbsolutePath() + "/app";
