ConnectionMigrationOptions.Builder

public static class ConnectionMigrationOptions.Builder extends Object

ConnectionMigrationOptions 的构建器。

公共方法摘要

ConnectionMigrationOptions.Builder
allowNonDefaultNetworkUsage(boolean enable)
设置当 Cronet 检测到当前正在使用的路径性能下降时,是否可以将连接迁移到备用网络。
ConnectionMigrationOptions.Builder
allowServerMigration(boolean allowServerMigration)
启用根据服务器请求将连接迁移到备用服务器地址的可能性。
ConnectionMigrationOptions
build()
根据此构建器中的值,创建并返回最终的 ConnectionMigrationOptions 实例。
ConnectionMigrationOptions.Builder
enableDefaultNetworkMigration(boolean enableDefaultNetworkConnectionMigration)
启用在默认网络更改时迁移连接的可能性。
ConnectionMigrationOptions.Builder
enablePathDegradationMigration(boolean enable)
启用在当前路径性能不佳时迁移连接的可能性。
ConnectionMigrationOptions.Builder
migrateIdleConnections(boolean migrateIdleConnections)
配置是否应启用空闲连接的迁移。
ConnectionMigrationOptions.Builder
retryPreHandshakeErrorsOnNonDefaultNetwork(boolean retryPreHandshakeErrorsOnAlternateNetwork)
设置是否应在备用网络上重试发生握手前错误的连接。
ConnectionMigrationOptions.Builder
setIdleConnectionMigrationPeriodSeconds(long idleConnectionMigrationPeriodSeconds)
设置连接仍将迁移的最长空闲时间(以秒为单位)。
ConnectionMigrationOptions.Builder
setMaxPathDegradingNonDefaultNetworkMigrationsCount(int maxPathDegradingEagerMigrationsCount)
设置现有连接遇到路径性能下降时迁移到非默认网络的最多次数。
ConnectionMigrationOptions.Builder
setMaxTimeOnNonDefaultNetworkSeconds(long maxTimeOnNonDefaultNetworkSeconds)
设置急切迁移的连接在迁移回默认网络之前应保持在非默认网络上的最长时间。
ConnectionMigrationOptions.Builder
setMaxWriteErrorNonDefaultNetworkMigrationsCount(int maxWriteErrorEagerMigrationsCount)
设置遇到写入错误时迁移到非默认网络的最多次数。

继承方法摘要

公共方法

public ConnectionMigrationOptions.Builder allowNonDefaultNetworkUsage (boolean enable)

设置当 Cronet 检测到当前正在使用的路径性能下降时,是否可以将连接迁移到备用网络。

注意:此设置可能导致请求通过非默认的按流量计费网络发送。请确保您谨慎使用按流量计费网络,并微调 setMaxPathDegradingNonDefaultNetworkMigrationsCount(int)setMaxTimeOnNonDefaultNetworkSeconds(long) 等参数,以限制在非默认网络上的时间。

参数
enable
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder allowServerMigration (boolean allowServerMigration)

启用根据服务器请求将连接迁移到备用服务器地址的可能性。

参数
allowServerMigration
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions build ()

根据此构建器中的值,创建并返回最终的 ConnectionMigrationOptions 实例。

public ConnectionMigrationOptions.Builder enableDefaultNetworkMigration (boolean enableDefaultNetworkConnectionMigration)

启用在默认网络更改时迁移连接的可能性。如果启用,当平台指示默认网络正在更改时,活动的 QUIC 连接将迁移到新网络上。

参数
enableDefaultNetworkConnectionMigration
返回
  • 此构建器,用于链式调用
另请参阅

public ConnectionMigrationOptions.Builder enablePathDegradationMigration (boolean enable)

启用在当前路径性能不佳时迁移连接的可能性。

根据其他配置,这可能导致连接在同一默认网络内迁移,或迁移到非默认网络。

参数
enable
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder migrateIdleConnections (boolean migrateIdleConnections)

配置是否应启用空闲连接的迁移。

如果设置为 true,空闲连接也会迁移,只要它们空闲时间不是太长。此设置适用于所有连接迁移类型。可以使用 setIdleConnectionMigrationPeriodSeconds(long) 自定义连接仍将迁移的最长空闲时间。

参数
migrateIdleConnections
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder retryPreHandshakeErrorsOnNonDefaultNetwork (boolean retryPreHandshakeErrorsOnAlternateNetwork)

设置是否应在备用网络上重试发生握手前错误的连接。

如果为 true,则如果在默认网络上建立新连接并在握手确认前失败,可能会在备用网络上尝试建立连接。

注意:与 allowNonDefaultNetworkUsage(boolean) 类似,此设置可能导致请求通过非默认的按流量计费网络发送。请谨慎使用!

参数
retryPreHandshakeErrorsOnAlternateNetwork
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder setIdleConnectionMigrationPeriodSeconds (long idleConnectionMigrationPeriodSeconds)

设置连接仍将迁移的最长空闲时间(以秒为单位)。此设置适用于所有连接迁移类型。

仅当 migrateIdleConnections(boolean) 启用时才相关。

参数
idleConnectionMigrationPeriodSeconds
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder setMaxPathDegradingNonDefaultNetworkMigrationsCount (int maxPathDegradingEagerMigrationsCount)

设置现有连接遇到路径性能下降时迁移到非默认网络的最多次数。按每个网络、每个连接累积计数。

仅当 allowNonDefaultNetworkUsage(boolean) 启用时才相关。

参数
maxPathDegradingEagerMigrationsCount
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder setMaxTimeOnNonDefaultNetworkSeconds (long maxTimeOnNonDefaultNetworkSeconds)

设置急切迁移的连接在迁移回默认网络之前应保持在非默认网络上的最长时间。此时间不累积 - 每个连接离开默认网络的每次迁移都会单独测量并与此值进行比较。

仅当 allowNonDefaultNetworkUsage(boolean) 启用时才相关。

参数
maxTimeOnNonDefaultNetworkSeconds
返回
  • 此构建器,用于链式调用

public ConnectionMigrationOptions.Builder setMaxWriteErrorNonDefaultNetworkMigrationsCount (int maxWriteErrorEagerMigrationsCount)

设置遇到写入错误时迁移到非默认网络的最多次数。按每个网络、每个连接累积计数。

仅当 allowNonDefaultNetworkUsage(boolean) 启用时才相关。

参数
maxWriteErrorEagerMigrationsCount
返回
  • 此构建器,用于链式调用