Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c97ad599 authored by sandeepbandaru's avatar sandeepbandaru
Browse files

Improving documentation in ProcessingSignal and updateProcessingState 

Test: n/a
Bug: 328516280
Change-Id: I4f83fdebda6445ee0aad765436da7e897a870ff5
parent 263ea3bc

core/java/android/app/ondeviceintelligence/ProcessingSignal.java

+7 −3
Original line number Diff line number Diff line
@@ -75,7 +75,11 @@ public final class ProcessingSignal { 




    /**

     * Sends a custom signal with the provided parameters. It also signals the remote callback

     * Sends a custom signal with the provided parameters. If there are multiple concurrent

     * requests to this method, the actionParams are queued in a blocking fashion, in the order they

     * are received.

     *

     * It also signals the remote callback

     * with the same params if already configured, if not the action is queued to be sent when a

     * remote is configured. Similarly, on the receiver side, the callback will be invoked if

     * already set, if not all actions are queued to be sent to callback when it is set.
@@ -159,9 +163,9 @@ public final class ProcessingSignal { 
     * Sets the remote transport.

     *

     * If there are actions queued from {@link ProcessingSignal#sendSignal}, they are also

     * sequentially sent to the remote.

     * sequentially sent to the configured remote.

     *

     * This method is guaranteed that the remote transport will not be called after it

     * This method guarantees that the remote transport will not be called after it

     * has been removed.

     *

     * @param remote The remote transport, or null to remove.

core/java/android/service/ondeviceintelligence/OnDeviceIntelligenceService.java

+4 −1
Original line number Diff line number Diff line
@@ -222,7 +222,10 @@ public abstract class OnDeviceIntelligenceService extends Service { 


    /**

     * Invoked by the {@link OnDeviceIntelligenceService} inorder to send updates to the inference

     * service if there is a state change to be performed.

     * service if there is a state change to be performed. State change could be config updates,

     * performing initialization or cleanup tasks in the remote inference service.

     * The Bundle passed in here is expected to be read-only and will be rejected if it has any

     * writable fields as detailed under {@link InferenceParams}.

     *

     * @param processingState  the updated state to be applied.

     * @param callbackExecutor executor to the run status callback on.