ConnectionMigrationOptions.Builder

class ConnectionMigrationOptions.Builder


Конструктор для ConnectionMigrationOptions .

Краткое содержание

Общественные функции

ConnectionMigrationOptions.Builder !

Определяет, можно ли перевести соединения в альтернативную сеть, если Cronet обнаружит ухудшение качества используемого в данный момент канала связи.

ConnectionMigrationOptions.Builder !

Предоставляет возможность переноса соединений на альтернативный адрес сервера по запросу сервера.

ConnectionMigrationOptions !
build ()

Создает и возвращает окончательный экземпляр 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 обнаружит ухудшение качества используемого в данный момент канала связи.

Примечание: Эта настройка может привести к отправке запросов в сети, отличные от сети с лимитированным трафиком по умолчанию. Убедитесь, что вы используете сети с лимитированным трафиком экономно, и точно настройте такие параметры, как setMaxPathDegradingNonDefaultNetworkMigrationsCount и setMaxTimeOnNonDefaultNetworkSeconds чтобы ограничить время работы в сетях, отличных от сети по умолчанию.

Возвраты
ConnectionMigrationOptions.Builder !

этот конструктор для создания цепочек

allowServerMigration

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

Предоставляет возможность переноса соединений на альтернативный адрес сервера по запросу сервера.

Возвраты
ConnectionMigrationOptions.Builder !

этот конструктор для создания цепочек

строить

fun build(): ConnectionMigrationOptions!

Создает и возвращает окончательный экземпляр ConnectionMigrationOptions на основе значений, указанных в этом конструкторе.

enableDefaultNetworkMigration

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

Предоставляет возможность переноса соединений при изменении сети по умолчанию. Если эта функция включена, активные соединения QUIC будут перенесены в новую сеть, когда платформа сообщит об изменении сети по умолчанию.

Возвраты
ConnectionMigrationOptions.Builder !

этот конструктор для создания цепочек

enablePathDegradationMigration

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

Предоставляет возможность миграции соединений, если текущий путь работает неэффективно.

В зависимости от других параметров конфигурации это может привести к переносу соединений в рамках одной и той же сети по умолчанию или в сеть, отличную от сети по умолчанию.

Возвраты
ConnectionMigrationOptions.Builder !

этот конструктор для создания цепочек

См. также
allowNonDefaultNetworkUsage

migrateIdleConnections

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

Определяет, следует ли включать или отключать миграцию неактивных соединений.

Если установлено значение true, то неактивные соединения также будут перенесены, если они не простаивали слишком долго. Этот параметр является общим для всех типов переноса соединений. Максимальный период простоя, в течение которого соединения будут переноситься, можно настроить с помощью setIdleConnectionMigrationPeriodSeconds .

Возвраты
ConnectionMigrationOptions.Builder !

этот конструктор для создания цепочек

retryPreHandshakeErrorsOnNonDefaultNetwork

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

Определяет, следует ли повторять попытки подключения к сети с ошибками на этапе предварительного установления соединения.

Если это так, то новое соединение может быть установлено в альтернативной сети, если оно не удается установить в основной сети до подтверждения рукопожатия.

Примечание: как и параметр 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 !

этот конструктор для создания цепочек