API de diagnóstico de conectividad

La API de Connectivity Diagnostics permite que las apps que tienen o administran redes, como las de proveedores, de VPN y de sugerencias de Wi-Fi, reciban información de diagnóstico de conectividad de red del framework. Estas apps pueden registrar devoluciones de llamada y recibir notificaciones con información de conectividad para las redes que poseen o administran. Las apps no recibirán notificaciones de redes que no sean de su propiedad ni estén administradas por ellas.

Los siguientes son ejemplos de apps que administran o son propietarias de redes:

  • Apps del operador: Administra las redes móviles para las que su subId tiene privilegios del operador.
  • Apps de sugerencias de Wi-Fi: Son redes Wi-Fi propias que sugieren al sistema.
  • Apps de VPN: Administra todas las redes que usa su VPN, pero solo cuando son la VPN activa.

Las devoluciones de llamada se invocan en los siguientes casos:

  • Validación de red: El sistema terminó de evaluar una red específica. La clase ConnectivityReport proporciona información sobre el estado actual de la red y los resultados de las pruebas o los procedimientos que se realizaron como parte de la validación.

    public class ConnectivityReport {
    Network network;
    long reportTimestamp;
    LinkProperties linkProperties;
    NetworkCapabilities networkCapabilities;
    PersistableBundle additionalInfo;
}

  • Se sospecha que se produjo una detención de datos: Se sospecha que se produjo una detención de datos, una condición en la que los paquetes de IP no fluyen correctamente a través de la red. La clase DataStallReport proporciona información sobre posibles bloqueos de datos.

    public class DataStallReport {
    Network network;
    long reportTimestamp;
    int detectionMethod;
    LinkProperties linkProperties;
    NetworkCapabilities networkCapabilities;
    PersistableBundle stallDetails;
}

  • Conectividad informada: Una app informó la conectividad al sistema a través de ConnectivityManager#reportNetworkConnectivity. La red y la conectividad informada (si la app considera que la red proporciona conectividad o no) se comparten.

Implementación

Para usar la API de Connectivity Diagnostics, una app debe obtener una instancia de ConnectivityDiagnosticsManager de la plataforma. Esta instancia se debe usar para registrar y cancelar el registro de implementaciones de ConnectivityDiagnosticsCallback. Los métodos de devolución de llamada que no se anulan no realizan ninguna acción.

A continuación, se muestra un ejemplo de una implementación de ConnectivityDiagnosticsCallback:

public class ExampleCallback extends ConnectivityDiagnosticsCallback {
    @Override
    public void onConnectivityReportAvailable(@NonNull ConnectivityReport report) {
        ... 
        // Log data, take action based on report result, etc
        ... 
    }

    @Override
    public void onDataStallSuspected(@NonNull DataStallReport report) {
        ... 
        // Log data, take action based on report result, etc
        ... 
    }

    @Override
    public void onNetworkConnectivityReported(
               @NonNull Network network, boolean hasConnectivity) {
        ... 
        // Log data, take action based on report result, etc
        ... 
    }
}

Para registrar devoluciones de llamada y recibir notificaciones, llama a registerConnectivityDiagnosticsCallback. Para cancelar el registro de las devoluciones de llamada y dejar de recibir notificaciones, llama a unregisterConnectivityDiagnosticsCallback.

A continuación, se muestra un ejemplo para registrar y cancelar el registro de ConnectivityDiagnosticsCallback:

NetworkRequest request =
        new NetworkRequest.Builder()
                .addTransportType(TRANSPORT_CELLULAR)
                .build();
// Use an Executor that is appropriate for your use case
Executor executor = Executors.newSingleThreadExecutor();

ConnectivityDiagnosticsManager cdm =
        context.getSystemService(ConnectivityDiagnosticsManager.class);

ExampleCallback callback = new ExampleCallback();
cdm.registerConnectivityDiagnosticsCallback(
        request, executor, callback);

... 
// Collect connectivity information on networks that match with request
... 

cdm.unregisterConnectivityDiagnosticsCallback(callback);

Validación

ConnectivityDiagnosticsManagerTest probó la API de Connectivity Diagnostics con CTS.