ConnectionMigrationOptions.Builder


public static final class ConnectionMigrationOptions.Builder
extends Object

java.lang.Object
   ↳ android.net.http.ConnectionMigrationOptions.Builder


Builder for ConnectionMigrationOptions.

Summary

Public constructors

Builder()

Public methods

ConnectionMigrationOptions build()

Creates and returns the final ConnectionMigrationOptions instance, based on the values in this builder.

ConnectionMigrationOptions.Builder setAllowNonDefaultNetworkUsage(int state)

Sets whether connections can be migrated to an alternate network when Cronet detects a degradation of the path currently in use.

ConnectionMigrationOptions.Builder setDefaultNetworkMigration(int state)

Sets whether to enable the possibility of migrating connections on default network change.

ConnectionMigrationOptions.Builder setPathDegradationMigration(int state)

Sets whether to enable the possibility of migrating connections if the current path is performing poorly.

Inherited methods

Public constructors

Builder

Added in API level 34
Also in S Extensions 7
public Builder ()

Public methods

build

Added in API level 34
Also in S Extensions 7
public ConnectionMigrationOptions build ()

Creates and returns the final ConnectionMigrationOptions instance, based on the values in this builder.

Returns
ConnectionMigrationOptions This value cannot be null.

setAllowNonDefaultNetworkUsage

Added in API level 34
Also in S Extensions 7
public ConnectionMigrationOptions.Builder setAllowNonDefaultNetworkUsage (int state)

Sets whether connections can be migrated to an alternate network when Cronet detects a degradation of the path currently in use. Requires setting setPathDegradationMigration(int) to ConnectionMigrationOptions.MIGRATION_OPTION_ENABLED to have any effect.

Note: This setting can result in requests being sent on non-default metered networks, eating into the users' data budgets and incurring extra costs. Make sure you're using metered networks sparingly.

Parameters
state int: one of the MIGRATION_OPTION_* values Value is ConnectionMigrationOptions.MIGRATION_OPTION_UNSPECIFIED, ConnectionMigrationOptions.MIGRATION_OPTION_ENABLED, or ConnectionMigrationOptions.MIGRATION_OPTION_DISABLED

Returns
ConnectionMigrationOptions.Builder this builder for chaining This value cannot be null.

setDefaultNetworkMigration

Added in API level 34
Also in S Extensions 7
public ConnectionMigrationOptions.Builder setDefaultNetworkMigration (int state)

Sets whether to enable the possibility of migrating connections on default network change. If enabled, active QUIC connections will be migrated onto the new network when the platform indicates that the default network is changing.

Parameters
state int: one of the MIGRATION_OPTION_* values Value is ConnectionMigrationOptions.MIGRATION_OPTION_UNSPECIFIED, ConnectionMigrationOptions.MIGRATION_OPTION_ENABLED, or ConnectionMigrationOptions.MIGRATION_OPTION_DISABLED

Returns
ConnectionMigrationOptions.Builder this builder for chaining This value cannot be null.

setPathDegradationMigration

Added in API level 34
Also in S Extensions 7
public ConnectionMigrationOptions.Builder setPathDegradationMigration (int state)

Sets whether to enable the possibility of migrating connections if the current path is performing poorly.

Depending on other configuration, this can result to migrating the connections within the same default network, or to a non-default network.

Parameters
state int: one of the MIGRATION_OPTION_* values Value is ConnectionMigrationOptions.MIGRATION_OPTION_UNSPECIFIED, ConnectionMigrationOptions.MIGRATION_OPTION_ENABLED, or ConnectionMigrationOptions.MIGRATION_OPTION_DISABLED

Returns
ConnectionMigrationOptions.Builder this builder for chaining This value cannot be null.