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

Commit ba2fe6fb authored by Remi NGUYEN VAN's avatar Remi NGUYEN VAN
Browse files

Improve documentation on simulateDataStall 

Explain that:
 - The method does not cause an actual data stall.
 - The detectionMethod parameter refers to
   ConnectivityDiagnosticsManager.DataStallReport constants (which
   already use an IntDef).
 - timestampMillis is relative to SystemClock.elapsedRealtime.

Fixes: 183972768
Test: m
Change-Id: I2eeb79e0e8ec6e8fd3b8fe1dcb1abbf2e6338983
parent 5d7d6554

packages/Connectivity/framework/src/android/net/ConnectivityManager.java

+7 −3
Original line number Diff line number Diff line
@@ -44,6 +44,7 @@ import android.content.ComponentName; 
import android.content.ContentResolver;

import android.content.Context;

import android.content.Intent;

import android.net.ConnectivityDiagnosticsManager.DataStallReport.DetectionMethod;

import android.net.IpSecManager.UdpEncapsulationSocket;

import android.net.SocketKeepalive.Callback;

import android.net.TetheringManager.StartTetheringCallback;
@@ -5095,10 +5096,13 @@ public class ConnectivityManager { 
     *

     * <p>This method should only be used for tests.

     *

     * <p>The caller must be the owner of the specified Network.

     * <p>The caller must be the owner of the specified Network. This simulates a data stall to

     * have the system behave as if it had happened, but does not actually stall connectivity.

     *

     * @param detectionMethod The detection method used to identify the Data Stall.

     * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds.

     *                        See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*.

     * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per

     *                        SystemClock.elapsedRealtime.

     * @param network The Network for which a Data Stall is being simluated.

     * @param extras The PersistableBundle of extras included in the Data Stall notification.

     * @throws SecurityException if the caller is not the owner of the given network.
@@ -5107,7 +5111,7 @@ public class ConnectivityManager { 
    @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)

    @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,

            android.Manifest.permission.NETWORK_STACK})

    public void simulateDataStall(int detectionMethod, long timestampMillis,

    public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis,

            @NonNull Network network, @NonNull PersistableBundle extras) {

        try {

            mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);