Connectivity Diagnostics API

Connectivity Diagnostics API memungkinkan aplikasi yang memiliki atau mengelola jaringan, seperti aplikasi operator, aplikasi VPN, dan aplikasi saran Wi-Fi, untuk menerima informasi konektivitas jaringan diagnostik dari framework. Aplikasi ini dapat mendaftarkan callback dan menerima notifikasi dengan informasi konektivitas untuk jaringan yang dimiliki atau dikelolanya. Aplikasi tidak akan menerima notifikasi untuk jaringan yang tidak dimiliki atau dikelola oleh aplikasi.

Berikut adalah contoh aplikasi yang mengelola atau memiliki jaringan:

• Aplikasi operator: Mengelola jaringan seluler yang subId memiliki hak istimewa operator
• Aplikasi saran Wi-Fi: Memiliki jaringan Wi-Fi yang disarankan ke sistem
• Aplikasi VPN: Mengelola semua jaringan yang digunakan VPN, tetapi hanya saat VPN tersebut aktif

Callback dipanggil dalam kasus berikut:

• Validasi jaringan: Sistem telah selesai mengevaluasi jaringan tertentu. Class ConnectivityReport memberikan informasi tentang status jaringan saat ini dan hasil pengujian atau prosedur yang dilakukan sebagai bagian dari validasi.

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

• Diduga terjadi penundaan data: Diduga terjadi penundaan data, yaitu kondisi saat paket IP tidak mengalir dengan benar melalui jaringan. Class DataStallReport memberikan informasi tentang dugaan penundaan data.

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

• Konektivitas yang dilaporkan: Aplikasi telah melaporkan konektivitas melalui ConnectivityManager#reportNetworkConnectivity ke sistem. Jaringan dan konektivitas yang dilaporkan (apakah aplikasi meyakini bahwa jaringan menyediakan atau tidak menyediakan konektivitas) dibagikan.

Implementasi

Untuk menggunakan Connectivity Diagnostics API, aplikasi harus mendapatkan instance ConnectivityDiagnosticsManager dari platform. Instance ini harus digunakan untuk mendaftarkan dan membatalkan pendaftaran implementasi ConnectivityDiagnosticsCallback. Metode callback yang tidak diganti adalah no-op.

Berikut contoh penerapan 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
        ... 
    }
}

Untuk mendaftarkan callback dan menerima notifikasi, panggil registerConnectivityDiagnosticsCallback. Untuk membatalkan pendaftaran callback dan berhenti menerima notifikasi, panggil unregisterConnectivityDiagnosticsCallback.

Berikut adalah contoh untuk mendaftar dan membatalkan pendaftaran 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);

Validasi

Connectivity Diagnostics API diuji CTS oleh ConnectivityDiagnosticsManagerTest.