ピアツーピア接続のための Wi-Fi ネットワーク リクエスト API

Android 10（API レベル 29）以降を搭載しているデバイスでは、新しいピアツーピア API を使用して、Chromecast や Google Home ハードウェアなどのセカンダリ デバイスの構成をブートストラップできます。この機能により、アプリはリクエストされたネットワークのプロパティを WifiNetworkSpecifier を使用して記述することで、デバイスが接続されているアクセス ポイントの変更を求めるプロンプトをユーザーに表示できます。

この API を使用する手順は次のとおりです。

  1. WifiNetworkSpecifier.Builder を使用して、Wi-Fi ネットワーク指定子を作成します。

  2. 必要な認証情報とともに、接続するネットワークに一致するネットワーク フィルタを設定します。

  3. 次の要件に従って、各リクエストでネットワーク フィルタを設定する SSID、SSID pattern、BSSID、BSSID pattern の組み合わせを決定します。

    • 各リクエストは、SSID、SSID pattern、BSSID、BSSID pattern の少なくとも 1 つを提供する必要がある
    • 各リクエストで設定できるのは、SSID または SSID pattern のどちらか一方のみである
    • 各リクエストで設定できるのは、BSSID または BSSID pattern のどちらか一方のみである

  4. リクエストのステータスを追跡するために、ネットワーク リクエストに NetworkCallback インスタンスとともに指定子を追加します。

    ユーザーがリクエストを受け入れて、ネットワークへの接続が成功すると、コールバック オブジェクトで NetworkCallback.onAvailable() が呼び出されます。ユーザーがリクエストを拒否した場合、またはネットワークへの接続が失敗した場合は、コールバック オブジェクトで NetworkCallback.onUnavailable() が呼び出されます。

ピアデバイスへの接続リクエストを開始すると、そのデバイスでダイアログ ボックスが表示されます。デバイスのユーザーは、そのダイアログ ボックスで接続リクエストを受け入れることができます。

ユーザー承認の回避

ユーザーが特定のアプリからのリクエストに応答して接続するネットワークを承認すると、デバイスは特定のアクセス ポイントに対する承認を保存します。アプリがそのアクセス ポイントへの接続を再度リクエストした場合、デバイスはユーザー承認フェーズを省略して自動的にネットワークに接続します。API によってリクエストされたネットワークに接続した状態で、ユーザーがネットワークの切断を選択した場合、このアプリとネットワークの組み合わせに対して保存された承認は削除され、アプリからの以降のリクエストではユーザーによる承認が再度必要になります。アプリから SSID や BSSID pattern などが指定されていないリクエストが行われた場合、ユーザーはリクエストを承認する必要があります。

コードサンプル

次のコードサンプルは、SSID プレフィックスが "test" で、BSSID OUI が "10:03:23" のオープン ネットワークに接続する方法を示しています。

Kotlin

val specifier = WifiNetworkSpecifier.Builder()
    .setSsidPattern(PatternMatcher("test", PatternMatcher.PATTERN_PREFIX))
    .setBssidPattern(MacAddress.fromString("10:03:23:00:00:00"), MacAddress.fromString("ff:ff:ff:00:00:00"))
    .build()

val request = NetworkRequest.Builder()
    .addTransportType(NetworkCapabilities.TRANSPORT_WIFI)
    .removeCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
    .setNetworkSpecifier(specifier)
    .build()

val connectivityManager = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager

val networkCallback = object : ConnectivityManager.NetworkCallback() {
    ...
    override fun onAvailable(network: Network?) {
        // do success processing here..
    }

    override fun onUnavailable() {
        // do failure processing here..
    }
    ...
}
connectivityManager.requestNetwork(request, networkCallback)
...
// Release the request when done.
connectivityManager.unregisterNetworkCallback(networkCallback)

Java

final NetworkSpecifier specifier =
  new WifiNetworkSpecifier.Builder()
  .setSsidPattern(new PatternMatcher("test", PatternMatcher.PATTERN_PREFIX))
  .setBssidPattern(MacAddress.fromString("10:03:23:00:00:00"), MacAddress.fromString("ff:ff:ff:00:00:00"))
  .build();

final NetworkRequest request =
  new NetworkRequest.Builder()
  .addTransportType(NetworkCapabilities.TRANSPORT_WIFI)
  .removeCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
  .setNetworkSpecifier(specifier)
  .build();

final ConnectivityManager connectivityManager = (ConnectivityManager)
  context.getSystemService(Context.CONNECTIVITY_SERVICE);

final NetworkCallback networkCallback = new NetworkCallback() {
  ...
  @Override
  void onAvailable(...) {
      // do success processing here..
  }

  @Override
  void onUnavailable(...) {
      // do failure processing here..
  }
  ...
};
connectivityManager.requestNetwork(request, networkCallback);
...
// Release the request when done.
connectivityManager.unregisterNetworkCallback(networkCallback);