ConnectionMigrationOptions.Builder

Kotlin |Java

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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`.

See also:

Android Network State

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`.