Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Expose entry/exit bandwidth criteria APIs for VCN templates

Browse Source 
This change adds additional criteria for bandwidth in both the
upstream and downstream directions, ensuring that a minimum quality
bar can be guaranteed for VCN underlying networks. Both directions
support separate entry/exit criterion to allow for hysteresis.

Bug: 205343355
Test: atest FrameworksVcnTests
CTS-Coverage-Bug: 209498272
Change-Id: I61c8469380551e673d91f9a4428d21a40f164841
This commit is contained in:
Benedict Wong
2021-12-16 07:06:10 +00:00
parent ee22e0d57d
commit 073e1ac89b
4 changed files with 72 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/api/current.txt
View File

@@ -27288,6 +27288,8 @@ package android.net.vcn {
ctor public VcnCellUnderlyingNetworkTemplate.Builder();
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate build();
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate.Builder setMetered(int);
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate.Builder setMinDownstreamBandwidthKbps(int, int);
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate.Builder setMinUpstreamBandwidthKbps(int, int);
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate.Builder setOperatorPlmnIds(@NonNull java.util.Set<java.lang.String>);
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate.Builder setOpportunistic(int);
method @NonNull public android.net.vcn.VcnCellUnderlyingNetworkTemplate.Builder setRoaming(int);
@@ -27348,6 +27350,10 @@ package android.net.vcn {
public abstract class VcnUnderlyingNetworkTemplate {
method public int getMetered();
method public int getMinEntryDownstreamBandwidthKbps();
method public int getMinEntryUpstreamBandwidthKbps();
method public int getMinExitDownstreamBandwidthKbps();
method public int getMinExitUpstreamBandwidthKbps();
field public static final int MATCH_ANY = 0; // 0x0
field public static final int MATCH_FORBIDDEN = 2; // 0x2
field public static final int MATCH_REQUIRED = 1; // 0x1
@@ -27361,6 +27367,8 @@ package android.net.vcn {
ctor public VcnWifiUnderlyingNetworkTemplate.Builder();
method @NonNull public android.net.vcn.VcnWifiUnderlyingNetworkTemplate build();
method @NonNull public android.net.vcn.VcnWifiUnderlyingNetworkTemplate.Builder setMetered(int);
method @NonNull public android.net.vcn.VcnWifiUnderlyingNetworkTemplate.Builder setMinDownstreamBandwidthKbps(int, int);
method @NonNull public android.net.vcn.VcnWifiUnderlyingNetworkTemplate.Builder setMinUpstreamBandwidthKbps(int, int);
method @NonNull public android.net.vcn.VcnWifiUnderlyingNetworkTemplate.Builder setSsids(@NonNull java.util.Set<java.lang.String>);
}

78
core/java/android/net/vcn/VcnCellUnderlyingNetworkTemplate.java
View File

@@ -375,40 +375,33 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork
}
/**
* Set the minimum accepted entry and exit upstream bandwidth allowed by this template.
* Set the minimum upstream bandwidths that this template will match.
*
* <p>The minimum upstream bandwidth condition allows for separate entry and exit
* thresholds, allowing for a margin of confidence before matching a network, while
* requiring a minimum bandwidth to continue being matching. In order to match this
* template, a network must fulfill one of the following two cases, depending on whether the
* network being evaluated is the Gateway Connection's underlying network:
* <p>This template will not match a network that does not provide at least the bandwidth
* passed as the entry bandwidth, except in the case that the network is selected as the VCN
* Gateway Connection's underlying network, where it will continue to match until the
* bandwidth drops under the exit bandwidth.
*
* <ul>
* <li>Network IS selected, AND the Network's estimated upstream bandwidth is greater than
* or equal to the minExitUpstreamBandwidthKbps provided.
* <li>Network IS NOT selected, AND the Network's estimated upstream bandwidth is greater
* than or equal to the minEntryUpstreamBandwidthKbps provided.
* </ul>
*
* <p>To prevent a network from being selected (fulfilling the entry criteria), and yet be
* unable to meet the conditions for staying selected (exit criteria), the entry criteria
* MUST be greater than, or equal to the exit criteria.
* <p>The entry criteria MUST be greater than, or equal to the exit criteria to avoid the
* invalid case where a network fulfills the entry criteria, but at the same time fails the
* exit criteria.
*
* <p>Estimated bandwidth of a network is provided by the transport layer, and reported in
* {@link NetworkCapabilities}. The provided estimates will be used without modification.
*
* @param minEntryUpstreamBandwidthKbps the minimum accepted upstream bandwidth for a
* network that IS NOT an already-selected underlying network, or {@code 0} to disable
* this requirement. MUST be greater than, or equal to minExitUpstreamBandwidthKbps.
* Defaults to {@code 0}
* @param minEntryUpstreamBandwidthKbps the minimum accepted upstream bandwidth for networks
* that ARE NOT the already-selected underlying network, or {@code 0} to disable this
* requirement. Disabled by default.
* @param minExitUpstreamBandwidthKbps the minimum accepted upstream bandwidth for a network
* that IS the already-selected underlying network, or {@code 0} to disable this
* requirement. MUST be less than, or equal to minEntryUpstreamBandwidthKbps. Defaults
* to {@code 0}
* requirement. Disabled by default.
* @return this {@link Builder} instance, for chaining
* @hide
*/
@NonNull
// The getter for the two integers are separated, and in the superclass. Please see {@link
// VcnUnderlyingNetworkTemplate#getMinEntryUpstreamBandwidthKbps()} and {@link
// VcnUnderlyingNetworkTemplate#getMinExitUpstreamBandwidthKbps()}
@SuppressLint("MissingGetterMatchingBuilder")
public Builder setMinUpstreamBandwidthKbps(
int minEntryUpstreamBandwidthKbps, int minExitUpstreamBandwidthKbps) {
validateMinBandwidthKbps(minEntryUpstreamBandwidthKbps, minExitUpstreamBandwidthKbps);
@@ -420,40 +413,33 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork
}
/**
* Set the minimum acceptable downstream bandwidths allowed by this template.
* Set the minimum upstream bandwidths that this template will match.
*
* <p>The minimum downstream bandwidth condition allows for separate entry and exit
* thresholds, allowing for a margin of confidence before matching a network, while
* requiring a minimum bandwidth to continue being matching. In order to match this
* template, a network must fulfill one of the following two cases, depending on whether the
* network being evaluated is the Gateway Connection's underlying network:
* <p>This template will not match a network that does not provide at least the bandwidth
* passed as the entry bandwidth, except in the case that the network is selected as the VCN
* Gateway Connection's underlying network, where it will continue to match until the
* bandwidth drops under the exit bandwidth.
*
* <ul>
* <li>Network IS selected, AND the Network's estimated downstream bandwidth is greater
* than or equal to the minExitDownstreamBandwidthKbps provided.
* <li>Network IS NOT selected, AND the Network's estimated downstream bandwidth is
* greater than or equal to the minEntryDownstreamBandwidthKbps provided.
* </ul>
*
* <p>To prevent a network from being selected (fulfilling the entry criteria), and yet be
* unable to meet the conditions for staying selected (exit criteria), the entry criteria
* MUST be greater than, or equal to the exit criteria.
* <p>The entry criteria MUST be greater than, or equal to the exit criteria to avoid the
* invalid case where a network fulfills the entry criteria, but at the same time fails the
* exit criteria.
*
* <p>Estimated bandwidth of a network is provided by the transport layer, and reported in
* {@link NetworkCapabilities}. The provided estimates will be used without modification.
*
* @param minEntryDownstreamBandwidthKbps the minimum accepted downstream bandwidth for a
* network that IS NOT an already-selected underlying network, or {@code 0} to disable
* this requirement. MUST be greater than, or equal to minExitDownstreamBandwidthKbps.
* Defaults to {@code 0}
* @param minEntryDownstreamBandwidthKbps the minimum accepted downstream bandwidth for
* networks that ARE NOT the already-selected underlying network, or {@code 0} to
* disable this requirement. Disabled by default.
* @param minExitDownstreamBandwidthKbps the minimum accepted downstream bandwidth for a
* network that IS the already-selected underlying network, or {@code 0} to disable this
* requirement. MUST be less than, or equal to minEntryDownstreamBandwidthKbps. Defaults
* to {@code 0}
* requirement. Disabled by default.
* @return this {@link Builder} instance, for chaining
* @hide
*/
@NonNull
// The getter for the two integers are separated, and in the superclass. Please see {@link
// VcnUnderlyingNetworkTemplate#getMinEntryDownstreamBandwidthKbps()} and {@link
// VcnUnderlyingNetworkTemplate#getMinExitDownstreamBandwidthKbps()}
@SuppressLint("MissingGetterMatchingBuilder")
public Builder setMinDownstreamBandwidthKbps(
int minEntryDownstreamBandwidthKbps, int minExitDownstreamBandwidthKbps) {
validateMinBandwidthKbps(

4
core/java/android/net/vcn/VcnUnderlyingNetworkTemplate.java
View File

@@ -262,7 +262,6 @@ public abstract class VcnUnderlyingNetworkTemplate {
*
* @see VcnWifiUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int, int)
* @see VcnCellUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int, int)
* @hide
*/
public int getMinEntryUpstreamBandwidthKbps() {
return mMinEntryUpstreamBandwidthKbps;
@@ -273,7 +272,6 @@ public abstract class VcnUnderlyingNetworkTemplate {
*
* @see VcnWifiUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int, int)
* @see VcnCellUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int, int)
* @hide
*/
public int getMinExitUpstreamBandwidthKbps() {
return mMinExitUpstreamBandwidthKbps;
@@ -284,7 +282,6 @@ public abstract class VcnUnderlyingNetworkTemplate {
*
* @see VcnWifiUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int, int)
* @see VcnCellUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int, int)
* @hide
*/
public int getMinEntryDownstreamBandwidthKbps() {
return mMinEntryDownstreamBandwidthKbps;
@@ -295,7 +292,6 @@ public abstract class VcnUnderlyingNetworkTemplate {
*
* @see VcnWifiUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int, int)
* @see VcnCellUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int, int)
* @hide
*/
public int getMinExitDownstreamBandwidthKbps() {
return mMinExitDownstreamBandwidthKbps;

78
core/java/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.java
View File

@@ -211,40 +211,33 @@ public final class VcnWifiUnderlyingNetworkTemplate extends VcnUnderlyingNetwork
}
/**
* Set the minimum accepted entry and exit upstream bandwidth allowed by this template.
* Set the minimum upstream bandwidths that this template will match.
*
* <p>The minimum upstream bandwidth condition allows for separate entry and exit
* thresholds, allowing for a margin of confidence before matching a network, while
* requiring a minimum bandwidth to continue being matching. In order to match this
* template, a network must fulfill one of the following two cases, depending on whether the
* network being evaluated is the Gateway Connection's underlying network:
* <p>This template will not match a network that does not provide at least the bandwidth
* passed as the entry bandwidth, except in the case that the network is selected as the VCN
* Gateway Connection's underlying network, where it will continue to match until the
* bandwidth drops under the exit bandwidth.
*
* <ul>
* <li>Network IS selected, AND the Network's estimated upstream bandwidth is greater than
* or equal to the minExitUpstreamBandwidthKbps provided.
* <li>Network IS NOT selected, AND the Network's estimated upstream bandwidth is greater
* than or equal to the minEntryUpstreamBandwidthKbps provided.
* </ul>
*
* <p>To prevent a network from being selected (fulfilling the entry criteria), and yet be
* unable to meet the conditions for staying selected (exit criteria), the entry criteria
* MUST be greater than, or equal to the exit criteria.
* <p>The entry criteria MUST be greater than, or equal to the exit criteria to avoid the
* invalid case where a network fulfills the entry criteria, but at the same time fails the
* exit criteria.
*
* <p>Estimated bandwidth of a network is provided by the transport layer, and reported in
* {@link NetworkCapabilities}. The provided estimates will be used without modification.
*
* @param minEntryUpstreamBandwidthKbps the minimum accepted upstream bandwidth for a
* network that IS NOT an already-selected underlying network, or {@code 0} to disable
* this requirement. MUST be greater than, or equal to minExitUpstreamBandwidthKbps.
* Defaults to {@code 0}
* @param minEntryUpstreamBandwidthKbps the minimum accepted upstream bandwidth for networks
* that ARE NOT the already-selected underlying network, or {@code 0} to disable this
* requirement. Disabled by default.
* @param minExitUpstreamBandwidthKbps the minimum accepted upstream bandwidth for a network
* that IS the already-selected underlying network, or {@code 0} to disable this
* requirement. MUST be less than, or equal to minEntryUpstreamBandwidthKbps. Defaults
* to {@code 0}
* requirement. Disabled by default.
* @return this {@link Builder} instance, for chaining
* @hide
*/
@NonNull
// The getter for the two integers are separated, and in the superclass. Please see {@link
// VcnUnderlyingNetworkTemplate#getMinEntryUpstreamBandwidthKbps()} and {@link
// VcnUnderlyingNetworkTemplate#getMinExitUpstreamBandwidthKbps()}
@SuppressLint("MissingGetterMatchingBuilder")
public Builder setMinUpstreamBandwidthKbps(
int minEntryUpstreamBandwidthKbps, int minExitUpstreamBandwidthKbps) {
validateMinBandwidthKbps(minEntryUpstreamBandwidthKbps, minExitUpstreamBandwidthKbps);
@@ -256,40 +249,33 @@ public final class VcnWifiUnderlyingNetworkTemplate extends VcnUnderlyingNetwork
}
/**
* Set the minimum acceptable downstream bandwidths allowed by this template.
* Set the minimum upstream bandwidths that this template will match.
*
* <p>The minimum downstream bandwidth condition allows for separate entry and exit
* thresholds, allowing for a margin of confidence before matching a network, while
* requiring a minimum bandwidth to continue being matching. In order to match this
* template, a network must fulfill one of the following two cases, depending on whether the
* network being evaluated is the Gateway Connection's underlying network:
* <p>This template will not match a network that does not provide at least the bandwidth
* passed as the entry bandwidth, except in the case that the network is selected as the VCN
* Gateway Connection's underlying network, where it will continue to match until the
* bandwidth drops under the exit bandwidth.
*
* <ul>
* <li>Network IS selected, AND the Network's estimated downstream bandwidth is greater
* than or equal to the minExitDownstreamBandwidthKbps provided.
* <li>Network IS NOT selected, AND the Network's estimated downstream bandwidth is
* greater than or equal to the minEntryDownstreamBandwidthKbps provided.
* </ul>
*
* <p>To prevent a network from being selected (fulfilling the entry criteria), and yet be
* unable to meet the conditions for staying selected (exit criteria), the entry criteria
* MUST be greater than, or equal to the exit criteria.
* <p>The entry criteria MUST be greater than, or equal to the exit criteria to avoid the
* invalid case where a network fulfills the entry criteria, but at the same time fails the
* exit criteria.
*
* <p>Estimated bandwidth of a network is provided by the transport layer, and reported in
* {@link NetworkCapabilities}. The provided estimates will be used without modification.
*
* @param minEntryDownstreamBandwidthKbps the minimum accepted downstream bandwidth for a
* network that IS NOT an already-selected underlying network, or {@code 0} to disable
* this requirement. MUST be greater than, or equal to minExitDownstreamBandwidthKbps.
* Defaults to {@code 0}
* @param minEntryDownstreamBandwidthKbps the minimum accepted downstream bandwidth for
* networks that ARE NOT the already-selected underlying network, or {@code 0} to
* disable this requirement. Disabled by default.
* @param minExitDownstreamBandwidthKbps the minimum accepted downstream bandwidth for a
* network that IS the already-selected underlying network, or {@code 0} to disable this
* requirement. MUST be less than, or equal to minEntryDownstreamBandwidthKbps. Defaults
* to {@code 0}
* requirement. Disabled by default.
* @return this {@link Builder} instance, for chaining
* @hide
*/
@NonNull
// The getter for the two integers are separated, and in the superclass. Please see {@link
// VcnUnderlyingNetworkTemplate#getMinEntryDownstreamBandwidthKbps()} and {@link
// VcnUnderlyingNetworkTemplate#getMinExitDownstreamBandwidthKbps()}
@SuppressLint("MissingGetterMatchingBuilder")
public Builder setMinDownstreamBandwidthKbps(
int minEntryDownstreamBandwidthKbps, int minExitDownstreamBandwidthKbps) {
validateMinBandwidthKbps(