ConnectionMigrationOptions.Builder

class ConnectionMigrationOptions.Builder


ConnectionMigrationOptions のビルダー。

概要

パブリック関数

ConnectionMigrationOptions.Builder!

現在使用中のパスの劣化が Cronet によって検出された場合に、接続を代替ネットワークに移行できるかどうかを設定します。

ConnectionMigrationOptions.Builder!

サーバーのリクエストに応じて、接続を代替サーバー アドレスに移行できるようにします。

ConnectionMigrationOptions!

このビルダーの値に基づいて、最終的な ConnectionMigrationOptions インスタンスを作成して返します。

ConnectionMigrationOptions.Builder!
enableDefaultNetworkMigration(
    enableDefaultNetworkConnectionMigration: Boolean
)

デフォルト ネットワークの変更時に接続を移行できるようにします。

ConnectionMigrationOptions.Builder!

現在のパスのパフォーマンスが低い場合に、接続を移行できるようにします。

ConnectionMigrationOptions.Builder!

アイドル状態の接続の移行を有効にするかどうかを設定します。

ConnectionMigrationOptions.Builder!

ハンドシェイク前のエラーが発生した接続を代替ネットワークで再試行するかどうかを設定します。

ConnectionMigrationOptions.Builder!

接続が移行されるアイドル状態の最大期間を秒単位で設定します。

ConnectionMigrationOptions.Builder!

既存の接続でパスの劣化が発生した場合に、デフォルト以外のネットワークへの移行の最大数を設定します。

ConnectionMigrationOptions.Builder!

積極的に移行された接続がデフォルト以外のネットワークに留まる最大期間を設定します。この期間が過ぎると、接続は移行元に戻されます。

ConnectionMigrationOptions.Builder!

書き込みエラーが発生した場合に、デフォルト以外のネットワークへの移行の最大数を設定します。

パブリック関数

allowNonDefaultNetworkUsage

@ConnectionMigrationOptions.Experimental
fun allowNonDefaultNetworkUsage(enable: Boolean): ConnectionMigrationOptions.Builder!

現在使用中のパスの劣化が Cronet によって検出された場合に、接続を代替ネットワークに移行できるかどうかを設定します。

注: この設定により、デフォルト以外の従量制ネットワークでリクエストが送信されることがあります。従量制ネットワークの使用は控え、setMaxPathDegradingNonDefaultNetworkMigrationsCountsetMaxTimeOnNonDefaultNetworkSeconds などのパラメータを調整して、デフォルト以外のネットワークでの時間を制限してください。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

allowServerMigration

@ConnectionMigrationOptions.Experimental
fun allowServerMigration(allowServerMigration: Boolean): ConnectionMigrationOptions.Builder!

サーバーのリクエストに応じて、接続を代替サーバー アドレスに移行できるようにします。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

build

fun build(): ConnectionMigrationOptions!

このビルダーの値に基づいて、最終的な ConnectionMigrationOptions インスタンスを作成して返します。

enableDefaultNetworkMigration

fun enableDefaultNetworkMigration(
    enableDefaultNetworkConnectionMigration: Boolean
): ConnectionMigrationOptions.Builder!

デフォルト ネットワークの変更時に接続を移行できるようにします。有効にすると、プラットフォームがデフォルト ネットワークの変更を示したときに、アクティブな QUIC 接続が新しいネットワークに移行されます。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

enablePathDegradationMigration

fun enablePathDegradationMigration(enable: Boolean): ConnectionMigrationOptions.Builder!

現在のパスのパフォーマンスが低い場合に、接続を移行できるようにします。

他の構成によっては、同じデフォルト ネットワーク内の接続を移行したり、デフォルト以外のネットワークに移行したりすることがあります。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

migrateIdleConnections

@ConnectionMigrationOptions.Experimental
fun migrateIdleConnections(migrateIdleConnections: Boolean): ConnectionMigrationOptions.Builder!

アイドル状態の接続の移行を有効にするかどうかを設定します。

true に設定すると、アイドル状態の接続も移行されます。ただし、アイドル状態が長すぎる場合は移行されません。この設定は、すべての接続移行タイプで共有されます。接続が移行されるアイドル状態の最大期間は、setIdleConnectionMigrationPeriodSeconds を使用してカスタマイズできます。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

retryPreHandshakeErrorsOnNonDefaultNetwork

@ConnectionMigrationOptions.Experimental
fun retryPreHandshakeErrorsOnNonDefaultNetwork(
    retryPreHandshakeErrorsOnAlternateNetwork: Boolean
): ConnectionMigrationOptions.Builder!

ハンドシェイク前のエラーが発生した接続を代替ネットワークで再試行するかどうかを設定します。

true の場合、ハンドシェイクが確認される前にデフォルト ネットワークで失敗した場合は、代替ネットワークで新しい接続が確立されることがあります。

注: allowNonDefaultNetworkUsage と同様に、この設定により、デフォルト以外の従量制ネットワークでリクエストが送信されることがあります。使用する際はご注意ください

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

setIdleConnectionMigrationPeriodSeconds

@ConnectionMigrationOptions.Experimental
fun setIdleConnectionMigrationPeriodSeconds(
    idleConnectionMigrationPeriodSeconds: Long
): ConnectionMigrationOptions.Builder!

接続が移行されるアイドル状態の最大期間を秒単位で設定します。この設定は、すべての接続移行タイプで共有されます。

migrateIdleConnections が有効になっている場合にのみ関連します。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

setMaxPathDegradingNonDefaultNetworkMigrationsCount

@ConnectionMigrationOptions.Experimental
fun setMaxPathDegradingNonDefaultNetworkMigrationsCount(
    maxPathDegradingEagerMigrationsCount: Int
): ConnectionMigrationOptions.Builder!

既存の接続でパスの劣化が発生した場合に、デフォルト以外のネットワークへの移行の最大数を設定します。ネットワークごと、接続ごとに累積的にカウントされます。

allowNonDefaultNetworkUsage が有効になっている場合にのみ関連します。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

setMaxTimeOnNonDefaultNetworkSeconds

@ConnectionMigrationOptions.Experimental
fun setMaxTimeOnNonDefaultNetworkSeconds(
    maxTimeOnNonDefaultNetworkSeconds: Long
): ConnectionMigrationOptions.Builder!

積極的に移行された接続がデフォルト以外のネットワークに留まる最大期間を設定します。この期間が過ぎると、接続は移行元に戻されます。この時間は累積されません。接続ごとにデフォルト ネットワークから移行するたびに、この値が個別に測定され、比較されます。

allowNonDefaultNetworkUsage が有効になっている場合にのみ関連します。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー

setMaxWriteErrorNonDefaultNetworkMigrationsCount

@ConnectionMigrationOptions.Experimental
fun setMaxWriteErrorNonDefaultNetworkMigrationsCount(
    maxWriteErrorEagerMigrationsCount: Int
): ConnectionMigrationOptions.Builder!

書き込みエラーが発生した場合に、デフォルト以外のネットワークへの移行の最大数を設定します。ネットワークごと、接続ごとに累積的にカウントされます。

allowNonDefaultNetworkUsage が有効になっている場合にのみ関連します。

戻り値
ConnectionMigrationOptions.Builder!

チェーン用のこのビルダー