diff --git a/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java b/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java index 66f7c4b44..0ebf256a2 100644 --- a/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java +++ b/bramble-android/src/main/java/org/briarproject/bramble/api/system/AndroidWakeLockManager.java @@ -7,9 +7,21 @@ import java.util.concurrent.Executor; @NotNullByDefault public interface AndroidWakeLockManager { + /** + * Creates a wake lock with the given tag. The tag is only used for + * logging; the underlying OS wake lock will use its own tag. + */ AndroidWakeLock createWakeLock(String tag); + /** + * Runs the given task while holding a wake lock. + */ void runWakefully(Runnable r, String tag); + /** + * Submits the given task to the given executor while holding a wake lock. + * The lock is released when the task completes, or if an exception is + * thrown while submitting or running the task. + */ void executeWakefully(Runnable r, Executor executor, String tag); } diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/system/TaskScheduler.java b/bramble-api/src/main/java/org/briarproject/bramble/api/system/TaskScheduler.java index 96c977dd4..9d72c4cfb 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/system/TaskScheduler.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/system/TaskScheduler.java @@ -8,9 +8,6 @@ import java.util.concurrent.TimeUnit; /** * A service that can be used to schedule the execution of tasks. - *

- * The service should only be used for running tasks on other executors - * at scheduled times. No significant work should be run by the service itself. */ @NotNullByDefault public interface TaskScheduler {