ImplicitFlowControlCallback

abstract class ImplicitFlowControlCallback : UrlRequest.Callback

Известные прямые подклассы InMemoryTransformCronetCallback
InMemoryTransformCronetCallback

Абстрактный коллбэк Cronet, который считывает всё тело запроса в память и, при необходимости, десериализует его перед передачей обратно отправителю HTTP-запроса.

Известные косвенные подклассы : ByteArrayCronetCallback , JsonCronetCallback , StringCronetCallback
ByteArrayCronetCallback

Специализация функции InMemoryTransformCronetCallback , которая возвращает байты тела запроса в неизменном виде, без какой-либо интерпретации.

JsonCronetCallback

Специализация класса InMemoryTransformCronetCallback , которая интерпретирует тело ответа как JSON.

StringCronetCallback

Специализация класса InMemoryTransformCronetCallback , которая интерпретирует тело ответа как строку.


Реализация метода UrlRequest.Callback , которая избавляет от сложностей управления жизненным циклом запроса и автоматически полностью считывает ответ.

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

Государственные строители

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

Unit
onCanceled (request: UrlRequest !, info: UrlResponseInfo !)

Вызывается, если запрос был отменен с помощью cancel .

Unit
onFailed (
request: UrlRequest !,
info: UrlResponseInfo !,
error: CronetException !
)

Вызывается, если запрос по какой-либо причине не удался после start .

Unit
onReadCompleted (
request: UrlRequest !,
info: UrlResponseInfo !,
byteBuffer: ByteBuffer !
)

Вызывается всякий раз, когда считывается часть тела ответа.

Unit
onRedirectReceived (
request: UrlRequest !,
info: UrlResponseInfo !,
newLocationUrl: String !
)

Вызывается при обнаружении перенаправления.

Unit

Вызывается при получении окончательного набора заголовков после всех перенаправлений.

Unit
onSucceeded (request: UrlRequest !, info: UrlResponseInfo !)

Вызывается при успешном завершении запроса.

Защищенные функции

abstract Unit
onBodyChunkRead (info: UrlResponseInfo !, bodyChunk: ByteBuffer !)

Вызывается всякий раз, когда считывается часть тела ответа.

abstract Unit

Вызывается, если запрос был отменен с помощью cancel .

abstract Unit
onFailed (info: UrlResponseInfo ?, exception: CronetException !)

Вызывается, если запрос по какой-либо причине не удался после start .

abstract Unit

Вызывается при получении окончательного набора заголовков после всех перенаправлений.

abstract Unit

Вызывается при успешном завершении запроса.

abstract Boolean
shouldFollowRedirect (info: UrlResponseInfo !, newLocationUrl: String !)

Вызывается при обнаружении перенаправления.

Государственные строители

ImplicitFlowControlCallback

ImplicitFlowControlCallback()

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

Отменено

fun onCanceled(request: UrlRequest!, info: UrlResponseInfo!): Unit

Вызывается, если запрос был отменен с помощью cancel . После вызова другие методы Callback вызываться не будут. Реализация по умолчанию не предпринимает никаких действий.

Параметры
request: UrlRequest !

Запрос, который был отменен.

info: UrlResponseInfo !

Информация об ответе. Может быть null если ответ не был получен.

onFailed

fun onFailed(
    request: UrlRequest!,
    info: UrlResponseInfo!,
    error: CronetException!
): Unit

Вызывается, если запрос не удался по какой-либо причине после start . После вызова другие методы Callback вызываться не будут. error предоставляет информацию о сбое.

Параметры
request: UrlRequest !

Неудачный запрос.

info: UrlResponseInfo !

Информация об ответе. Может быть null если ответ не был получен.

error: CronetException !

Информация об ошибке.

onReadCompleted

fun onReadCompleted(
    request: UrlRequest!,
    info: UrlResponseInfo!,
    byteBuffer: ByteBuffer!
): Unit

Вызывается всякий раз, когда прочитана часть тела ответа. Может быть заполнена только часть буфера, даже если всё тело ответа ещё не прочитано. За исключением onCanceled() , никакие другие методы Callback для запроса, включая onSucceeded() и onFailed() , не будут вызваны до тех пор, пока не будет вызван UrlRequest.read() для попытки продолжить чтение тела ответа.

Параметры
request: UrlRequest !

Запрос на получение данных.

info: UrlResponseInfo !

Информация об ответе.

byteBuffer: ByteBuffer !

Буфер, переданный в UrlRequest.read() , теперь содержит полученные данные. Позиция буфера обновляется до конца полученных данных. Лимит буфера не изменяется.

Броски
java.lang.Exception

Если при обработке завершения чтения возникает ошибка, будет вызван onFailed , в качестве причины вызова CallbackException будет указано выброшенное исключение.

onRedirectReceived

fun onRedirectReceived(
    request: UrlRequest!,
    info: UrlResponseInfo!,
    newLocationUrl: String!
): Unit

Вызывается всякий раз, когда встречается перенаправление. Этот метод будет вызываться только между вызовом метода start и onResponseStarted() . Тело ответа о перенаправлении, если оно есть, будет проигнорировано. Перенаправление не будет выполнено до тех пор, пока не будет вызван метод followRedirect объекта URLRequest, синхронно или асинхронно.

Параметры
request: UrlRequest !

Запрос перенаправляется.

info: UrlResponseInfo !

Информация об ответе.

newLocationUrl: String !

Место, куда перенаправляется запрос.

Броски
java.lang.Exception

Если при обработке перенаправления возникает ошибка, будет вызван onFailed , в качестве причины CallbackException будет указано выброшенное исключение.

onResponseStarted

fun onResponseStarted(request: UrlRequest!, info: UrlResponseInfo!): Unit

Вызывается после получения окончательного набора заголовков, после всех перенаправлений. Будет вызываться только один раз для каждого запроса. За исключением onCanceled() , никакие другие методы Callback , включая onSucceeded() и onFailed() , не будут вызываться для запроса до тех пор, пока не будет вызван UrlRequest.read() для попытки начать чтение тела ответа.

Параметры
request: UrlRequest !

Запрос, на который был отправлен ответ.

info: UrlResponseInfo !

Информация об ответе.

Броски
java.lang.Exception

Если при обработке ответа возникает ошибка, будет вызван onFailed , в качестве причины вызова CallbackException будет указано выброшенное исключение.

onSucceeded

fun onSucceeded(request: UrlRequest!, info: UrlResponseInfo!): Unit

Вызывается после успешного завершения запроса. После вызова другие методы Callback вызываться не будут.

Параметры
request: UrlRequest !

Запрос, который был успешно выполнен.

info: UrlResponseInfo !

Информация об ответе.

Защищенные функции

onBodyChunkRead

protected abstract fun onBodyChunkRead(info: UrlResponseInfo!, bodyChunk: ByteBuffer!): Unit

Вызывается всякий раз, когда прочитана часть тела ответа. Может быть заполнена только часть буфера, даже если всё тело ответа ещё не обработано. Буфер готов к чтению. Буферы используются повторно внутри класса, поэтому реализующий класс не должен хранить буфер или использовать его где-либо ещё, кроме как в реализации этого метода.

Параметры
info: UrlResponseInfo !

Информация об ответе.

bodyChunk: ByteBuffer !

Буфер, содержащий полученные данные, перевернут для чтения.

Броски
java.lang.Exception

Если при обработке завершения чтения возникает ошибка, будет вызван метод onFailed, в качестве причины вызова CallbackException будет указано выброшенное исключение.

Отменено

protected abstract fun onCanceled(info: UrlResponseInfo?): Unit

Вызывается, если запрос был отменен с помощью cancel . После вызова другие методы UrlRequest.Callback вызываться не будут.

Параметры
info: UrlResponseInfo ?

Информация об ответе. Может быть null если ответ не был получен.

onFailed

protected abstract fun onFailed(info: UrlResponseInfo?, exception: CronetException!): Unit

Вызывается, если запрос не удался по какой-либо причине после start . После вызова другие методы UrlRequest.Callback вызываться не будут. Метод error предоставляет информацию о сбое.

Параметры
info: UrlResponseInfo ?

Информация об ответе. Может быть null если ответ не был получен.

exception: CronetException !

Информация об ошибке.

onResponseStarted

protected abstract fun onResponseStarted(info: UrlResponseInfo!): Unit

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

Параметры
info: UrlResponseInfo !

Информация об ответе.

Броски
java.lang.Exception

Если при обработке ответа возникает ошибка, будет вызван метод onFailed, в качестве причины вызова CallbackException будет указано выброшенное исключение.

onSucceeded

protected abstract fun onSucceeded(info: UrlResponseInfo!): Unit

Вызывается после успешного завершения запроса. После вызова другие методы UrlRequest.Callback вызываться не будут.

Параметры
info: UrlResponseInfo !

Информация об ответе.

shouldFollowRedirect

protected abstract fun shouldFollowRedirect(info: UrlResponseInfo!, newLocationUrl: String!): Boolean

Вызывается всякий раз, когда встречается перенаправление. Этот метод будет вызываться только между вызовом метода start и onResponseStarted() . Тело ответа о перенаправлении, если оно есть, будет проигнорировано.

Параметры
info: UrlResponseInfo !

Информация об ответе.

newLocationUrl: String !

Место, куда перенаправляется запрос.

Возвраты
Boolean

Возвращает true, если перенаправление должно быть выполнено, false, если запрос должен быть отменен.

Броски
java.lang.Exception

Если при обработке перенаправления возникает ошибка, будет вызван метод onFailed, в качестве причины CallbackException будет указано выброшенное исключение.